javadoc/1.2.0/org/apache/iceberg/encryption/KmsClient.html - iceberg - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>KmsClient</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="KmsClient";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":50,"i1":38,"i2":50,"i3":38,"i4":38};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 var pathtoroot = "../../../../";
 var useModuleDirectories = true;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.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" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg.encryption</a></div>
 <h2 title="Interface KmsClient" class="title">Interface KmsClient</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><code>java.io.Serializable</code></dd>
 </dl>
 <hr>
 <pre>@Deprecated
 public interface <span class="typeNameLabel">KmsClient</span>
 extends java.io.Serializable</pre>
 <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
 <div class="deprecationComment">the API will be removed in v2.0.0 (replaced with KeyManagementClient interface).</div>
 </div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="nested.class.summary">
 <!--   -->
 </a>
 <h3>Nested Class Summary</h3>
 <table class="memberSummary">
 <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Interface</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="KmsClient.KeyGenerationResult.html" title="class in org.apache.iceberg.encryption">KmsClient.KeyGenerationResult</a></span></code></th>
 <td class="colLast">
 <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">For KMS systems that support key generation, this class keeps the key generation result - the
  raw secret key, and its wrap.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ========== METHOD SUMMARY =========== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>default <a href="KmsClient.KeyGenerationResult.html" title="class in org.apache.iceberg.encryption">KmsClient.KeyGenerationResult</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateKey(java.lang.String)">generateKey</a></span>&#8203;(java.lang.String&nbsp;wrappingKeyId)</code></th>
 <td class="colLast">
 <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Generate a new secret key in the KMS server, and wrap it using a wrapping/master key which is
  stored in KMS and referenced by an ID.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(java.util.Map)">initialize</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;properties)</code></th>
 <td class="colLast">
 <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Initialize the KMS client with given properties</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>default boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supportsKeyGeneration()">supportsKeyGeneration</a></span>()</code></th>
 <td class="colLast">
 <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Some KMS systems support generation of secret keys inside the KMS server.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>java.nio.ByteBuffer</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unwrapKey(java.lang.String,java.lang.String)">unwrapKey</a></span>&#8203;(java.lang.String&nbsp;wrappedKey,
          java.lang.String&nbsp;wrappingKeyId)</code></th>
 <td class="colLast">
 <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Unwrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an
  ID.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapKey(java.nio.ByteBuffer,java.lang.String)">wrapKey</a></span>&#8203;(java.nio.ByteBuffer&nbsp;key,
        java.lang.String&nbsp;wrappingKeyId)</code></th>
 <td class="colLast">
 <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Wrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="wrapKey(java.nio.ByteBuffer,java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>wrapKey</h4>
 <pre class="methodSignature">java.lang.String&nbsp;wrapKey&#8203;(java.nio.ByteBuffer&nbsp;key,
                          java.lang.String&nbsp;wrappingKeyId)</pre>
 <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Wrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID.
  Wrapping means encryption of the secret key with the master key, and adding optional
  KMS-specific metadata that allows the KMS to decrypt the secret key in an unwrapping call.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>key</code> - a secret key being wrapped</dd>
 <dd><code>wrappingKeyId</code> - a key ID that represents a wrapping key stored in KMS</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>wrapped key material</dd>
 </dl>
 </li>
 </ul>
 <a id="supportsKeyGeneration()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>supportsKeyGeneration</h4>
 <pre class="methodSignature">default&nbsp;boolean&nbsp;supportsKeyGeneration()</pre>
 <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Some KMS systems support generation of secret keys inside the KMS server.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if KMS server supports key generation and KmsClient implementation is interested
      to leverage this capability. Otherwise, return false - Iceberg will then generate secret
      keys locally (using the SecureRandom mechanism) and call <a href="#wrapKey(java.nio.ByteBuffer,java.lang.String)"><code>wrapKey(ByteBuffer,
      String)</code></a> to wrap them in KMS.</dd>
 </dl>
 </li>
 </ul>
 <a id="generateKey(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>generateKey</h4>
 <pre class="methodSignature">default&nbsp;<a href="KmsClient.KeyGenerationResult.html" title="class in org.apache.iceberg.encryption">KmsClient.KeyGenerationResult</a>&nbsp;generateKey&#8203;(java.lang.String&nbsp;wrappingKeyId)</pre>
 <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Generate a new secret key in the KMS server, and wrap it using a wrapping/master key which is
  stored in KMS and referenced by an ID. This method will be called only if supportsKeyGeneration
  returns true.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>wrappingKeyId</code> - a key ID that represents a wrapping key stored in KMS</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>key in two forms: raw, and wrapped with the given wrappingKeyId</dd>
 </dl>
 </li>
 </ul>
 <a id="unwrapKey(java.lang.String,java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>unwrapKey</h4>
 <pre class="methodSignature">java.nio.ByteBuffer&nbsp;unwrapKey&#8203;(java.lang.String&nbsp;wrappedKey,
                               java.lang.String&nbsp;wrappingKeyId)</pre>
 <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Unwrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an
  ID.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>wrappedKey</code> - wrapped key material (encrypted key and optional KMS metadata, returned by
      the wrapKey method)</dd>
 <dd><code>wrappingKeyId</code> - a key ID that represents a wrapping key stored in KMS</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>raw key bytes</dd>
 </dl>
 </li>
 </ul>
 <a id="initialize(java.util.Map)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>initialize</h4>
 <pre class="methodSignature">void&nbsp;initialize&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;properties)</pre>
 <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
 <div class="block">Initialize the KMS client with given properties</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>properties</code> - kms client properties</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.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" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.html">All&nbsp;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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 </footer>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>KmsClient</title>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
	<script type="text/javascript" src="../../../../script.js"></script>
	<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
	<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
	<!--[if IE]>
	<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
	<![endif]-->
	<script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
	<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="KmsClient";
	}
	}
	catch(err) {
	}
	//-->
	var data = {"i0":50,"i1":38,"i2":50,"i3":38,"i4":38};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	var pathtoroot = "../../../../";
	var useModuleDirectories = true;
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<header role="banner">
	<nav role="navigation">
	<div class="fixedNav">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a id="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.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" id="allclasses_navbar_top">
	<li><a href="../../../../allclasses.html">All Classes</a></li>
	</ul>
	<ul class="navListSearch">
	<li><label for="search">SEARCH:</label>
	<input type="text" id="search" value="search" disabled="disabled">
	<input type="reset" id="reset" value="reset" disabled="disabled">
	</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>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li><a href="#nested.class.summary">Nested</a> \| </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 id="skip.navbar.top">
	<!-- -->
	</a></div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	</div>
	<div class="navPadding"> </div>
	<script type="text/javascript"><!--
	$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
	//-->
	</script>
	</nav>
	</header>
	<!-- ======== START OF CLASS DATA ======== -->
	<main role="main">
	<div class="header">
	<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.iceberg.encryption</a></div>
	<h2 title="Interface KmsClient" class="title">Interface KmsClient</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<dl>
	<dt>All Superinterfaces:</dt>
	<dd><code>java.io.Serializable</code></dd>
	</dl>
	<hr>
	<pre>@Deprecated
	public interface <span class="typeNameLabel">KmsClient</span>
	extends java.io.Serializable</pre>
	<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
	<div class="deprecationComment">the API will be removed in v2.0.0 (replaced with KeyManagementClient interface).</div>
	</div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ======== NESTED CLASS SUMMARY ======== -->
	<section>
	<ul class="blockList">
	<li class="blockList"><a id="nested.class.summary">
	<!-- -->
	</a>
	<h3>Nested Class Summary</h3>
	<table class="memberSummary">
	<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Interface</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>static class </code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="KmsClient.KeyGenerationResult.html" title="class in org.apache.iceberg.encryption">KmsClient.KeyGenerationResult</a></span></code></th>
	<td class="colLast">
	<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">For KMS systems that support key generation, this class keeps the key generation result - the
	raw secret key, and its wrap.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</section>
	<!-- ========== METHOD SUMMARY =========== -->
	<section>
	<ul class="blockList">
	<li class="blockList"><a id="method.summary">
	<!-- -->
	</a>
	<h3>Method Summary</h3>
	<table class="memberSummary">
	<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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Method</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code>default <a href="KmsClient.KeyGenerationResult.html" title="class in org.apache.iceberg.encryption">KmsClient.KeyGenerationResult</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateKey(java.lang.String)">generateKey</a></span>(java.lang.String wrappingKeyId)</code></th>
	<td class="colLast">
	<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Generate a new secret key in the KMS server, and wrap it using a wrapping/master key which is
	stored in KMS and referenced by an ID.</div>
	</td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>void</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(java.util.Map)">initialize</a></span>(java.util.Map<java.lang.String,java.lang.String> properties)</code></th>
	<td class="colLast">
	<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Initialize the KMS client with given properties</div>
	</td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code>default boolean</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#supportsKeyGeneration()">supportsKeyGeneration</a></span>()</code></th>
	<td class="colLast">
	<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Some KMS systems support generation of secret keys inside the KMS server.</div>
	</td>
	</tr>
	<tr id="i3" class="rowColor">
	<td class="colFirst"><code>java.nio.ByteBuffer</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unwrapKey(java.lang.String,java.lang.String)">unwrapKey</a></span>(java.lang.String wrappedKey,
	java.lang.String wrappingKeyId)</code></th>
	<td class="colLast">
	<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Unwrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an
	ID.</div>
	</td>
	</tr>
	<tr id="i4" class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapKey(java.nio.ByteBuffer,java.lang.String)">wrapKey</a></span>(java.nio.ByteBuffer key,
	java.lang.String wrappingKeyId)</code></th>
	<td class="colLast">
	<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Wrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ METHOD DETAIL ========== -->
	<section>
	<ul class="blockList">
	<li class="blockList"><a id="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a id="wrapKey(java.nio.ByteBuffer,java.lang.String)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>wrapKey</h4>
	<pre class="methodSignature">java.lang.String wrapKey(java.nio.ByteBuffer key,
	java.lang.String wrappingKeyId)</pre>
	<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Wrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an ID.
	Wrapping means encryption of the secret key with the master key, and adding optional
	KMS-specific metadata that allows the KMS to decrypt the secret key in an unwrapping call.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>key</code> - a secret key being wrapped</dd>
	<dd><code>wrappingKeyId</code> - a key ID that represents a wrapping key stored in KMS</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>wrapped key material</dd>
	</dl>
	</li>
	</ul>
	<a id="supportsKeyGeneration()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>supportsKeyGeneration</h4>
	<pre class="methodSignature">default boolean supportsKeyGeneration()</pre>
	<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Some KMS systems support generation of secret keys inside the KMS server.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>true if KMS server supports key generation and KmsClient implementation is interested
	to leverage this capability. Otherwise, return false - Iceberg will then generate secret
	keys locally (using the SecureRandom mechanism) and call <a href="#wrapKey(java.nio.ByteBuffer,java.lang.String)"><code>wrapKey(ByteBuffer,
	String)</code></a> to wrap them in KMS.</dd>
	</dl>
	</li>
	</ul>
	<a id="generateKey(java.lang.String)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>generateKey</h4>
	<pre class="methodSignature">default <a href="KmsClient.KeyGenerationResult.html" title="class in org.apache.iceberg.encryption">KmsClient.KeyGenerationResult</a> generateKey(java.lang.String wrappingKeyId)</pre>
	<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Generate a new secret key in the KMS server, and wrap it using a wrapping/master key which is
	stored in KMS and referenced by an ID. This method will be called only if supportsKeyGeneration
	returns true.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>wrappingKeyId</code> - a key ID that represents a wrapping key stored in KMS</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>key in two forms: raw, and wrapped with the given wrappingKeyId</dd>
	</dl>
	</li>
	</ul>
	<a id="unwrapKey(java.lang.String,java.lang.String)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>unwrapKey</h4>
	<pre class="methodSignature">java.nio.ByteBuffer unwrapKey(java.lang.String wrappedKey,
	java.lang.String wrappingKeyId)</pre>
	<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Unwrap a secret key, using a wrapping/master key which is stored in KMS and referenced by an
	ID.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>wrappedKey</code> - wrapped key material (encrypted key and optional KMS metadata, returned by
	the wrapKey method)</dd>
	<dd><code>wrappingKeyId</code> - a key ID that represents a wrapping key stored in KMS</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>raw key bytes</dd>
	</dl>
	</li>
	</ul>
	<a id="initialize(java.util.Map)">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>initialize</h4>
	<pre class="methodSignature">void initialize(java.util.Map<java.lang.String,java.lang.String> properties)</pre>
	<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
	<div class="block">Initialize the KMS client with given properties</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>properties</code> - kms client properties</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	</div>
	</main>
	<!-- ========= END OF CLASS DATA ========= -->
	<footer role="contentinfo">
	<nav role="navigation">
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a id="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
	<li><a href="../../../../allclasses.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>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li><a href="#nested.class.summary">Nested</a> \| </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 id="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</nav>
	</footer>
	</body>
	</html>