| <!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/oauth2_util.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="#func-members">Functions</a> | |
| <a href="#var-members">Variables</a> </div> |
| <div class="headertitle"><div class="title">oauth2_util.h File Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>OAuth2 token utilities for REST catalog authentication. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <string></code><br /> |
| <code>#include <string_view></code><br /> |
| <code>#include <unordered_map></code><br /> |
| <code>#include "iceberg/catalog/rest/iceberg_rest_export.h"</code><br /> |
| <code>#include "<a class="el" href="catalog_2rest_2type__fwd_8h_source.html">iceberg/catalog/rest/type_fwd.h</a>"</code><br /> |
| <code>#include "<a class="el" href="types_8h_source.html">iceberg/catalog/rest/types.h</a>"</code><br /> |
| <code>#include "iceberg/result.h"</code><br /> |
| </div> |
| <p><a href="oauth2__util_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="func-members" name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:acfac361cc047e5d2f7894c0753a3b27e" id="r_acfac361cc047e5d2f7894c0753a3b27e"><td class="memItemLeft" align="right" valign="top">Result< <a class="el" href="structiceberg_1_1rest_1_1OAuthTokenResponse.html">OAuthTokenResponse</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="oauth2__util_8cc.html#acfac361cc047e5d2f7894c0753a3b27e">iceberg::rest::auth::FetchToken</a> (<a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a> &client, <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">AuthSession</a> &session, const <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html">AuthProperties</a> &properties)</td></tr> |
| <tr class="memdesc:acfac361cc047e5d2f7894c0753a3b27e"><td class="mdescLeft"> </td><td class="mdescRight">Fetch an OAuth2 token using the client_credentials grant type. <br /></td></tr> |
| <tr class="separator:acfac361cc047e5d2f7894c0753a3b27e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b92549cf00e5e6b0bc3cda44d13574d" id="r_a5b92549cf00e5e6b0bc3cda44d13574d"><td class="memItemLeft" align="right" valign="top">std::unordered_map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="oauth2__util_8cc.html#a5b92549cf00e5e6b0bc3cda44d13574d">iceberg::rest::auth::AuthHeaders</a> (const std::string &token)</td></tr> |
| <tr class="memdesc:a5b92549cf00e5e6b0bc3cda44d13574d"><td class="mdescLeft"> </td><td class="mdescRight">Build auth headers from a token string. <br /></td></tr> |
| <tr class="separator:a5b92549cf00e5e6b0bc3cda44d13574d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a> |
| Variables</h2></td></tr> |
| <tr class="memitem:aaab82b5093df29f7bbf881d846b17f28" id="r_aaab82b5093df29f7bbf881d846b17f28"><td class="memItemLeft" align="right" valign="top"><a id="aaab82b5093df29f7bbf881d846b17f28" name="aaab82b5093df29f7bbf881d846b17f28"></a> |
| constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>iceberg::rest::auth::kAuthorizationHeader</b> = "Authorization"</td></tr> |
| <tr class="separator:aaab82b5093df29f7bbf881d846b17f28"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d72ebd56c1090015820659e825a01bb" id="r_a1d72ebd56c1090015820659e825a01bb"><td class="memItemLeft" align="right" valign="top"><a id="a1d72ebd56c1090015820659e825a01bb" name="a1d72ebd56c1090015820659e825a01bb"></a> |
| constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>iceberg::rest::auth::kBearerPrefix</b> = "Bearer "</td></tr> |
| <tr class="separator:a1d72ebd56c1090015820659e825a01bb"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>OAuth2 token utilities for REST catalog authentication. </p> |
| </div><h2 class="groupheader">Function Documentation</h2> |
| <a id="a5b92549cf00e5e6b0bc3cda44d13574d" name="a5b92549cf00e5e6b0bc3cda44d13574d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5b92549cf00e5e6b0bc3cda44d13574d">◆ </a></span>AuthHeaders()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ICEBERG_REST_EXPORT std::unordered_map< std::string, std::string > iceberg::rest::auth::AuthHeaders </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>token</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Build auth headers from a token string. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">token</td><td>Bearer token string (may be empty). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Headers map with Authorization header if token is non-empty. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="acfac361cc047e5d2f7894c0753a3b27e" name="acfac361cc047e5d2f7894c0753a3b27e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acfac361cc047e5d2f7894c0753a3b27e">◆ </a></span>FetchToken()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ICEBERG_REST_EXPORT Result< OAuthTokenResponse > iceberg::rest::auth::FetchToken </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a> & </td> |
| <td class="paramname"><em>client</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">AuthSession</a> & </td> |
| <td class="paramname"><em>session</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html">AuthProperties</a> & </td> |
| <td class="paramname"><em>properties</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fetch an OAuth2 token using the client_credentials grant type. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">client</td><td>HTTP client to use for the request. </td></tr> |
| <tr><td class="paramname">session</td><td>Auth session for the request headers. </td></tr> |
| <tr><td class="paramname">properties</td><td>Auth configuration containing credential, scope, token endpoint, and optional OAuth params. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The token response or an error. </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> |
