Google Git
Sign in
apache/pulsar-site/refs/heads/release-python-3.12.0/./static/api/cpp/4.0.x/classpulsar_1_1_authentication.html
blob: c465919c16f3a1764bb76dcaf3d5c408ef7f8a2d [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pulsar-client-cpp: pulsar::Authentication 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript" src="darkmode_toggle.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 id="projectrow">
<td id="projectalign">
<div id="projectname">pulsar-client-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a href="namespacepulsar.html">pulsar</a></li><li class="navelem"><a href="classpulsar_1_1_authentication.html">Authentication</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<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="#pro-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classpulsar_1_1_authentication-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">pulsar::Authentication Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for pulsar::Authentication:</div>
<div class="dyncontent">
<div class="center">
<img src="classpulsar_1_1_authentication.png" usemap="#pulsar_3A_3AAuthentication_map" alt=""/>
<map id="pulsar_3A_3AAuthentication_map" name="pulsar_3A_3AAuthentication_map">
<area href="classpulsar_1_1_auth_athenz.html" alt="pulsar::AuthAthenz" shape="rect" coords="0,56,133,80"/>
<area href="classpulsar_1_1_auth_basic.html" alt="pulsar::AuthBasic" shape="rect" coords="143,56,276,80"/>
<area href="classpulsar_1_1_auth_oauth2.html" alt="pulsar::AuthOauth2" shape="rect" coords="286,56,419,80"/>
<area href="classpulsar_1_1_auth_tls.html" alt="pulsar::AuthTls" shape="rect" coords="429,56,562,80"/>
<area href="classpulsar_1_1_auth_token.html" alt="pulsar::AuthToken" shape="rect" coords="572,56,705,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aafe5c68d220ae0926a2c66953eafed57" id="r_aafe5c68d220ae0926a2c66953eafed57"><td class="memItemLeft" align="right" valign="top">virtual const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aafe5c68d220ae0926a2c66953eafed57">getAuthMethodName</a> () const =0</td></tr>
<tr class="memitem:a14811c36fc300cfa7769f7ee96018688" id="r_a14811c36fc300cfa7769f7ee96018688"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacepulsar.html#a23832680be30b95d54755b56310e9079">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a14811c36fc300cfa7769f7ee96018688">getAuthData</a> (AuthenticationDataPtr &amp;authDataContent)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-static-methods" class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0ff47251bd4184cd0e9155e76a5c35bb" id="r_a0ff47251bd4184cd0e9155e76a5c35bb"><td class="memItemLeft" align="right" valign="top">static ParamMap&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ff47251bd4184cd0e9155e76a5c35bb">parseDefaultFormatAuthParams</a> (const std::string &amp;authParamsString)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pro-attribs" class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:abac33d5c492826fb8a4bea05512c9f7c" id="r_abac33d5c492826fb8a4bea05512c9f7c"><td class="memItemLeft" align="right" valign="top"><a id="abac33d5c492826fb8a4bea05512c9f7c" name="abac33d5c492826fb8a4bea05512c9f7c"></a>
AuthenticationDataPtr&#160;</td><td class="memItemRight" valign="bottom"><b>authData_</b></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-friends" class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:abea2ee50c7ded8ed569f7cedfbecd6f5" id="r_abea2ee50c7ded8ed569f7cedfbecd6f5"><td class="memItemLeft" align="right" valign="top"><a id="abea2ee50c7ded8ed569f7cedfbecd6f5" name="abea2ee50c7ded8ed569f7cedfbecd6f5"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>ClientConfiguration</b></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a14811c36fc300cfa7769f7ee96018688" name="a14811c36fc300cfa7769f7ee96018688"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14811c36fc300cfa7769f7ee96018688">&#9670;&#160;</a></span>getAuthData()</h2>
<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="namespacepulsar.html#a23832680be30b95d54755b56310e9079">Result</a> pulsar::Authentication::getAuthData </td>
<td>(</td>
<td class="paramtype">AuthenticationDataPtr &amp;</td> <td class="paramname"><span class="paramname"><em>authDataContent</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get AuthenticationData from the current instance</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">authDataContent</td><td>the shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ResultOk or ResultAuthenticationError if authentication failed </dd></dl>
<p>Reimplemented in <a class="el" href="classpulsar_1_1_auth_athenz.html#a274c9e677c536166fd1d4f8af6161546">pulsar::AuthAthenz</a>, <a class="el" href="classpulsar_1_1_auth_basic.html#a7b1ccda07ff0a22a705159e27149f3d4">pulsar::AuthBasic</a>, <a class="el" href="classpulsar_1_1_auth_oauth2.html#adcf1f8cac446270ee6aa0a0ad156842e">pulsar::AuthOauth2</a>, <a class="el" href="classpulsar_1_1_auth_tls.html#ae88d06f62a47e92e7c52e74df3cacb56">pulsar::AuthTls</a>, and <a class="el" href="classpulsar_1_1_auth_token.html#a212a8af7680f196e4fba4e0152e6d0a5">pulsar::AuthToken</a>.</p>
</div>
</div>
<a id="aafe5c68d220ae0926a2c66953eafed57" name="aafe5c68d220ae0926a2c66953eafed57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafe5c68d220ae0926a2c66953eafed57">&#9670;&#160;</a></span>getAuthMethodName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::string pulsar::Authentication::getAuthMethodName </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the authentication method name supported by this provider </dd></dl>
<p>Implemented in <a class="el" href="classpulsar_1_1_auth_athenz.html#a65405a1cfd2ec3efcaeea3ed8269fa47">pulsar::AuthAthenz</a>, <a class="el" href="classpulsar_1_1_auth_basic.html#ad9d2d1d47a1f1d82fee3522ea5991c3b">pulsar::AuthBasic</a>, <a class="el" href="classpulsar_1_1_auth_oauth2.html#ac71578130863f59cb02fe1aefa9d70f6">pulsar::AuthOauth2</a>, <a class="el" href="classpulsar_1_1_auth_tls.html#a2c87f86950aa979f666896e7a5f79398">pulsar::AuthTls</a>, and <a class="el" href="classpulsar_1_1_auth_token.html#a0d1bf202c18b9131be315b166b4b1caa">pulsar::AuthToken</a>.</p>
</div>
</div>
<a id="a0ff47251bd4184cd0e9155e76a5c35bb" name="a0ff47251bd4184cd0e9155e76a5c35bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ff47251bd4184cd0e9155e76a5c35bb">&#9670;&#160;</a></span>parseDefaultFormatAuthParams()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ParamMap pulsar::Authentication::parseDefaultFormatAuthParams </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>authParamsString</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse the authentication parameter string to a map whose key and value are both strings</p>
<p>The parameter string can have multiple lines. The format of each line is a comma-separated “key:value” string.</p>
<p>For example, “k1:v1,k2:v2” is parsed to two key-value pairs <span class="tt">(k1, v1)</span> and <span class="tt">(k2, v2)</span>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">authParamsString</td><td>the authentication parameter string to be parsed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the parsed map whose key and value are both strings </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/pulsar/<a class="el" href="_authentication_8h_source.html">Authentication.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0
</small></address>
</div><!-- doc-content -->
</body>
</html>