blob: a2dcfea0e00b1eb701b76eaa2178014b9406552e [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.5"/>
<title>Apache Mesos: include/mesos/authentication/http/combined_authenticator.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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_a00cdca4cac44d29e96ac7c7cae2bc86.html">mesos</a></li><li class="navelem"><a class="el" href="dir_561a4a6b181552a034e3bcd8dbedf91f.html">authentication</a></li><li class="navelem"><a class="el" href="dir_f235782f46b11b9cd008a0026f5b6286.html">http</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">combined_authenticator.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="combined__authenticator_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>&#160;<span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef __MESOS_AUTHENTICATION_HTTP_COMBINED_AUTHENTICATOR_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __MESOS_AUTHENTICATION_HTTP_COMBINED_AUTHENTICATOR_HPP__</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2mesos_8hpp.html">mesos/mesos.hpp</a>&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="3rdparty_2libprocess_2include_2process_2authenticator_8hpp.html">process/authenticator.hpp</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="future_8hpp.html">process/future.hpp</a>&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="3rdparty_2libprocess_2include_2process_2http_8hpp.html">process/http.hpp</a>&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="owned_8hpp.html">process/owned.hpp</a>&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="hashset_8hpp.html">stout/hashset.hpp</a>&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemesos_1_1uri.html#a5dff7c4a2df7be12fb642b5801c34f9f">http</a> {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">namespace </span>authentication {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">class </span>CombinedAuthenticatorProcess;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html"> 42</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html">CombinedAuthenticator</a></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; : <span class="keyword">public</span> <a class="code" href="classprocess_1_1http_1_1authentication_1_1Authenticator.html">process::http::authentication::Authenticator</a></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#a8f8d9fe93964ae8b5b0bf52de4bfdaad">CombinedAuthenticator</a>(</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">const</span> std::string&amp; realm,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; std::vector&lt;<a class="code" href="classprocess_1_1Owned.html">process::Owned</a>&lt;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classprocess_1_1http_1_1authentication_1_1Authenticator.html">process::http::authentication::Authenticator</a>&gt;&gt;&amp;&amp; authenticators);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#a8f8d9fe93964ae8b5b0bf52de4bfdaad">CombinedAuthenticator</a>(<span class="keyword">const</span> <a class="code" href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html">CombinedAuthenticator</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#ac497081ec6c2ff2c97ebe55284d8cbf2">~CombinedAuthenticator</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <a class="code" href="classprocess_1_1Future.html">process::Future&lt;process::http::authentication::AuthenticationResult&gt;</a></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <a class="code" href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#aaf835fbebb87fc98f406293d473759e6">authenticate</a>(<span class="keyword">const</span> <a class="code" href="structprocess_1_1http_1_1Request.html">process::http::Request</a>&amp; <a class="code" href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">request</a>) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; std::string <a class="code" href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#a159a32780b6713089488721cede12894">scheme</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <a class="code" href="classprocess_1_1Owned.html">process::Owned&lt;CombinedAuthenticatorProcess&gt;</a> process;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <a class="code" href="classhashset.html">hashset&lt;std::string&gt;</a> schemes;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;};</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;} <span class="comment">// namespace authentication {</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;} <span class="comment">// namespace http {</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;} <span class="comment">// namespace mesos {</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="preprocessor">#endif // __MESOS_AUTHENTICATION_HTTP_COMBINED_AUTHENTICATOR_HPP__</span></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&lt; Response &gt; request(const Request &amp;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="classhashset_html"><div class="ttname"><a href="classhashset.html">hashset&lt; std::string &gt;</a></div></div>
<div class="ttc" id="include_2mesos_2mesos_8hpp_html"><div class="ttname"><a href="include_2mesos_2mesos_8hpp.html">mesos.hpp</a></div></div>
<div class="ttc" id="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator_html"><div class="ttname"><a href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html">mesos::http::authentication::CombinedAuthenticator</a></div><div class="ttdoc">An authenticator which holds references to multiple authenticators. </div><div class="ttdef"><b>Definition:</b> combined_authenticator.hpp:42</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="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator_html_a8f8d9fe93964ae8b5b0bf52de4bfdaad"><div class="ttname"><a href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#a8f8d9fe93964ae8b5b0bf52de4bfdaad">mesos::http::authentication::CombinedAuthenticator::CombinedAuthenticator</a></div><div class="ttdeci">CombinedAuthenticator(const std::string &amp;realm, std::vector&lt; process::Owned&lt; process::http::authentication::Authenticator &gt;&gt; &amp;&amp;authenticators)</div></div>
<div class="ttc" id="classprocess_1_1http_1_1authentication_1_1Authenticator_html"><div class="ttname"><a href="classprocess_1_1http_1_1authentication_1_1Authenticator.html">process::http::authentication::Authenticator</a></div><div class="ttdoc">The Authenticator interface allows us to implement different authenticators based on the scheme (e...</div><div class="ttdef"><b>Definition:</b> authenticator.hpp:103</div></div>
<div class="ttc" id="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator_html_ac497081ec6c2ff2c97ebe55284d8cbf2"><div class="ttname"><a href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#ac497081ec6c2ff2c97ebe55284d8cbf2">mesos::http::authentication::CombinedAuthenticator::~CombinedAuthenticator</a></div><div class="ttdeci">~CombinedAuthenticator() override</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="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator_html_a159a32780b6713089488721cede12894"><div class="ttname"><a href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#a159a32780b6713089488721cede12894">mesos::http::authentication::CombinedAuthenticator::scheme</a></div><div class="ttdeci">std::string scheme() const override</div><div class="ttdoc">Returns the authentication schemes offered by the installed authenticators, separated by whitespace...</div></div>
<div class="ttc" id="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator_html_aaf835fbebb87fc98f406293d473759e6"><div class="ttname"><a href="classmesos_1_1http_1_1authentication_1_1CombinedAuthenticator.html#aaf835fbebb87fc98f406293d473759e6">mesos::http::authentication::CombinedAuthenticator::authenticate</a></div><div class="ttdeci">process::Future&lt; process::http::authentication::AuthenticationResult &gt; authenticate(const process::http::Request &amp;request) override</div><div class="ttdoc">Authenticates using the installed authenticators. </div></div>
<div class="ttc" id="hashset_8hpp_html"><div class="ttname"><a href="hashset_8hpp.html">hashset.hpp</a></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 &amp;host, const std::string &amp;path=&quot;/&quot;, const Option&lt; int &gt; &amp;port=None(), const Option&lt; std::string &gt; &amp;query=None(), const Option&lt; std::string &gt; &amp;fragment=None(), const Option&lt; std::string &gt; &amp;user=None(), const Option&lt; std::string &gt; &amp;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</a></div><div class="ttdef"><b>Definition:</b> future.hpp:56</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>