| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_231) on Tue Jan 26 14:32:17 PST 2021 --> |
| <title>EncryptionManager</title> |
| <meta name="date" content="2021-01-26"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="EncryptionManager"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":18,"i2":18,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/iceberg/encryption/EncryptionKeyMetadatas.html" title="class in org.apache.iceberg.encryption"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/encryption/PlaintextEncryptionManager.html" title="class in org.apache.iceberg.encryption"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/encryption/EncryptionManager.html" target="_top">Frames</a></li> |
| <li><a href="EncryptionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg.encryption</div> |
| <h2 title="Interface EncryptionManager" class="title">Interface EncryptionManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/iceberg/encryption/PlaintextEncryptionManager.html" title="class in org.apache.iceberg.encryption">PlaintextEncryptionManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">EncryptionManager</span> |
| extends java.io.Serializable</pre> |
| <div class="block">Module for encrypting and decrypting table data files. |
| <p> |
| This must be serializable because an instance may be instantiated in one place and sent across |
| the wire in some Iceberg integrations, notably Spark.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/encryption/EncryptionManager.html#decrypt-org.apache.iceberg.encryption.EncryptedInputFile-">decrypt</a></span>(<a href="../../../../org/apache/iceberg/encryption/EncryptedInputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedInputFile</a> encrypted)</code> |
| <div class="block">Given an <a href="../../../../org/apache/iceberg/encryption/EncryptedInputFile.html#encryptedInputFile--"><code>EncryptedInputFile.encryptedInputFile()</code></a> representing the raw encrypted bytes |
| from the underlying file system, and given metadata about how the file was encrypted via |
| <a href="../../../../org/apache/iceberg/encryption/EncryptedInputFile.html#keyMetadata--"><code>EncryptedInputFile.keyMetadata()</code></a>, return an <a href="../../../../org/apache/iceberg/io/InputFile.html" title="interface in org.apache.iceberg.io"><code>InputFile</code></a> that returns decrypted |
| input streams.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default java.lang.Iterable<<a href="../../../../org/apache/iceberg/io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/encryption/EncryptionManager.html#decrypt-java.lang.Iterable-">decrypt</a></span>(java.lang.Iterable<<a href="../../../../org/apache/iceberg/encryption/EncryptedInputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedInputFile</a>> encrypted)</code> |
| <div class="block">Variant of <a href="../../../../org/apache/iceberg/encryption/EncryptionManager.html#decrypt-org.apache.iceberg.encryption.EncryptedInputFile-"><code>decrypt(EncryptedInputFile)</code></a> that provides a sequence of files that all |
| need to be decrypted in a single context.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default java.lang.Iterable<<a href="../../../../org/apache/iceberg/encryption/EncryptedOutputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedOutputFile</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/encryption/EncryptionManager.html#encrypt-java.lang.Iterable-">encrypt</a></span>(java.lang.Iterable<<a href="../../../../org/apache/iceberg/io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a>> rawOutput)</code> |
| <div class="block">Variant of <a href="../../../../org/apache/iceberg/encryption/EncryptionManager.html#encrypt-org.apache.iceberg.io.OutputFile-"><code>encrypt(OutputFile)</code></a> that provides a sequence of files that all need to be |
| encrypted in a single context.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/encryption/EncryptedOutputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedOutputFile</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/encryption/EncryptionManager.html#encrypt-org.apache.iceberg.io.OutputFile-">encrypt</a></span>(<a href="../../../../org/apache/iceberg/io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a> rawOutput)</code> |
| <div class="block">Given a handle on an <a href="../../../../org/apache/iceberg/io/OutputFile.html" title="interface in org.apache.iceberg.io"><code>OutputFile</code></a> that writes raw bytes to the underlying file system, |
| return a bundle of an <a href="../../../../org/apache/iceberg/encryption/EncryptedOutputFile.html#encryptingOutputFile--"><code>EncryptedOutputFile.encryptingOutputFile()</code></a> that writes encrypted |
| bytes to the underlying file system, and the <a href="../../../../org/apache/iceberg/encryption/EncryptedOutputFile.html#keyMetadata--"><code>EncryptedOutputFile.keyMetadata()</code></a> that |
| points to the encryption key that is being used to encrypt this file.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="decrypt-org.apache.iceberg.encryption.EncryptedInputFile-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decrypt</h4> |
| <pre><a href="../../../../org/apache/iceberg/io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a> decrypt(<a href="../../../../org/apache/iceberg/encryption/EncryptedInputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedInputFile</a> encrypted)</pre> |
| <div class="block">Given an <a href="../../../../org/apache/iceberg/encryption/EncryptedInputFile.html#encryptedInputFile--"><code>EncryptedInputFile.encryptedInputFile()</code></a> representing the raw encrypted bytes |
| from the underlying file system, and given metadata about how the file was encrypted via |
| <a href="../../../../org/apache/iceberg/encryption/EncryptedInputFile.html#keyMetadata--"><code>EncryptedInputFile.keyMetadata()</code></a>, return an <a href="../../../../org/apache/iceberg/io/InputFile.html" title="interface in org.apache.iceberg.io"><code>InputFile</code></a> that returns decrypted |
| input streams.</div> |
| </li> |
| </ul> |
| <a name="decrypt-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decrypt</h4> |
| <pre>default java.lang.Iterable<<a href="../../../../org/apache/iceberg/io/InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a>> decrypt(java.lang.Iterable<<a href="../../../../org/apache/iceberg/encryption/EncryptedInputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedInputFile</a>> encrypted)</pre> |
| <div class="block">Variant of <a href="../../../../org/apache/iceberg/encryption/EncryptionManager.html#decrypt-org.apache.iceberg.encryption.EncryptedInputFile-"><code>decrypt(EncryptedInputFile)</code></a> that provides a sequence of files that all |
| need to be decrypted in a single context. |
| <p> |
| By default this calls the single-file decryption method for each element in the iterator. |
| Implementations can override this for a variety of optimizations. For example, an |
| implementation can perform lookahead on the input iterator and fetch encryption keys in batch.</div> |
| </li> |
| </ul> |
| <a name="encrypt-org.apache.iceberg.io.OutputFile-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encrypt</h4> |
| <pre><a href="../../../../org/apache/iceberg/encryption/EncryptedOutputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedOutputFile</a> encrypt(<a href="../../../../org/apache/iceberg/io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a> rawOutput)</pre> |
| <div class="block">Given a handle on an <a href="../../../../org/apache/iceberg/io/OutputFile.html" title="interface in org.apache.iceberg.io"><code>OutputFile</code></a> that writes raw bytes to the underlying file system, |
| return a bundle of an <a href="../../../../org/apache/iceberg/encryption/EncryptedOutputFile.html#encryptingOutputFile--"><code>EncryptedOutputFile.encryptingOutputFile()</code></a> that writes encrypted |
| bytes to the underlying file system, and the <a href="../../../../org/apache/iceberg/encryption/EncryptedOutputFile.html#keyMetadata--"><code>EncryptedOutputFile.keyMetadata()</code></a> that |
| points to the encryption key that is being used to encrypt this file.</div> |
| </li> |
| </ul> |
| <a name="encrypt-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>encrypt</h4> |
| <pre>default java.lang.Iterable<<a href="../../../../org/apache/iceberg/encryption/EncryptedOutputFile.html" title="interface in org.apache.iceberg.encryption">EncryptedOutputFile</a>> encrypt(java.lang.Iterable<<a href="../../../../org/apache/iceberg/io/OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a>> rawOutput)</pre> |
| <div class="block">Variant of <a href="../../../../org/apache/iceberg/encryption/EncryptionManager.html#encrypt-org.apache.iceberg.io.OutputFile-"><code>encrypt(OutputFile)</code></a> that provides a sequence of files that all need to be |
| encrypted in a single context. |
| <p> |
| By default this calls the single-file encryption method for each element in the iterator. |
| Implementations can override this for a variety of optimizations. For example, an |
| implementation can perform lookahead on the input iterator and fetch encryption keys in batch.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/iceberg/encryption/EncryptionKeyMetadatas.html" title="class in org.apache.iceberg.encryption"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/encryption/PlaintextEncryptionManager.html" title="class in org.apache.iceberg.encryption"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/encryption/EncryptionManager.html" target="_top">Frames</a></li> |
| <li><a href="EncryptionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |