| <!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_session.h 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="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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_a7beda0dac529a54d3cdf90e787bdce7.html">catalog</a></li><li class="navelem"><a class="el" href="dir_08d6efe6feae927f0fa1ad794a1878b0.html">rest</a></li><li class="navelem"><a class="el" href="dir_2148276f9150a57285320fbe9f3c6738.html">auth</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">auth_session.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="auth__session_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <unordered_map></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "<a class="code" href="http__request_8h.html">iceberg/catalog/rest/http_request.h</a>"</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="iceberg__rest__export_8h.html">iceberg/catalog/rest/iceberg_rest_export.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="catalog_2rest_2type__fwd_8h.html">iceberg/catalog/rest/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg_1_1rest_1_1auth.html">iceberg::rest::auth</a> {</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="foldopen" id="foldopen00038" data-start="{" data-end="};"> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structiceberg_1_1rest_1_1auth_1_1OAuth2SessionInfo.html"> 38</a></span><span class="keyword">struct </span>ICEBERG_REST_EXPORT <a class="code hl_struct" href="structiceberg_1_1rest_1_1auth_1_1OAuth2SessionInfo.html">OAuth2SessionInfo</a> {</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> std::string token;</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> std::string issued_token_type;</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> std::string credential;</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> std::string scope;</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> std::string oauth2_server_uri;</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> std::unordered_map<std::string, std::string> optional_oauth_params;</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>};</div> |
| </div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div> |
| <div class="foldopen" id="foldopen00048" data-start="{" data-end="};"> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html"> 48</a></span><span class="keyword">class </span>ICEBERG_REST_EXPORT <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">AuthSession</a> {</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">~AuthSession</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a2276c85ff483dc8d5744a3c136807245"> 66</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<HttpRequest></a> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a2276c85ff483dc8d5744a3c136807245">Authenticate</a>(<a class="code hl_struct" href="structiceberg_1_1rest_1_1HttpRequest.html">HttpRequest</a> request) = 0;</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a511760edabbcd3027d849efbb3053c48"> 69</a></span> <span class="keyword">virtual</span> std::optional<OAuth2SessionInfo> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a511760edabbcd3027d849efbb3053c48">OAuth2Info</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> std::nullopt; }</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a98e98d7e9632887f073583389c9da5fd"> 78</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a98e98d7e9632887f073583389c9da5fd">Close</a>() { <span class="keywordflow">return</span> {}; }</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a43886a90d781950321acea6ee1b0d0b5"> 88</a></span> <span class="keyword">static</span> std::shared_ptr<AuthSession> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a43886a90d781950321acea6ee1b0d0b5">MakeDefault</a>(</div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> std::unordered_map<std::string, std::string> headers);</div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a6d568cd87ab5e5d3be79f8510aa1a898"> 108</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::shared_ptr<AuthSession></a>> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a6d568cd87ab5e5d3be79f8510aa1a898">MakeOAuth2</a>(</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1rest_1_1OAuthTokenResponse.html">OAuthTokenResponse</a>& initial_token, <span class="keyword">const</span> std::string& token_endpoint,</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">const</span> std::string& client_id, <span class="keyword">const</span> std::string& client_secret,</div> |
| <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">const</span> std::string& scope, <span class="keywordtype">bool</span> keep_refreshed,</div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">const</span> std::unordered_map<std::string, std::string>& optional_oauth_params,</div> |
| <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> std::shared_ptr<HttpClient> client);</div> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span>};</div> |
| </div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span>} <span class="comment">// namespace iceberg::rest::auth</span></div> |
| <div class="ttc" id="acatalog_2rest_2type__fwd_8h_html"><div class="ttname"><a href="catalog_2rest_2type__fwd_8h.html">type_fwd.h</a></div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthSession_html"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">iceberg::rest::auth::AuthSession</a></div><div class="ttdoc">An authentication session that can authenticate outgoing HTTP requests.</div><div class="ttdef"><b>Definition</b> auth_session.h:48</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthSession_html_a2276c85ff483dc8d5744a3c136807245"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a2276c85ff483dc8d5744a3c136807245">iceberg::rest::auth::AuthSession::Authenticate</a></div><div class="ttdeci">virtual Result< HttpRequest > Authenticate(HttpRequest request)=0</div><div class="ttdoc">Authenticate an outgoing HTTP request.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthSession_html_a43886a90d781950321acea6ee1b0d0b5"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a43886a90d781950321acea6ee1b0d0b5">iceberg::rest::auth::AuthSession::MakeDefault</a></div><div class="ttdeci">static std::shared_ptr< AuthSession > MakeDefault(std::unordered_map< std::string, std::string > headers)</div><div class="ttdoc">Create a session with static headers.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthSession_html_a511760edabbcd3027d849efbb3053c48"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a511760edabbcd3027d849efbb3053c48">iceberg::rest::auth::AuthSession::OAuth2Info</a></div><div class="ttdeci">virtual std::optional< OAuth2SessionInfo > OAuth2Info() const</div><div class="ttdoc">Return OAuth2 metadata when this is an OAuth2 session.</div><div class="ttdef"><b>Definition</b> auth_session.h:69</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthSession_html_a6d568cd87ab5e5d3be79f8510aa1a898"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a6d568cd87ab5e5d3be79f8510aa1a898">iceberg::rest::auth::AuthSession::MakeOAuth2</a></div><div class="ttdeci">static Result< std::shared_ptr< AuthSession > > MakeOAuth2(const OAuthTokenResponse &initial_token, const std::string &token_endpoint, const std::string &client_id, const std::string &client_secret, const std::string &scope, bool keep_refreshed, const std::unordered_map< std::string, std::string > &optional_oauth_params, std::shared_ptr< HttpClient > client)</div><div class="ttdoc">Create an OAuth2 session with automatic token refresh.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthSession_html_a98e98d7e9632887f073583389c9da5fd"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html#a98e98d7e9632887f073583389c9da5fd">iceberg::rest::auth::AuthSession::Close</a></div><div class="ttdeci">virtual Status Close()</div><div class="ttdoc">Close the session and release any resources.</div><div class="ttdef"><b>Definition</b> auth_session.h:78</div></div> |
| <div class="ttc" id="ahttp__request_8h_html"><div class="ttname"><a href="http__request_8h.html">http_request.h</a></div><div class="ttdoc">Define REST HTTP request types.</div></div> |
| <div class="ttc" id="aiceberg__rest__export_8h_html"><div class="ttname"><a href="iceberg__rest__export_8h.html">iceberg_rest_export.h</a></div><div class="ttdoc">Define symbol visibility macros for the REST catalog library.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_1_1auth_html"><div class="ttname"><a href="namespaceiceberg_1_1rest_1_1auth.html">iceberg::rest::auth</a></div><div class="ttdoc">REST catalog authentication APIs.</div><div class="ttdef"><b>Definition</b> auth_manager.h:34</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="astructiceberg_1_1rest_1_1HttpRequest_html"><div class="ttname"><a href="structiceberg_1_1rest_1_1HttpRequest.html">iceberg::rest::HttpRequest</a></div><div class="ttdoc">An outgoing HTTP request. Mirrors Java's HttpRequest so signing implementations like SigV4 see method...</div><div class="ttdef"><b>Definition</b> http_request.h:89</div></div> |
| <div class="ttc" id="astructiceberg_1_1rest_1_1OAuthTokenResponse_html"><div class="ttname"><a href="structiceberg_1_1rest_1_1OAuthTokenResponse.html">iceberg::rest::OAuthTokenResponse</a></div><div class="ttdoc">Response from an OAuth2 token endpoint.</div><div class="ttdef"><b>Definition</b> types.h:300</div></div> |
| <div class="ttc" id="astructiceberg_1_1rest_1_1auth_1_1OAuth2SessionInfo_html"><div class="ttname"><a href="structiceberg_1_1rest_1_1auth_1_1OAuth2SessionInfo.html">iceberg::rest::auth::OAuth2SessionInfo</a></div><div class="ttdoc">OAuth2 metadata used to derive child authentication sessions.</div><div class="ttdef"><b>Definition</b> auth_session.h:38</div></div> |
| </div><!-- fragment --></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> |
