Evaluate/projects/iceberg/java/doxygen_doc/xml/AesGcmInputFile_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="AesGcmInputFile_8java" kind="file" language="Java">
    <compoundname>AesGcmInputFile.java</compoundname>
    <innerclass refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile" prot="public">org::apache::iceberg::encryption::AesGcmInputFile</innerclass>
    <innernamespace refid="namespaceorg_1_1apache_1_1iceberg_1_1encryption">org::apache::iceberg::encryption</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.encryption;</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/><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_1io" kindref="compound">io</ref>.<ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile" kindref="compound">InputFile</ref>;</highlight></codeline>
<codeline lineno="22"><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_1io" kindref="compound">io</ref>.<ref refid="classorg_1_1apache_1_1iceberg_1_1io_1_1SeekableInputStream" kindref="compound">SeekableInputStream</ref>;</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>.relocated.com.google.<ref refid="namespaceorg_1_1apache_1_1iceberg_1_1common" kindref="compound">common</ref>.base.<ref refid="classorg_1_1apache_1_1iceberg_1_1relocated_1_1com_1_1google_1_1common_1_1base_1_1Preconditions" kindref="compound">Preconditions</ref>;</highlight></codeline>
<codeline lineno="24"><highlight class="normal"></highlight></codeline>
<codeline lineno="25" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile" kindref="compound">AesGcmInputFile</ref><sp/></highlight><highlight class="keyword">implements</highlight><highlight class="normal"><sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile" kindref="compound">InputFile</ref><sp/>{</highlight></codeline>
<codeline lineno="26" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">final</highlight><highlight class="normal"><sp/><ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile" kindref="compound">InputFile</ref><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" kindref="member">sourceFile</ref>;</highlight></codeline>
<codeline lineno="27" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a8f45496053d5d73f7ada0dffc0af7cd8" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">final</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">byte</highlight><highlight class="normal">[]<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a8f45496053d5d73f7ada0dffc0af7cd8" kindref="member">dataKey</ref>;</highlight></codeline>
<codeline lineno="28" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a33390acf092d644b53a353cf6209fff1" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">final</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">byte</highlight><highlight class="normal">[]<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a33390acf092d644b53a353cf6209fff1" kindref="member">fileAADPrefix</ref>;</highlight></codeline>
<codeline lineno="29" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a47468f8f78387d34141b1779794b19cf" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">long</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a47468f8f78387d34141b1779794b19cf" kindref="member">plaintextLength</ref>;</highlight></codeline>
<codeline lineno="30"><highlight class="normal"></highlight></codeline>
<codeline lineno="31" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a8054600a7c6e975d184e29861e73ba31" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a8054600a7c6e975d184e29861e73ba31" kindref="member">AesGcmInputFile</ref>(<ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile" kindref="compound">InputFile</ref><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" kindref="member">sourceFile</ref>,<sp/></highlight><highlight class="keywordtype">byte</highlight><highlight class="normal">[]<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a8f45496053d5d73f7ada0dffc0af7cd8" kindref="member">dataKey</ref>,<sp/></highlight><highlight class="keywordtype">byte</highlight><highlight class="normal">[]<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a33390acf092d644b53a353cf6209fff1" kindref="member">fileAADPrefix</ref>)<sp/>{</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/>this.sourceFile<sp/>=<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" kindref="member">sourceFile</ref>;</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/>this.dataKey<sp/>=<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a8f45496053d5d73f7ada0dffc0af7cd8" kindref="member">dataKey</ref>;</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/>this.fileAADPrefix<sp/>=<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a33390acf092d644b53a353cf6209fff1" kindref="member">fileAADPrefix</ref>;</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/>this.plaintextLength<sp/>=<sp/>-1;</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="37"><highlight class="normal"></highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/>@Override</highlight></codeline>
<codeline lineno="39" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a4135ca12c3592606e9aa9d2ed5284451" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">long</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a4135ca12c3592606e9aa9d2ed5284451" kindref="member">getLength</ref>()<sp/>{</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(<ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a47468f8f78387d34141b1779794b19cf" kindref="member">plaintextLength</ref><sp/>==<sp/>-1)<sp/>{</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>Presumes<sp/>all<sp/>streams<sp/>use<sp/>hard-coded<sp/>plaintext<sp/>block<sp/>size.</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a47468f8f78387d34141b1779794b19cf" kindref="member">plaintextLength</ref><sp/>=<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputStream" kindref="compound">AesGcmInputStream</ref>.calculatePlaintextLength(<ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" kindref="member">sourceFile</ref>.<ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile_1a18c808c06e4150b26ce6a19195cf68dc" kindref="member">getLength</ref>());</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="44"><highlight class="normal"></highlight></codeline>
<codeline lineno="45"><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_1encryption_1_1AesGcmInputFile_1a47468f8f78387d34141b1779794b19cf" kindref="member">plaintextLength</ref>;</highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="47"><highlight class="normal"></highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/>@Override</highlight></codeline>
<codeline lineno="49" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a85870c7d074f30bbf3f5a036eaf62b83" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1io_1_1SeekableInputStream" kindref="compound">SeekableInputStream</ref><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a85870c7d074f30bbf3f5a036eaf62b83" kindref="member">newStream</ref>()<sp/>{</highlight></codeline>
<codeline lineno="50"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">long</highlight><highlight class="normal"><sp/>ciphertextLength<sp/>=<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" kindref="member">sourceFile</ref>.<ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile_1a18c808c06e4150b26ce6a19195cf68dc" kindref="member">getLength</ref>();</highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/>Preconditions.checkState(</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>ciphertextLength<sp/>&gt;=<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1Ciphers" kindref="compound">Ciphers</ref>.MIN_STREAM_LENGTH,</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;Invalid<sp/>encrypted<sp/>stream:<sp/>%d<sp/>is<sp/>shorter<sp/>than<sp/>the<sp/>minimum<sp/>possible<sp/>stream<sp/>length&quot;</highlight><highlight class="normal">,</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>ciphertextLength);</highlight></codeline>
<codeline lineno="55"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">new</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputStream" kindref="compound">AesGcmInputStream</ref>(<ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" kindref="member">sourceFile</ref>.<ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile_1ab7df9d86933a5957f118029c3323e8af" kindref="member">newStream</ref>(),<sp/>ciphertextLength,<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a8f45496053d5d73f7ada0dffc0af7cd8" kindref="member">dataKey</ref>,<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a33390acf092d644b53a353cf6209fff1" kindref="member">fileAADPrefix</ref>);</highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="57"><highlight class="normal"></highlight></codeline>
<codeline lineno="58"><highlight class="normal"><sp/><sp/>@Override</highlight></codeline>
<codeline lineno="59" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a7bb24d346dd9ea72a24be23c8ed7271a" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/>String<sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1a7bb24d346dd9ea72a24be23c8ed7271a" kindref="member">location</ref>()<sp/>{</highlight></codeline>
<codeline lineno="60"><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_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" kindref="member">sourceFile</ref>.<ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile_1a2efb068d80de4323e27a2d4699a7ce7b" kindref="member">location</ref>();</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="62"><highlight class="normal"></highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/>@Override</highlight></codeline>
<codeline lineno="64" refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1aa7b4912b8d3b9135ffa22baa5ba68f53" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">boolean</highlight><highlight class="normal"><sp/><ref refid="classorg_1_1apache_1_1iceberg_1_1encryption_1_1AesGcmInputFile_1aa7b4912b8d3b9135ffa22baa5ba68f53" kindref="member">exists</ref>()<sp/>{</highlight></codeline>
<codeline lineno="65"><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_1encryption_1_1AesGcmInputFile_1ae58e5a33cf8d62d7beb9d48914b6c99a" kindref="member">sourceFile</ref>.<ref refid="interfaceorg_1_1apache_1_1iceberg_1_1io_1_1InputFile_1a5e9046803bc7ef318c00159a3fb9d5b8" kindref="member">exists</ref>();</highlight></codeline>
<codeline lineno="66"><highlight class="normal"><sp/><sp/>}</highlight></codeline>
<codeline lineno="67"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="core/src/main/java/org/apache/iceberg/encryption/AesGcmInputFile.java"/>
  </compounddef>
</doxygen>