| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.6"/> |
| <title>Impala: impala::AuthProvider Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| $(window).load(resizeHeight); |
| </script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Impala |
| </div> |
| <div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $(document).ready(function(){initNavTree('classimpala_1_1AuthProvider.html','');}); |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classimpala_1_1AuthProvider-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">impala::AuthProvider Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="auth-provider_8h_source.html">auth-provider.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for impala::AuthProvider:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1AuthProvider__inherit__graph.svg" width="435" height="582"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for impala::AuthProvider:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1AuthProvider__coll__graph.svg" width="208" height="134"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a14d58f1bb630007340c83744f8aae349"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthProvider.html#a14d58f1bb630007340c83744f8aae349">Start</a> ()=0</td></tr> |
| <tr class="memdesc:a14d58f1bb630007340c83744f8aae349"><td class="mdescLeft"> </td><td class="mdescRight">Initialises any state required to perform authentication using this provider. <a href="#a14d58f1bb630007340c83744f8aae349">More...</a><br/></td></tr> |
| <tr class="separator:a14d58f1bb630007340c83744f8aae349"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af211c2026d1a912dff56ec83b5fd1351"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthProvider.html#af211c2026d1a912dff56ec83b5fd1351">GetServerTransportFactory</a> (boost::shared_ptr< apache::thrift::transport::TTransportFactory > *factory)=0</td></tr> |
| <tr class="separator:af211c2026d1a912dff56ec83b5fd1351"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7f412529caeebecf47def63d4ef08e06"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classimpala_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthProvider.html#a7f412529caeebecf47def63d4ef08e06">WrapClientTransport</a> (const std::string &hostname, boost::shared_ptr< apache::thrift::transport::TTransport > raw_transport, const std::string &service_name, boost::shared_ptr< apache::thrift::transport::TTransport > *wrapped_transport)=0</td></tr> |
| <tr class="separator:a7f412529caeebecf47def63d4ef08e06"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7a65cbc1f29c15b26af08435e26c1948"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classbool.html">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthProvider.html#a7a65cbc1f29c15b26af08435e26c1948">is_sasl</a> ()=0</td></tr> |
| <tr class="memdesc:a7a65cbc1f29c15b26af08435e26c1948"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this provider uses Sasl at the transport layer. <a href="#a7a65cbc1f29c15b26af08435e26c1948">More...</a><br/></td></tr> |
| <tr class="separator:a7a65cbc1f29c15b26af08435e26c1948"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An <a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a> creates Thrift transports that are set up to authenticate themselves using a protocol such as Kerberos or PLAIN/SASL. Both server and client transports are provided by this class, using slightly different mechanisms (servers use a factory, clients wrap a pre-provided transport) </p> |
| |
| <p>Definition at line <a class="el" href="auth-provider_8h_source.html#l00036">36</a> of file <a class="el" href="auth-provider_8h_source.html">auth-provider.h</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="af211c2026d1a912dff56ec83b5fd1351"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classimpala_1_1Status.html">Status</a> impala::AuthProvider::GetServerTransportFactory </td> |
| <td>(</td> |
| <td class="paramtype">boost::shared_ptr< apache::thrift::transport::TTransportFactory > * </td> |
| <td class="paramname"><em>factory</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Creates a new Thrift transport factory in the out parameter that performs authorisation per this provider's protocol. </p> |
| |
| <p>Implemented in <a class="el" href="classimpala_1_1NoAuthProvider.html#a6764ce6f7e814e05aced755489e12502">impala::NoAuthProvider</a>, and <a class="el" href="classimpala_1_1SaslAuthProvider.html#ab05a4497ac30ef79ab72c0572dbf3d76">impala::SaslAuthProvider</a>.</p> |
| |
| <p>Referenced by <a class="el" href="thrift-server_8cc_source.html#l00351">impala::ThriftServer::Start()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7a65cbc1f29c15b26af08435e26c1948"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classbool.html">bool</a> impala::AuthProvider::is_sasl </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns true if this provider uses Sasl at the transport layer. </p> |
| |
| <p>Implemented in <a class="el" href="classimpala_1_1NoAuthProvider.html#abe57a28db564acb5ed2fb2bb63497332">impala::NoAuthProvider</a>, and <a class="el" href="classimpala_1_1SaslAuthProvider.html#a2e51551b9253599bfab7311f6e11a2b1">impala::SaslAuthProvider</a>.</p> |
| |
| <p>Referenced by <a class="el" href="authentication-test_8cc_source.html#l00056">impala::TEST()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a14d58f1bb630007340c83744f8aae349"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classimpala_1_1Status.html">Status</a> impala::AuthProvider::Start </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initialises any state required to perform authentication using this provider. </p> |
| |
| <p>Implemented in <a class="el" href="classimpala_1_1NoAuthProvider.html#a48ec7bd8282de9ac4bde221336cad1d3">impala::NoAuthProvider</a>, and <a class="el" href="classimpala_1_1SaslAuthProvider.html#ab9a4f36a58eaf36340a5cf8f403fe2c2">impala::SaslAuthProvider</a>.</p> |
| |
| <p>Referenced by <a class="el" href="ldap-test_8cc_source.html#l00031">main()</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7f412529caeebecf47def63d4ef08e06"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classimpala_1_1Status.html">Status</a> impala::AuthProvider::WrapClientTransport </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>hostname</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">boost::shared_ptr< apache::thrift::transport::TTransport > </td> |
| <td class="paramname"><em>raw_transport</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>service_name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">boost::shared_ptr< apache::thrift::transport::TTransport > * </td> |
| <td class="paramname"><em>wrapped_transport</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Called by Thrift clients to wrap a raw transport with any intermediate transport that an auth protocol requires. </p> |
| |
| <p>Implemented in <a class="el" href="classimpala_1_1NoAuthProvider.html#a4dc04a3b55426d2c4be5ebb6ae0846f4">impala::NoAuthProvider</a>, and <a class="el" href="classimpala_1_1SaslAuthProvider.html#a6584bde26ac46e52b7aa00b685c434f3">impala::SaslAuthProvider</a>.</p> |
| |
| <p>Referenced by <a class="el" href="thrift-client_8h_source.html#l00123">impala::ThriftClient< InterfaceType >::ThriftClient()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>be/src/rpc/<a class="el" href="auth-provider_8h_source.html">auth-provider.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a></li> |
| <li class="footer">Generated on Thu May 7 2015 16:10:49 for Impala by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
