mkdocs/docs/api/auth__managers_8h.html - iceberg-cpp - Git at Google

 <!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.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>iceberg-cpp: iceberg/catalog/rest/auth/auth_managers.h File 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="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>
 <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">iceberg-cpp
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 /* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
 /* @license-end */
 </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 class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_e567eb46dbe88aaa1fd4ccb3586c5e69.html">catalog</a></li><li class="navelem"><a class="el" href="dir_3772e67070704cbb8771b4d409046ed1.html">rest</a></li><li class="navelem"><a class="el" href="dir_15a0eb8fe5f9120c932acc4ea86169a1.html">auth</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#nested-classes">Classes</a> &#124;
 <a href="#typedef-members">Typedefs</a>  </div>
   <div class="headertitle"><div class="title">auth_managers.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>Factory for creating authentication managers.
 <a href="#details">More...</a></p>
 <div class="textblock"><code>#include &lt;functional&gt;</code><br />
 <code>#include &lt;memory&gt;</code><br />
 <code>#include &lt;string&gt;</code><br />
 <code>#include &lt;string_view&gt;</code><br />
 <code>#include &lt;unordered_map&gt;</code><br />
 <code>#include &quot;<a class="el" href="auth__manager_8h_source.html">iceberg/catalog/rest/auth/auth_manager.h</a>&quot;</code><br />
 <code>#include &quot;iceberg/catalog/rest/iceberg_rest_export.h&quot;</code><br />
 <code>#include &quot;iceberg/result.h&quot;</code><br />
 </div>
 <p><a href="auth__managers_8h_source.html">Go to the source code of this file.</a></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 Classes</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthManagers.html">iceberg::rest::auth::AuthManagers</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registry-backed factory for <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthManager.html" title="Produces authentication sessions for catalog and table requests.">AuthManager</a> implementations.  <a href="classiceberg_1_1rest_1_1auth_1_1AuthManagers.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 Typedefs</h2></td></tr>
 <tr class="memitem:a8dcfa3f158cf6eb8345037e08fef0ef4" id="r_a8dcfa3f158cf6eb8345037e08fef0ef4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="auth__managers_8h.html#a8dcfa3f158cf6eb8345037e08fef0ef4">iceberg::rest::auth::AuthManagerFactory</a> = std::function&lt; Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthManager.html">AuthManager</a> &gt; &gt;(std::string_view name, const std::unordered_map&lt; std::string, std::string &gt; &amp;properties)&gt;</td></tr>
 <tr class="memdesc:a8dcfa3f158cf6eb8345037e08fef0ef4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function that creates an <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthManager.html" title="Produces authentication sessions for catalog and table requests.">AuthManager</a> from its name.  <br /></td></tr>
 <tr class="separator:a8dcfa3f158cf6eb8345037e08fef0ef4"><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>Factory for creating authentication managers. </p>
 </div><h2 class="groupheader">Typedef Documentation</h2>
 <a id="a8dcfa3f158cf6eb8345037e08fef0ef4" name="a8dcfa3f158cf6eb8345037e08fef0ef4"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a8dcfa3f158cf6eb8345037e08fef0ef4">&#9670;&#160;</a></span>AuthManagerFactory</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">using <a class="el" href="auth__managers_8h.html#a8dcfa3f158cf6eb8345037e08fef0ef4">iceberg::rest::auth::AuthManagerFactory</a> = typedef std::function&lt;Result&lt;std::unique_ptr&lt;AuthManager&gt; &gt;( std::string_view name, const std::unordered_map&lt;std::string, std::string&gt;&amp; properties)&gt;</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Function that creates an AuthManager from its name. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">name</td><td>Name of the auth manager. </td></tr>
     <tr><td class="paramname">properties</td><td>Properties required by the auth manager. </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>Newly created manager instance or an error if creation fails. </dd></dl>

 </div>
 </div>
 </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.9.8
 </small></address>
 </body>
 </html>
	<!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.9.8"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>iceberg-cpp: iceberg/catalog/rest/auth/auth_managers.h File 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="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>
	<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">iceberg-cpp
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.9.8 -->
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	var searchBox = new SearchBox("searchBox", "search/",'.html');
	/* @license-end */
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	$(function() {
	initMenu('',true,false,'search.php','Search');
	$(document).ready(function() { init_search(); });
	});
	/* @license-end */
	</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 class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_e567eb46dbe88aaa1fd4ccb3586c5e69.html">catalog</a></li><li class="navelem"><a class="el" href="dir_3772e67070704cbb8771b4d409046ed1.html">rest</a></li><li class="navelem"><a class="el" href="dir_15a0eb8fe5f9120c932acc4ea86169a1.html">auth</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#nested-classes">Classes</a> \|
	<a href="#typedef-members">Typedefs</a> </div>
	<div class="headertitle"><div class="title">auth_managers.h File Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>Factory for creating authentication managers.
	<a href="#details">More...</a></p>
	<div class="textblock"><code>#include <functional></code><br />
	<code>#include <memory></code><br />
	<code>#include <string></code><br />
	<code>#include <string_view></code><br />
	<code>#include <unordered_map></code><br />
	<code>#include "<a class="el" href="auth__manager_8h_source.html">iceberg/catalog/rest/auth/auth_manager.h</a>"</code><br />
	<code>#include "iceberg/catalog/rest/iceberg_rest_export.h"</code><br />
	<code>#include "iceberg/result.h"</code><br />
	</div>
	<p><a href="auth__managers_8h_source.html">Go to the source code of this file.</a></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
	Classes</h2></td></tr>
	<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthManagers.html">iceberg::rest::auth::AuthManagers</a></td></tr>
	<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Registry-backed factory for <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthManager.html" title="Produces authentication sessions for catalog and table requests.">AuthManager</a> implementations. <a href="classiceberg_1_1rest_1_1auth_1_1AuthManagers.html#details">More...</a><br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
	</table><table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
	Typedefs</h2></td></tr>
	<tr class="memitem:a8dcfa3f158cf6eb8345037e08fef0ef4" id="r_a8dcfa3f158cf6eb8345037e08fef0ef4"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="auth__managers_8h.html#a8dcfa3f158cf6eb8345037e08fef0ef4">iceberg::rest::auth::AuthManagerFactory</a> = std::function< Result< std::unique_ptr< <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthManager.html">AuthManager</a> > >(std::string_view name, const std::unordered_map< std::string, std::string > &properties)></td></tr>
	<tr class="memdesc:a8dcfa3f158cf6eb8345037e08fef0ef4"><td class="mdescLeft"> </td><td class="mdescRight">Function that creates an <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthManager.html" title="Produces authentication sessions for catalog and table requests.">AuthManager</a> from its name. <br /></td></tr>
	<tr class="separator:a8dcfa3f158cf6eb8345037e08fef0ef4"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Factory for creating authentication managers. </p>
	</div><h2 class="groupheader">Typedef Documentation</h2>
	<a id="a8dcfa3f158cf6eb8345037e08fef0ef4" name="a8dcfa3f158cf6eb8345037e08fef0ef4"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a8dcfa3f158cf6eb8345037e08fef0ef4">◆ </a></span>AuthManagerFactory</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">using <a class="el" href="auth__managers_8h.html#a8dcfa3f158cf6eb8345037e08fef0ef4">iceberg::rest::auth::AuthManagerFactory</a> = typedef std::function<Result<std::unique_ptr<AuthManager> >( std::string_view name, const std::unordered_map<std::string, std::string>& properties)></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Function that creates an AuthManager from its name. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">name</td><td>Name of the auth manager. </td></tr>
	<tr><td class="paramname">properties</td><td>Properties required by the auth manager. </td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd>Newly created manager instance or an error if creation fails. </dd></dl>

	</div>
	</div>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
	</small></address>
	</body>
	</html>