Google Git
Sign in
apache / impala / asf-site / . / doc / html / classimpala_1_1AuthManager.html
blob: 0ba2d593d7ebc0df5c73dea91cd75c68fc58c7f2 [file] [log] [blame]
<!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::AuthManager 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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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_1AuthManager.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</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> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classimpala_1_1AuthManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::AuthManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="authentication_8h_source.html">authentication.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for impala::AuthManager:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1AuthManager__coll__graph.svg" width="319" height="320"><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:a9df4f6d4d61159d9285e625f773e5138"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthManager.html#a9df4f6d4d61159d9285e625f773e5138">Init</a> ()</td></tr>
<tr class="separator:a9df4f6d4d61159d9285e625f773e5138"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4bde295224c0d6241f4d0ac407396e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthManager.html#ab4bde295224c0d6241f4d0ac407396e2">GetExternalAuthProvider</a> ()</td></tr>
<tr class="separator:ab4bde295224c0d6241f4d0ac407396e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b76107631afd0c67f7597f20c29a13d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthManager.html#a9b76107631afd0c67f7597f20c29a13d">GetInternalAuthProvider</a> ()</td></tr>
<tr class="separator:a9b76107631afd0c67f7597f20c29a13d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a1a328e895342a405e76052d5dbe14038"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1AuthManager.html">AuthManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthManager.html#a1a328e895342a405e76052d5dbe14038">GetInstance</a> ()</td></tr>
<tr class="separator:a1a328e895342a405e76052d5dbe14038"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a93f397bc2e94cc958d5b08fbb1278cda"><td class="memItemLeft" align="right" valign="top">boost::scoped_ptr&lt; <a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthManager.html#a93f397bc2e94cc958d5b08fbb1278cda">internal_auth_provider_</a></td></tr>
<tr class="separator:a93f397bc2e94cc958d5b08fbb1278cda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b00c31b0209432b88c7f044c5dae00c"><td class="memItemLeft" align="right" valign="top">boost::scoped_ptr&lt; <a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthManager.html#a3b00c31b0209432b88c7f044c5dae00c">external_auth_provider_</a></td></tr>
<tr class="separator:a3b00c31b0209432b88c7f044c5dae00c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a0edf39acd13217a133f9d895b571ebab"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1AuthManager.html">AuthManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1AuthManager.html#a0edf39acd13217a133f9d895b571ebab">auth_manager_</a> = new <a class="el" href="classimpala_1_1AuthManager.html">AuthManager</a>()</td></tr>
<tr class="separator:a0edf39acd13217a133f9d895b571ebab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>System-wide authentication manager responsible for initialising authentication systems, including Sasl and Kerberos, and for providing auth-enabled Thrift structures to servers and clients. </p>
<p>Definition at line <a class="el" href="authentication_8h_source.html#l00035">35</a> of file <a class="el" href="authentication_8h_source.html">authentication.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab4bde295224c0d6241f4d0ac407396e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a> * impala::AuthManager::GetExternalAuthProvider </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the authentication provider to use for "external" communication such as the impala shell, jdbc, odbc, etc. This only applies to the server side of a connection; the client side of said connection is never an internal process. </p>
<p>Definition at line <a class="el" href="authentication_8cc_source.html#l01025">1025</a> of file <a class="el" href="authentication_8cc_source.html">authentication.cc</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="a1a328e895342a405e76052d5dbe14038"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classimpala_1_1AuthManager.html">AuthManager</a>* impala::AuthManager::GetInstance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="authentication_8h_source.html#l00037">37</a> of file <a class="el" href="authentication_8h_source.html">authentication.h</a>.</p>
<p>References <a class="el" href="authentication_8h_source.html#l00055">auth_manager_</a>.</p>
<p>Referenced by <a class="el" href="impala-server_8cc_source.html#l01641">impala::CreateImpalaServer()</a>, <a class="el" href="authentication-test_8cc_source.html#l00049">impala::TEST()</a>, <a class="el" href="thrift-client_8h_source.html#l00123">impala::ThriftClient&lt; InterfaceType &gt;::ThriftClient()</a>, and <a class="el" href="thrift-server_8cc_source.html#l00276">impala::ThriftServer::ThriftServer()</a>.</p>
</div>
</div>
<a class="anchor" id="a9b76107631afd0c67f7597f20c29a13d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a> * impala::AuthManager::GetInternalAuthProvider </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the authentication provider to use for internal daemon &lt;-&gt; daemon connections. This goes for both the client and server sides. An example connection this applies to would be backend &lt;-&gt; statestore. </p>
<p>Definition at line <a class="el" href="authentication_8cc_source.html#l01030">1030</a> of file <a class="el" href="authentication_8cc_source.html">authentication.cc</a>.</p>
<p>Referenced by <a class="el" href="authentication-test_8cc_source.html#l00056">impala::TEST()</a>, <a class="el" href="thrift-client_8h_source.html#l00123">impala::ThriftClient&lt; InterfaceType &gt;::ThriftClient()</a>, and <a class="el" href="thrift-server_8cc_source.html#l00276">impala::ThriftServer::ThriftServer()</a>.</p>
</div>
</div>
<a class="anchor" id="a9df4f6d4d61159d9285e625f773e5138"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::AuthManager::Init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up internal and external <a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a> classes. This does a bunch of flag checking and calls each AuthProvider-&gt;Start(). </p>
<p>Definition at line <a class="el" href="authentication_8cc_source.html#l00896">896</a> of file <a class="el" href="authentication_8cc_source.html">authentication.cc</a>.</p>
<p>References <a class="el" href="authentication_8cc_source.html#l00628">impala::SaslAuthProvider::InitKerberos()</a>, <a class="el" href="auth-provider_8h_source.html#l00095">impala::SaslAuthProvider::InitLdap()</a>, <a class="el" href="authentication_8cc_source.html#l00122">impala::LDAP_URI_PREFIX</a>, <a class="el" href="authentication_8cc_source.html#l00123">impala::LDAPS_URI_PREFIX</a>, <a class="el" href="webserver_8cc_source.html#l00115">impala::OK</a>, and <a class="el" href="status_8h_source.html#l00242">RETURN_IF_ERROR</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a0edf39acd13217a133f9d895b571ebab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1AuthManager.html">AuthManager</a> * impala::AuthManager::auth_manager_ = new <a class="el" href="classimpala_1_1AuthManager.html">AuthManager</a>()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="authentication_8h_source.html#l00055">55</a> of file <a class="el" href="authentication_8h_source.html">authentication.h</a>.</p>
<p>Referenced by <a class="el" href="authentication_8h_source.html#l00037">GetInstance()</a>.</p>
</div>
</div>
<a class="anchor" id="a3b00c31b0209432b88c7f044c5dae00c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::scoped_ptr&lt;<a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a>&gt; impala::AuthManager::external_auth_provider_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="authentication_8h_source.html#l00060">60</a> of file <a class="el" href="authentication_8h_source.html">authentication.h</a>.</p>
</div>
</div>
<a class="anchor" id="a93f397bc2e94cc958d5b08fbb1278cda"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::scoped_ptr&lt;<a class="el" href="classimpala_1_1AuthProvider.html">AuthProvider</a>&gt; impala::AuthManager::internal_auth_provider_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>These are provided for convenience, so that demon&lt;-&gt;demon and client&lt;-&gt;demon services don't have to check the auth flags to figure out which auth provider to use. </p>
<p>Definition at line <a class="el" href="authentication_8h_source.html#l00059">59</a> of file <a class="el" href="authentication_8h_source.html">authentication.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>be/src/rpc/<a class="el" href="authentication_8h_source.html">authentication.h</a></li>
<li>be/src/rpc/<a class="el" href="authentication_8cc_source.html">authentication.cc</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_1AuthManager.html">AuthManager</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>