Skip to content

Commit

Permalink
tink-awskms-HEAD-SNAPSHOT Javadoc auto-pushed to gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Tink Team committed Mar 18, 2024
1 parent beac205 commit 14586ce
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 51 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":41,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
Expand Down Expand Up @@ -178,7 +178,7 @@ <h3>Constructor Summary</h3>
</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
Expand All @@ -195,12 +195,7 @@ <h3>Method Summary</h3>
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/integration/awskms/AwsKmsClient.html#register-java.util.Optional-java.util.Optional-">register</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;keyUri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;credentialPath)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">It is preferable to not register KMS clients. Instead, create the AwsKmsClient
yourself and call <code>getAead</code> to get a remote <code>Aead</code>. Use this <code>Aead</code> to
encrypt a keyset for with <code>TinkProtoKeysetFormat.serializeEncryptedKeyset</code>, or to
create an envelope <code>Aead</code> using <code>KmsEnvelopeAead.create</code>.</span></div>
</div>
<div class="block">Creates and registers a <a href="../../../../../../com/google/crypto/tink/integration/awskms/AwsKmsClient.html#AwsKmsClient-java.lang.String-"><code>AwsKmsClient(java.lang.String)</code></a> with the Tink runtime.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
Expand Down Expand Up @@ -399,21 +394,21 @@ <h4>getAead</h4>
<ul class="blockListLast">
<li class="blockList">
<h4>register</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;void&nbsp;register(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;keyUri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;credentialPath)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html?is-external=true" title="class or interface in java.security">GeneralSecurityException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">It is preferable to not register KMS clients. Instead, create the AwsKmsClient
yourself and call <code>getAead</code> to get a remote <code>Aead</code>. Use this <code>Aead</code> to
encrypt a keyset for with <code>TinkProtoKeysetFormat.serializeEncryptedKeyset</code>, or to
create an envelope <code>Aead</code> using <code>KmsEnvelopeAead.create</code>.</span></div>
<pre>public static&nbsp;void&nbsp;register(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;keyUri,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;credentialPath)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html?is-external=true" title="class or interface in java.security">GeneralSecurityException</a></pre>
<div class="block">Creates and registers a <a href="../../../../../../com/google/crypto/tink/integration/awskms/AwsKmsClient.html#AwsKmsClient-java.lang.String-"><code>AwsKmsClient(java.lang.String)</code></a> with the Tink runtime.

<p>If <code>keyUri</code> is present, it is the only key that the new client will support. Otherwise
the new client supports all AWS KMS keys.

<p>If <code>credentialPath</code> is present, load the credentials from that. Otherwise use the
default credentials.</div>
default credentials.

<p>In many cases, it is not necessary to register the client. For example, you can create the
AwsKmsClient yourself and call <a href="../../../../../../com/google/crypto/tink/integration/awskms/AwsKmsClient.html#getAead-java.lang.String-"><code>getAead(java.lang.String)</code></a> to get a remote <code>Aead</code>. Use
this <code>Aead</code> to encrypt a keyset for with <code>TinkProtoKeysetFormat.serializeEncryptedKeyset</code>, or to create an envelope <code>Aead</code> using
<code>KmsEnvelopeAead.create</code>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html?is-external=true" title="class or interface in java.security">GeneralSecurityException</a></code></dd>
Expand Down
27 changes: 0 additions & 27 deletions javadoc/tink-awskms/HEAD-SNAPSHOT/deprecated-list.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,33 +70,6 @@
<div class="header">
<h1 title="Deprecated API" class="title">Deprecated API</h1>
<h2 title="Contents">Contents</h2>
<ul>
<li><a href="#method">Deprecated Methods</a></li>
</ul>
</div>
<div class="contentContainer"><a name="method">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<table class="deprecatedSummary" border="0" cellpadding="3" cellspacing="0" summary="Deprecated Methods table, listing deprecated methods, and an explanation">
<caption><span>Deprecated Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="com/google/crypto/tink/integration/awskms/AwsKmsClient.html#register-java.util.Optional-java.util.Optional-">com.google.crypto.tink.integration.awskms.AwsKmsClient.register(Optional&lt;String&gt;, Optional&lt;String&gt;)</a>
<div class="block"><span class="deprecationComment">It is preferable to not register KMS clients. Instead, create the AwsKmsClient
yourself and call <code>getAead</code> to get a remote <code>Aead</code>. Use this <code>Aead</code> to
encrypt a keyset for with <code>TinkProtoKeysetFormat.serializeEncryptedKeyset</code>, or to
create an envelope <code>Aead</code> using <code>KmsEnvelopeAead.create</code>.</span></div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
Expand Down
7 changes: 1 addition & 6 deletions javadoc/tink-awskms/HEAD-SNAPSHOT/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,7 @@ <h2 class="title">R</h2>
<dl>
<dt><span class="memberNameLink"><a href="com/google/crypto/tink/integration/awskms/AwsKmsClient.html#register-java.util.Optional-java.util.Optional-">register(Optional&lt;String&gt;, Optional&lt;String&gt;)</a></span> - Static method in class com.google.crypto.tink.integration.awskms.<a href="com/google/crypto/tink/integration/awskms/AwsKmsClient.html" title="class in com.google.crypto.tink.integration.awskms">AwsKmsClient</a></dt>
<dd>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">It is preferable to not register KMS clients. Instead, create the AwsKmsClient
yourself and call <code>getAead</code> to get a remote <code>Aead</code>. Use this <code>Aead</code> to
encrypt a keyset for with <code>TinkProtoKeysetFormat.serializeEncryptedKeyset</code>, or to
create an envelope <code>Aead</code> using <code>KmsEnvelopeAead.create</code>.</span></div>
</div>
<div class="block">Creates and registers a <a href="com/google/crypto/tink/integration/awskms/AwsKmsClient.html#AwsKmsClient-java.lang.String-"><code>AwsKmsClient(java.lang.String)</code></a> with the Tink runtime.</div>
</dd>
</dl>
<a name="I:W">
Expand Down

0 comments on commit 14586ce

Please sign in to comment.