Evaluate/projects/iceberg/java/doxygen_doc/xml/AuthConfig_8java.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.17">
  <compounddef id="AuthConfig_8java" kind="file" language="Java">
    <compoundname>AuthConfig.java</compoundname>
    <innerclass refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig" prot="public">org::apache::iceberg::rest::auth::AuthConfig</innerclass>
    <innernamespace refid="namespaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth">org::apache::iceberg::rest::auth</innernamespace>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="comment">/*</highlight></codeline>
<codeline lineno="2"><highlight class="comment"><sp/>*<sp/>Licensed<sp/>to<sp/>the<sp/>Apache<sp/>Software<sp/>Foundation<sp/>(ASF)<sp/>under<sp/>one</highlight></codeline>
<codeline lineno="3"><highlight class="comment"><sp/>*<sp/>or<sp/>more<sp/>contributor<sp/>license<sp/>agreements.<sp/><sp/>See<sp/>the<sp/>NOTICE<sp/>file</highlight></codeline>
<codeline lineno="4"><highlight class="comment"><sp/>*<sp/>distributed<sp/>with<sp/>this<sp/>work<sp/>for<sp/>additional<sp/>information</highlight></codeline>
<codeline lineno="5"><highlight class="comment"><sp/>*<sp/>regarding<sp/>copyright<sp/>ownership.<sp/><sp/>The<sp/>ASF<sp/>licenses<sp/>this<sp/>file</highlight></codeline>
<codeline lineno="6"><highlight class="comment"><sp/>*<sp/>to<sp/>you<sp/>under<sp/>the<sp/>Apache<sp/>License,<sp/>Version<sp/>2.0<sp/>(the</highlight></codeline>
<codeline lineno="7"><highlight class="comment"><sp/>*<sp/>&quot;License&quot;);<sp/>you<sp/>may<sp/>not<sp/>use<sp/>this<sp/>file<sp/>except<sp/>in<sp/>compliance</highlight></codeline>
<codeline lineno="8"><highlight class="comment"><sp/>*<sp/>with<sp/>the<sp/>License.<sp/><sp/>You<sp/>may<sp/>obtain<sp/>a<sp/>copy<sp/>of<sp/>the<sp/>License<sp/>at</highlight></codeline>
<codeline lineno="9"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="10"><highlight class="comment"><sp/>*<sp/><sp/><sp/>http://www.apache.org/licenses/LICENSE-2.0</highlight></codeline>
<codeline lineno="11"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="12"><highlight class="comment"><sp/>*<sp/>Unless<sp/>required<sp/>by<sp/>applicable<sp/>law<sp/>or<sp/>agreed<sp/>to<sp/>in<sp/>writing,</highlight></codeline>
<codeline lineno="13"><highlight class="comment"><sp/>*<sp/>software<sp/>distributed<sp/>under<sp/>the<sp/>License<sp/>is<sp/>distributed<sp/>on<sp/>an</highlight></codeline>
<codeline lineno="14"><highlight class="comment"><sp/>*<sp/>&quot;AS<sp/>IS&quot;<sp/>BASIS,<sp/>WITHOUT<sp/>WARRANTIES<sp/>OR<sp/>CONDITIONS<sp/>OF<sp/>ANY</highlight></codeline>
<codeline lineno="15"><highlight class="comment"><sp/>*<sp/>KIND,<sp/>either<sp/>express<sp/>or<sp/>implied.<sp/><sp/>See<sp/>the<sp/>License<sp/>for<sp/>the</highlight></codeline>
<codeline lineno="16"><highlight class="comment"><sp/>*<sp/>specific<sp/>language<sp/>governing<sp/>permissions<sp/>and<sp/>limitations</highlight></codeline>
<codeline lineno="17"><highlight class="comment"><sp/>*<sp/>under<sp/>the<sp/>License.</highlight></codeline>
<codeline lineno="18"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><highlight class="normal"></highlight><highlight class="keyword">package<sp/></highlight><highlight class="normal">org.apache.iceberg.rest.auth;</highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight></codeline>
<codeline lineno="21"><highlight class="normal"></highlight><highlight class="keyword">import</highlight><highlight class="normal"><sp/>java.util.Map;</highlight></codeline>
<codeline lineno="22"><highlight class="normal"></highlight><highlight class="keyword">import</highlight><highlight class="normal"><sp/>javax.annotation.Nullable;</highlight></codeline>
<codeline lineno="23"><highlight class="normal"></highlight><highlight class="keyword">import</highlight><highlight class="normal"><sp/><ref refid="namespaceorg" kindref="compound">org</ref>.<ref refid="namespaceorg_1_1apache" kindref="compound">apache</ref>.<ref refid="namespaceorg_1_1apache_1_1iceberg" kindref="compound">iceberg</ref>.<ref refid="namespaceorg_1_1apache_1_1iceberg_1_1rest" kindref="compound">rest</ref>.<ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1ResourcePaths" kindref="compound">ResourcePaths</ref>;</highlight></codeline>
<codeline lineno="24"><highlight class="normal"></highlight><highlight class="keyword">import</highlight><highlight class="normal"><sp/><ref refid="namespaceorg" kindref="compound">org</ref>.immutables.value.Value;</highlight></codeline>
<codeline lineno="25"><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal">@Value.Style(redactedMask<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;****&quot;</highlight><highlight class="normal">)</highlight></codeline>
<codeline lineno="31"><highlight class="normal">@SuppressWarnings(</highlight><highlight class="stringliteral">&quot;ImmutablesStyle&quot;</highlight><highlight class="normal">)</highlight></codeline>
<codeline lineno="32"><highlight class="normal">@Value.Immutable</highlight></codeline>
<codeline lineno="33" refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">interface<sp/></highlight><highlight class="normal"><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig" kindref="compound">AuthConfig</ref><sp/>{</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/>@Nullable</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/>@Value.Redacted</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/>String<sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1ad3c73fcc7e0569277fed82f9aaa0293e" kindref="member">token</ref>();</highlight></codeline>
<codeline lineno="37"><highlight class="normal"></highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/>@Nullable</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/>String<sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a1eec7021a22dd3eedf69b5a83533a992" kindref="member">tokenType</ref>();</highlight></codeline>
<codeline lineno="40"><highlight class="normal"></highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/>@Nullable</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/>@Value.Redacted</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/>String<sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a725867d95cdfa0e30c0ea7666955475c" kindref="member">credential</ref>();</highlight></codeline>
<codeline lineno="44"><highlight class="normal"></highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/>@Value.Default</highlight></codeline>
<codeline lineno="46" refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a3b96c4fb09886bebaa84dcb676b9d63a" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">default</highlight><highlight class="normal"><sp/>String<sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a3b96c4fb09886bebaa84dcb676b9d63a" kindref="member">scope</ref>()<sp/>{</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1OAuth2Properties" kindref="compound">OAuth2Properties</ref>.<ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1OAuth2Properties_1a2f8db7df40039423af574c27006349f9" kindref="member">CATALOG_SCOPE</ref>;</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="49"><highlight class="normal"></highlight></codeline>
<codeline lineno="50"><highlight class="normal"><sp/><sp/>@Value.Lazy</highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/>@Nullable</highlight></codeline>
<codeline lineno="52" refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a127714ec406318b000cd08f4f9de9b7c" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">default</highlight><highlight class="normal"><sp/>Long<sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a127714ec406318b000cd08f4f9de9b7c" kindref="member">expiresAtMillis</ref>()<sp/>{</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1OAuth2Util" kindref="compound">OAuth2Util</ref>.expiresAtMillis(<ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1ad3c73fcc7e0569277fed82f9aaa0293e" kindref="member">token</ref>());</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="55"><highlight class="normal"></highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/>@Value.Default</highlight></codeline>
<codeline lineno="57" refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a01f656e4684e4d46b1c58f70085962aa" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">default</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">boolean</highlight><highlight class="normal"><sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a01f656e4684e4d46b1c58f70085962aa" kindref="member">keepRefreshed</ref>()<sp/>{</highlight></codeline>
<codeline lineno="58"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">true</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="59"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="60"><highlight class="normal"></highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/>@Nullable</highlight></codeline>
<codeline lineno="62"><highlight class="normal"><sp/><sp/>@Value.Default</highlight></codeline>
<codeline lineno="63" refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1ae1a8562e48c8e42709b206b457db8cfb" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">default</highlight><highlight class="normal"><sp/>String<sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1ae1a8562e48c8e42709b206b457db8cfb" kindref="member">oauth2ServerUri</ref>()<sp/>{</highlight></codeline>
<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1ResourcePaths" kindref="compound">ResourcePaths</ref>.<ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1ResourcePaths_1a46f3f60594cd615694fcfc4668340208" kindref="member">tokens</ref>();</highlight></codeline>
<codeline lineno="65"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="66"><highlight class="normal"></highlight></codeline>
<codeline lineno="67"><highlight class="normal"><sp/><sp/>Map&lt;String,<sp/>String&gt;<sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a272ad0e79bf27cc329efed48fab99164" kindref="member">optionalOAuthParams</ref>();</highlight></codeline>
<codeline lineno="68"><highlight class="normal"></highlight></codeline>
<codeline lineno="69" refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a3dbf7293538f9a2ec058587677c1c44a" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1ImmutableAuthConfig" kindref="compound">ImmutableAuthConfig</ref>.<ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1ImmutableAuthConfig_1_1Builder" kindref="compound">Builder</ref><sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1AuthConfig_1a3dbf7293538f9a2ec058587677c1c44a" kindref="member">builder</ref>()<sp/>{</highlight></codeline>
<codeline lineno="70"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1ImmutableAuthConfig" kindref="compound">ImmutableAuthConfig</ref>.<ref refid="classorg_1_1apache_1_1iceberg_1_1rest_1_1auth_1_1ImmutableAuthConfig_1a4791a744592d2ca0dc1abb0564a248df" kindref="member">builder</ref>();</highlight></codeline>
<codeline lineno="71"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="72"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="core/src/main/java/org/apache/iceberg/rest/auth/AuthConfig.java"/>
  </compounddef>
</doxygen>