blob: 535dc6e02a5f5c229eac3fea892d38c46db1eaba [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/module/http_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_9203508e9880229bf9e51c7531b2512c.html">module</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">http_authenticator.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="http__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_MODULE_HTTP_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_MODULE_HTTP_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;<a class="code" href="include_2mesos_2mesos_8hpp.html">mesos/mesos.hpp</a>&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2module_8hpp.html">mesos/module.hpp</a>&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="3rdparty_2libprocess_2include_2process_2authenticator_8hpp.html">process/authenticator.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="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span>modules {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacemesos_1_1modules.html#adfaf3842332168ae361f1679c8c47d29"> 29</a></span>&#160;<span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* kind&lt;process::http::authentication::Authenticator&gt;()</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;HttpAuthenticator&quot;</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;}</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structmesos_1_1modules_1_1Module_3_01process_1_1http_1_1authentication_1_1Authenticator_01_4.html"> 36</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmesos_1_1modules_1_1Module.html">Module</a>&lt;<a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>::http::authentication::Authenticator&gt; : <a class="code" href="structmesos_1_1modules_1_1ModuleBase.html">ModuleBase</a></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"><a class="line" href="structmesos_1_1modules_1_1Module_3_01process_1_1http_1_1authentication_1_1Authenticator_01_4.html#a1e6e86e91095a10c568298bb1e172dc8"> 38</a></span>&#160; <a class="code" href="structmesos_1_1modules_1_1Module_3_01process_1_1http_1_1authentication_1_1Authenticator_01_4.html#a1e6e86e91095a10c568298bb1e172dc8">Module</a>(</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* _moduleApiVersion,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* _mesosVersion,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* _authorName,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* _authorEmail,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* _description,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">bool</span> (*_compatible)(),</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="classprocess_1_1http_1_1authentication_1_1Authenticator.html">process::http::authentication::Authenticator</a>* (*_create)(</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> Parameters&amp; parameters))</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; : <a class="code" href="structmesos_1_1modules_1_1ModuleBase.html">ModuleBase</a>(</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; _moduleApiVersion,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; _mesosVersion,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; mesos::modules::<a class="code" href="namespacemesos_1_1modules.html#a70163bdea2fe39ef5b798a7d7ee0c220">kind</a>&lt;<a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>::<a class="code" href="namespacemesos_1_1uri.html#a5dff7c4a2df7be12fb642b5801c34f9f">http</a>::authentication::<a class="code" href="classmesos_1_1Authenticator.html">Authenticator</a>&gt;(),</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; _authorName,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; _authorEmail,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; _description,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; _compatible),</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="namespacecgroups.html#a2ecc89636706df947027a4c3c2100fbe">create</a>(_create) {}</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structmesos_1_1modules_1_1Module_3_01process_1_1http_1_1authentication_1_1Authenticator_01_4.html#abfdc98c6c14b5eb78031200934c29c26"> 57</a></span>&#160; <a class="code" href="classprocess_1_1http_1_1authentication_1_1Authenticator.html">process::http::authentication::Authenticator</a>* (*create)(</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">const</span> Parameters&amp; parameters);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;};</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;} <span class="comment">// namespace modules {</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;} <span class="comment">// namespace mesos {</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#endif // __MESOS_MODULE_HTTP_AUTHENTICATOR_HPP__</span></div>
<div class="ttc" id="structmesos_1_1modules_1_1ModuleBase_html"><div class="ttname"><a href="structmesos_1_1modules_1_1ModuleBase.html">mesos::modules::ModuleBase</a></div><div class="ttdef"><b>Definition:</b> module.hpp:56</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="namespacemesos_1_1modules_html_a70163bdea2fe39ef5b798a7d7ee0c220"><div class="ttname"><a href="namespacemesos_1_1modules.html#a70163bdea2fe39ef5b798a7d7ee0c220">mesos::modules::kind</a></div><div class="ttdeci">const char * kind()</div></div>
<div class="ttc" id="structmesos_1_1modules_1_1Module_3_01process_1_1http_1_1authentication_1_1Authenticator_01_4_html_a1e6e86e91095a10c568298bb1e172dc8"><div class="ttname"><a href="structmesos_1_1modules_1_1Module_3_01process_1_1http_1_1authentication_1_1Authenticator_01_4.html#a1e6e86e91095a10c568298bb1e172dc8">mesos::modules::Module&lt; process::http::authentication::Authenticator &gt;::Module</a></div><div class="ttdeci">Module(const char *_moduleApiVersion, const char *_mesosVersion, const char *_authorName, const char *_authorEmail, const char *_description, bool(*_compatible)(), process::http::authentication::Authenticator *(*_create)(const Parameters &amp;parameters))</div><div class="ttdef"><b>Definition:</b> http_authenticator.hpp:38</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:100</div></div>
<div class="ttc" id="classmesos_1_1Authenticator_html"><div class="ttname"><a href="classmesos_1_1Authenticator.html">mesos::Authenticator</a></div><div class="ttdef"><b>Definition:</b> authenticator.hpp:34</div></div>
<div class="ttc" id="include_2mesos_2module_8hpp_html"><div class="ttname"><a href="include_2mesos_2module_8hpp.html">module.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&lt; Process &gt; 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="namespacecgroups_html_a2ecc89636706df947027a4c3c2100fbe"><div class="ttname"><a href="namespacecgroups.html#a2ecc89636706df947027a4c3c2100fbe">cgroups::create</a></div><div class="ttdeci">Try&lt; Nothing &gt; create(const std::string &amp;hierarchy, const std::string &amp;cgroup, bool recursive=false)</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="structmesos_1_1modules_1_1Module_html"><div class="ttname"><a href="structmesos_1_1modules_1_1Module.html">mesos::modules::Module</a></div><div class="ttdef"><b>Definition:</b> module.hpp:97</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>