blob: e20e36217d9520d3274924e6f9d3bbdaf8a3c55b [file] [log] [blame]
<!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_292) on Tue Jun 15 06:00:46 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SecretManager (Apache Hadoop Main 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<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="SecretManager (Apache Hadoop Main 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":9,"i3":6,"i4":9,"i5":10,"i6":10,"i7":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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="class-use/SecretManager.html">Use</a></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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/hadoop/security/token/Token.html" title="class in org.apache.hadoop.security.token"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/security/token/SecretManager.html" target="_top">Frames</a></li>
<li><a href="SecretManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.hadoop.security.token</div>
<h2 title="Class SecretManager" class="title">Class SecretManager&lt;T extends <a href="../../../../../org/apache/hadoop/security/token/TokenIdentifier.html" title="class in org.apache.hadoop.security.token">TokenIdentifier</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.security.token.SecretManager&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The type of the token identifier</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/hadoop/security/token/delegation/AbstractDelegationTokenSecretManager.html" title="class in org.apache.hadoop.security.token.delegation">AbstractDelegationTokenSecretManager</a>, <a href="../../../../../org/apache/hadoop/yarn/security/client/BaseClientToAMTokenSecretManager.html" title="class in org.apache.hadoop.yarn.security.client">BaseClientToAMTokenSecretManager</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Public
@InterfaceStability.Evolving
public abstract class <span class="typeNameLabel">SecretManager&lt;T extends <a href="../../../../../org/apache/hadoop/security/token/TokenIdentifier.html" title="class in org.apache.hadoop.security.token">TokenIdentifier</a>&gt;</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">The server-side secret manager for each token type.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#SecretManager--">SecretManager</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#checkAvailableForRead--">checkAvailableForRead</a></span>()</code>
<div class="block">No-op if the secret manager is available for reading tokens, throw a
StandbyException otherwise.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/apache/hadoop/security/token/SecretManager.html" title="type parameter in SecretManager">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#createIdentifier--">createIdentifier</a></span>()</code>
<div class="block">Create an empty token identifier.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#createPassword-byte:A-javax.crypto.SecretKey-">createPassword</a></span>(byte[]&nbsp;identifier,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/SecretKey.html?is-external=true" title="class or interface in javax.crypto">SecretKey</a>&nbsp;key)</code>
<div class="block">Compute HMAC of the identifier using the secret key and return the
output as password</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected abstract byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#createPassword-T-">createPassword</a></span>(<a href="../../../../../org/apache/hadoop/security/token/SecretManager.html" title="type parameter in SecretManager">T</a>&nbsp;identifier)</code>
<div class="block">Create the password for the given identifier.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/SecretKey.html?is-external=true" title="class or interface in javax.crypto">SecretKey</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#createSecretKey-byte:A-">createSecretKey</a></span>(byte[]&nbsp;key)</code>
<div class="block">Convert the byte[] to a secret key</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/SecretKey.html?is-external=true" title="class or interface in javax.crypto">SecretKey</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#generateSecret--">generateSecret</a></span>()</code>
<div class="block">Generate a new random secret key.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#retriableRetrievePassword-T-">retriableRetrievePassword</a></span>(<a href="../../../../../org/apache/hadoop/security/token/SecretManager.html" title="type parameter in SecretManager">T</a>&nbsp;identifier)</code>
<div class="block">The same functionality with <a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#retrievePassword-T-"><code>retrievePassword(T)</code></a>, except that this
method can throw a <code>RetriableException</code> or a <code>StandbyException</code>
to indicate that client can retry/failover the same operation because of
temporary issue on the server side.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#retrievePassword-T-">retrievePassword</a></span>(<a href="../../../../../org/apache/hadoop/security/token/SecretManager.html" title="type parameter in SecretManager">T</a>&nbsp;identifier)</code>
<div class="block">Retrieve the password for the given token identifier.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SecretManager--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SecretManager</h4>
<pre>public&nbsp;SecretManager()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createPassword-org.apache.hadoop.security.token.TokenIdentifier-">
<!-- -->
</a><a name="createPassword-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPassword</h4>
<pre>protected abstract&nbsp;byte[]&nbsp;createPassword(<a href="../../../../../org/apache/hadoop/security/token/SecretManager.html" title="type parameter in SecretManager">T</a>&nbsp;identifier)</pre>
<div class="block">Create the password for the given identifier.
identifier may be modified inside this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - the identifier to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new password</dd>
</dl>
</li>
</ul>
<a name="retrievePassword-org.apache.hadoop.security.token.TokenIdentifier-">
<!-- -->
</a><a name="retrievePassword-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrievePassword</h4>
<pre>public abstract&nbsp;byte[]&nbsp;retrievePassword(<a href="../../../../../org/apache/hadoop/security/token/SecretManager.html" title="type parameter in SecretManager">T</a>&nbsp;identifier)
throws org.apache.hadoop.security.token.SecretManager.InvalidToken</pre>
<div class="block">Retrieve the password for the given token identifier. Should check the date
or registry to make sure the token hasn't expired or been revoked. Returns
the relevant password.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - the identifier to validate</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the password to use</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code> - the token was invalid</dd>
</dl>
</li>
</ul>
<a name="retriableRetrievePassword-org.apache.hadoop.security.token.TokenIdentifier-">
<!-- -->
</a><a name="retriableRetrievePassword-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retriableRetrievePassword</h4>
<pre>public&nbsp;byte[]&nbsp;retriableRetrievePassword(<a href="../../../../../org/apache/hadoop/security/token/SecretManager.html" title="type parameter in SecretManager">T</a>&nbsp;identifier)
throws org.apache.hadoop.security.token.SecretManager.InvalidToken,
org.apache.hadoop.ipc.StandbyException,
org.apache.hadoop.ipc.RetriableException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">The same functionality with <a href="../../../../../org/apache/hadoop/security/token/SecretManager.html#retrievePassword-T-"><code>retrievePassword(T)</code></a>, except that this
method can throw a <code>RetriableException</code> or a <code>StandbyException</code>
to indicate that client can retry/failover the same operation because of
temporary issue on the server side.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - the identifier to validate</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the password to use</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code> - the token was invalid</dd>
<dd><code>org.apache.hadoop.ipc.StandbyException</code> - the server is in standby state, the client can
try other servers</dd>
<dd><code>org.apache.hadoop.ipc.RetriableException</code> - the token was invalid, and the server thinks
this may be a temporary issue and suggests the client to retry</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - to allow future exceptions to be added without breaking
compatibility</dd>
</dl>
</li>
</ul>
<a name="createIdentifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createIdentifier</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/apache/hadoop/security/token/SecretManager.html" title="type parameter in SecretManager">T</a>&nbsp;createIdentifier()</pre>
<div class="block">Create an empty token identifier.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the newly created empty token identifier</dd>
</dl>
</li>
</ul>
<a name="checkAvailableForRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAvailableForRead</h4>
<pre>public&nbsp;void&nbsp;checkAvailableForRead()
throws org.apache.hadoop.ipc.StandbyException</pre>
<div class="block">No-op if the secret manager is available for reading tokens, throw a
StandbyException otherwise.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.ipc.StandbyException</code> - if the secret manager is not available to read
tokens</dd>
</dl>
</li>
</ul>
<a name="generateSecret--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateSecret</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/SecretKey.html?is-external=true" title="class or interface in javax.crypto">SecretKey</a>&nbsp;generateSecret()</pre>
<div class="block">Generate a new random secret key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new key</dd>
</dl>
</li>
</ul>
<a name="createPassword-byte:A-javax.crypto.SecretKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPassword</h4>
<pre>public static&nbsp;byte[]&nbsp;createPassword(byte[]&nbsp;identifier,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/SecretKey.html?is-external=true" title="class or interface in javax.crypto">SecretKey</a>&nbsp;key)</pre>
<div class="block">Compute HMAC of the identifier using the secret key and return the
output as password</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - the bytes of the identifier</dd>
<dd><code>key</code> - the secret key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the bytes of the generated password</dd>
</dl>
</li>
</ul>
<a name="createSecretKey-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createSecretKey</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/javax/crypto/SecretKey.html?is-external=true" title="class or interface in javax.crypto">SecretKey</a>&nbsp;createSecretKey(byte[]&nbsp;key)</pre>
<div class="block">Convert the byte[] to a secret key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the byte[] to create a secret key from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the secret key</dd>
</dl>
</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="class-use/SecretManager.html">Use</a></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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/hadoop/security/token/Token.html" title="class in org.apache.hadoop.security.token"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/security/token/SecretManager.html" target="_top">Frames</a></li>
<li><a href="SecretManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>