| <!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.5"/> |
| <title>Apache Mesos: 3rdparty/libprocess/src/authenticator_manager.hpp Source File</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="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">Apache Mesos |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.5 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_043a76de98701f9bddf61b5e98f305ff.html">libprocess</a></li><li class="navelem"><a class="el" href="dir_01cbbd8dcbf9de3825992568658f467e.html">src</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">authenticator_manager.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="authenticator__manager_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// you may not use this file except in compliance with the License.</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// limitations under the License</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __PROCESS_AUTHENTICATION_ROUTER_HPP__</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="preprocessor">#define __PROCESS_AUTHENTICATION_ROUTER_HPP__</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2libprocess_2include_2process_2authenticator_8hpp.html">process/authenticator.hpp</a>></span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="future_8hpp.html">process/future.hpp</a>></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2libprocess_2include_2process_2http_8hpp.html">process/http.hpp</a>></span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="owned_8hpp.html">process/owned.hpp</a>></span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="nothing_8hpp.html">stout/nothing.hpp</a>></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="option_8hpp.html">stout/option.hpp</a>></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> {</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespacemesos_1_1uri.html#a5dff7c4a2df7be12fb642b5801c34f9f">http</a> {</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>authentication {</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>AuthenticatorManagerProcess;</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Manages the realm -> Authenticator mapping for HTTP</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// authentication in libprocess. Endpoints may map to</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// a realm. Each realm may have an authenticator set</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// here, through which all requests to matching</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// endpoints will be authenticated.</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html">AuthenticatorManager</a></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#a84781b651f77c149b790fc75947d3776">AuthenticatorManager</a>();</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#a2901bf20fd2a5fd0a74f601801416511">~AuthenticatorManager</a>();</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// Sets the authenticator for the realm; this will</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// overwrite any previous authenticator for the realm.</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classprocess_1_1Future.html">Future<Nothing></a> <a class="code" href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#a127b3385219f1c6f4788758a0db823a1">setAuthenticator</a>(</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> std::string& realm,</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classprocess_1_1Owned.html">Owned<Authenticator></a> authenticator);</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// Unsets the authenticator for the realm.</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classprocess_1_1Future.html">Future<Nothing></a> <a class="code" href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#aa68812240328fdac177fd106ef8087dd">unsetAuthenticator</a>(<span class="keyword">const</span> std::string& realm);</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// Authenticates the request, will return None if no</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// authentication is required because there is no</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// authenticator for the realm.</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classprocess_1_1Future.html">Future<Option<AuthenticationResult></a>> <a class="code" href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#ab5e0d8812648cbb394e2a40427bca999">authenticate</a>(</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">const</span> <a class="code" href="structprocess_1_1http_1_1Request.html">Request</a>& <a class="code" href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">request</a>,</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> std::string& realm);</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classprocess_1_1Owned.html">Owned<AuthenticatorManagerProcess></a> process;</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> };</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> } <span class="comment">// namespace authentication {</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> } <span class="comment">// namespace http {</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> } <span class="comment">// namespace process {</span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#endif // __PROCESS_REALM_MANAGER_HPP__</span></div> |
| <div class="ttc" id="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager_html"><div class="ttname"><a href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html">process::http::authentication::AuthenticatorManager</a></div><div class="ttdef"><b>Definition:</b> authenticator_manager.hpp:38</div></div> |
| <div class="ttc" id="namespaceprocess_1_1http_html_ad8f400b5e54038df7e5662ec35da05fa"><div class="ttname"><a href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">process::http::request</a></div><div class="ttdeci">Future< Response > request(const Request &request, bool streamedResponse=false)</div><div class="ttdoc">Asynchronously sends an HTTP request to the process and returns the HTTP response once the entire res...</div></div> |
| <div class="ttc" id="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager_html_aa68812240328fdac177fd106ef8087dd"><div class="ttname"><a href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#aa68812240328fdac177fd106ef8087dd">process::http::authentication::AuthenticatorManager::unsetAuthenticator</a></div><div class="ttdeci">Future< Nothing > unsetAuthenticator(const std::string &realm)</div></div> |
| <div class="ttc" id="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager_html_a84781b651f77c149b790fc75947d3776"><div class="ttname"><a href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#a84781b651f77c149b790fc75947d3776">process::http::authentication::AuthenticatorManager::AuthenticatorManager</a></div><div class="ttdeci">AuthenticatorManager()</div></div> |
| <div class="ttc" id="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager_html_a2901bf20fd2a5fd0a74f601801416511"><div class="ttname"><a href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#a2901bf20fd2a5fd0a74f601801416511">process::http::authentication::AuthenticatorManager::~AuthenticatorManager</a></div><div class="ttdeci">~AuthenticatorManager()</div></div> |
| <div class="ttc" id="structprocess_1_1http_1_1Request_html"><div class="ttname"><a href="structprocess_1_1http_1_1Request.html">process::http::Request</a></div><div class="ttdef"><b>Definition:</b> http.hpp:511</div></div> |
| <div class="ttc" id="nothing_8hpp_html"><div class="ttname"><a href="nothing_8hpp.html">nothing.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager_html_a127b3385219f1c6f4788758a0db823a1"><div class="ttname"><a href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#a127b3385219f1c6f4788758a0db823a1">process::http::authentication::AuthenticatorManager::setAuthenticator</a></div><div class="ttdeci">Future< Nothing > setAuthenticator(const std::string &realm, Owned< Authenticator > authenticator)</div></div> |
| <div class="ttc" id="option_8hpp_html"><div class="ttname"><a href="option_8hpp.html">option.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager_html_ab5e0d8812648cbb394e2a40427bca999"><div class="ttname"><a href="classprocess_1_1http_1_1authentication_1_1AuthenticatorManager.html#ab5e0d8812648cbb394e2a40427bca999">process::http::authentication::AuthenticatorManager::authenticate</a></div><div class="ttdeci">Future< Option< AuthenticationResult > > authenticate(const Request &request, const std::string &realm)</div></div> |
| <div class="ttc" id="future_8hpp_html"><div class="ttname"><a href="future_8hpp.html">future.hpp</a></div></div> |
| <div class="ttc" id="namespaceos_html_ae19e4161a51b86a1f330f3bf1dc75389"><div class="ttname"><a href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">os::process</a></div><div class="ttdeci">Result< Process > process(pid_t pid)</div><div class="ttdef"><b>Definition:</b> freebsd.hpp:30</div></div> |
| <div class="ttc" id="3rdparty_2libprocess_2include_2process_2authenticator_8hpp_html"><div class="ttname"><a href="3rdparty_2libprocess_2include_2process_2authenticator_8hpp.html">authenticator.hpp</a></div></div> |
| <div class="ttc" id="owned_8hpp_html"><div class="ttname"><a href="owned_8hpp.html">owned.hpp</a></div></div> |
| <div class="ttc" id="namespacemesos_1_1uri_html_a5dff7c4a2df7be12fb642b5801c34f9f"><div class="ttname"><a href="namespacemesos_1_1uri.html#a5dff7c4a2df7be12fb642b5801c34f9f">mesos::uri::http</a></div><div class="ttdeci">URI http(const std::string &host, const std::string &path="/", const Option< int > &port=None(), const Option< std::string > &query=None(), const Option< std::string > &fragment=None(), const Option< std::string > &user=None(), const Option< std::string > &password=None())</div><div class="ttdoc">Creates an http URI with the given parameters. </div><div class="ttdef"><b>Definition:</b> http.hpp:35</div></div> |
| <div class="ttc" id="classprocess_1_1Owned_html"><div class="ttname"><a href="classprocess_1_1Owned.html">process::Owned</a></div><div class="ttdef"><b>Definition:</b> owned.hpp:35</div></div> |
| <div class="ttc" id="3rdparty_2libprocess_2include_2process_2http_8hpp_html"><div class="ttname"><a href="3rdparty_2libprocess_2include_2process_2http_8hpp.html">http.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future< Nothing ></a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
