Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-project-dist / hadoop-hdfs / build / source / hadoop-hdfs-project / hadoop-hdfs / target / api / org / apache / hadoop / hdfs / security / token / block / BlockPoolTokenSecretManager.html
blob: f838d81d1bf1ba56dde63d7375cc3668a85963b1 [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:06:39 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BlockPoolTokenSecretManager (Apache Hadoop HDFS 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="BlockPoolTokenSecretManager (Apache Hadoop HDFS 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/BlockPoolTokenSecretManager.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>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html" target="_top">Frames</a></li>
<li><a href="BlockPoolTokenSecretManager.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><a href="#nested.classes.inherited.from.class.org.apache.hadoop.security.token.SecretManager">Nested</a>&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.hdfs.security.token.block</div>
<h2 title="Class BlockPoolTokenSecretManager" class="title">Class BlockPoolTokenSecretManager</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;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hdfs.security.token.block.BlockPoolTokenSecretManager</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">BlockPoolTokenSecretManager</span>
extends org.apache.hadoop.security.token.SecretManager&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;</pre>
<div class="block">Manages a <code>BlockTokenSecretManager</code> per block pool. Routes the requests
given a block pool Id to corresponding <code>BlockTokenSecretManager</code></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.security.token.SecretManager">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.hadoop.security.token.SecretManager</h3>
<code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code></li>
</ul>
</li>
</ul>
<!-- ======== 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/hdfs/security/token/block/BlockPoolTokenSecretManager.html#BlockPoolTokenSecretManager--">BlockPoolTokenSecretManager</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="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>
</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/hdfs/security/token/block/BlockPoolTokenSecretManager.html#addBlockPool-java.lang.String-org.apache.hadoop.hdfs.security.token.block.BlockTokenSecretManager-">addBlockPool</a></span>(<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>&nbsp;bpid,
org.apache.hadoop.hdfs.security.token.block.BlockTokenSecretManager&nbsp;secretMgr)</code>
<div class="block">Add a block pool Id and corresponding <code>BlockTokenSecretManager</code> to map</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#addKeys-java.lang.String-org.apache.hadoop.hdfs.security.token.block.ExportedBlockKeys-">addKeys</a></span>(<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>&nbsp;bpid,
org.apache.hadoop.hdfs.security.token.block.ExportedBlockKeys&nbsp;exportedKeys)</code>
<div class="block">See <code>BlockTokenSecretManager.addKeys(ExportedBlockKeys)</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#checkAccess-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-">checkAccess</a></span>(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;id,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode)</code>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(BlockTokenIdentifier,
String, ExtendedBlock, BlockTokenIdentifier.AccessMode)</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#checkAccess-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-org.apache.hadoop.fs.StorageType:A-">checkAccess</a></span>(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;id,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode,
org.apache.hadoop.fs.StorageType[]&nbsp;storageTypes)</code>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(BlockTokenIdentifier,
String, ExtendedBlock, BlockTokenIdentifier.AccessMode,
StorageType[])</code></div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#checkAccess-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-org.apache.hadoop.fs.StorageType:A-java.lang.String:A-">checkAccess</a></span>(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;id,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode,
org.apache.hadoop.fs.StorageType[]&nbsp;storageTypes,
<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>[]&nbsp;storageIds)</code>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(BlockTokenIdentifier,
String, ExtendedBlock, BlockTokenIdentifier.AccessMode,
StorageType[], String[])</code></div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#checkAccess-org.apache.hadoop.security.token.Token-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-">checkAccess</a></span>(org.apache.hadoop.security.token.Token&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;&nbsp;token,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode)</code>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(Token, String,
ExtendedBlock, BlockTokenIdentifier.AccessMode)</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#checkAccess-org.apache.hadoop.security.token.Token-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-org.apache.hadoop.fs.StorageType:A-java.lang.String:A-">checkAccess</a></span>(org.apache.hadoop.security.token.Token&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;&nbsp;token,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode,
org.apache.hadoop.fs.StorageType[]&nbsp;storageTypes,
<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>[]&nbsp;storageIds)</code>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(Token, String,
ExtendedBlock, BlockTokenIdentifier.AccessMode,
StorageType[], String[])</code></div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#clearAllKeysForTesting--">clearAllKeysForTesting</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#createIdentifier--">createIdentifier</a></span>()</code>
<div class="block">Return an empty BlockTokenIdentifer</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#createPassword-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-">createPassword</a></span>(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;identifier)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.hdfs.security.token.block.DataEncryptionKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#generateDataEncryptionKey-java.lang.String-">generateDataEncryptionKey</a></span>(<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>&nbsp;blockPoolId)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.security.token.Token&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#generateToken-org.apache.hadoop.hdfs.protocol.ExtendedBlock-java.util.EnumSet-org.apache.hadoop.fs.StorageType:A-java.lang.String:A-">generateToken</a></span>(org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;b,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&gt;&nbsp;of,
org.apache.hadoop.fs.StorageType[]&nbsp;storageTypes,
<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>[]&nbsp;storageIds)</code>
<div class="block">See <code>BlockTokenSecretManager.generateToken(ExtendedBlock, EnumSet,
StorageType[], String[])</code>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.hdfs.security.token.block.BlockTokenSecretManager</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#get-java.lang.String-">get</a></span>(<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>&nbsp;bpid)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#isBlockPoolRegistered-java.lang.String-">isBlockPoolRegistered</a></span>(<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>&nbsp;bpid)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#retrieveDataEncryptionKey-int-java.lang.String-byte:A-">retrieveDataEncryptionKey</a></span>(int&nbsp;keyId,
<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>&nbsp;blockPoolId,
byte[]&nbsp;nonce)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html#retrievePassword-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-">retrievePassword</a></span>(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;identifier)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.security.token.SecretManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.security.token.SecretManager</h3>
<code>checkAvailableForRead, createPassword, createSecretKey, generateSecret, retriableRetrievePassword</code></li>
</ul>
<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="BlockPoolTokenSecretManager--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BlockPoolTokenSecretManager</h4>
<pre>public&nbsp;BlockPoolTokenSecretManager()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addBlockPool-java.lang.String-org.apache.hadoop.hdfs.security.token.block.BlockTokenSecretManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addBlockPool</h4>
<pre>public&nbsp;void&nbsp;addBlockPool(<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>&nbsp;bpid,
org.apache.hadoop.hdfs.security.token.block.BlockTokenSecretManager&nbsp;secretMgr)</pre>
<div class="block">Add a block pool Id and corresponding <code>BlockTokenSecretManager</code> to map</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bpid</code> - block pool Id</dd>
<dd><code>secretMgr</code> - <code>BlockTokenSecretManager</code></dd>
</dl>
</li>
</ul>
<a name="get-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;org.apache.hadoop.hdfs.security.token.block.BlockTokenSecretManager&nbsp;get(<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>&nbsp;bpid)</pre>
</li>
</ul>
<a name="isBlockPoolRegistered-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBlockPoolRegistered</h4>
<pre>public&nbsp;boolean&nbsp;isBlockPoolRegistered(<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>&nbsp;bpid)</pre>
</li>
</ul>
<a name="createIdentifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createIdentifier</h4>
<pre>public&nbsp;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;createIdentifier()</pre>
<div class="block">Return an empty BlockTokenIdentifer</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>createIdentifier</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.security.token.SecretManager&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;</code></dd>
</dl>
</li>
</ul>
<a name="createPassword-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPassword</h4>
<pre>public&nbsp;byte[]&nbsp;createPassword(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;identifier)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>createPassword</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.security.token.SecretManager&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;</code></dd>
</dl>
</li>
</ul>
<a name="retrievePassword-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrievePassword</h4>
<pre>public&nbsp;byte[]&nbsp;retrievePassword(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;identifier)
throws org.apache.hadoop.security.token.SecretManager.InvalidToken</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>retrievePassword</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.security.token.SecretManager&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code></dd>
</dl>
</li>
</ul>
<a name="checkAccess-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-org.apache.hadoop.fs.StorageType:A-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAccess</h4>
<pre>public&nbsp;void&nbsp;checkAccess(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;id,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode,
org.apache.hadoop.fs.StorageType[]&nbsp;storageTypes,
<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>[]&nbsp;storageIds)
throws org.apache.hadoop.security.token.SecretManager.InvalidToken</pre>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(BlockTokenIdentifier,
String, ExtendedBlock, BlockTokenIdentifier.AccessMode,
StorageType[], String[])</code></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code></dd>
</dl>
</li>
</ul>
<a name="checkAccess-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-org.apache.hadoop.fs.StorageType:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAccess</h4>
<pre>public&nbsp;void&nbsp;checkAccess(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;id,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode,
org.apache.hadoop.fs.StorageType[]&nbsp;storageTypes)
throws org.apache.hadoop.security.token.SecretManager.InvalidToken</pre>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(BlockTokenIdentifier,
String, ExtendedBlock, BlockTokenIdentifier.AccessMode,
StorageType[])</code></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code></dd>
</dl>
</li>
</ul>
<a name="checkAccess-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAccess</h4>
<pre>public&nbsp;void&nbsp;checkAccess(org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&nbsp;id,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode)
throws org.apache.hadoop.security.token.SecretManager.InvalidToken</pre>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(BlockTokenIdentifier,
String, ExtendedBlock, BlockTokenIdentifier.AccessMode)</code>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code></dd>
</dl>
</li>
</ul>
<a name="checkAccess-org.apache.hadoop.security.token.Token-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAccess</h4>
<pre>public&nbsp;void&nbsp;checkAccess(org.apache.hadoop.security.token.Token&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;&nbsp;token,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode)
throws org.apache.hadoop.security.token.SecretManager.InvalidToken</pre>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(Token, String,
ExtendedBlock, BlockTokenIdentifier.AccessMode)</code>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code></dd>
</dl>
</li>
</ul>
<a name="checkAccess-org.apache.hadoop.security.token.Token-java.lang.String-org.apache.hadoop.hdfs.protocol.ExtendedBlock-org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode-org.apache.hadoop.fs.StorageType:A-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAccess</h4>
<pre>public&nbsp;void&nbsp;checkAccess(org.apache.hadoop.security.token.Token&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;&nbsp;token,
<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>&nbsp;userId,
org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;block,
org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&nbsp;mode,
org.apache.hadoop.fs.StorageType[]&nbsp;storageTypes,
<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>[]&nbsp;storageIds)
throws org.apache.hadoop.security.token.SecretManager.InvalidToken</pre>
<div class="block">See <code>BlockTokenSecretManager.checkAccess(Token, String,
ExtendedBlock, BlockTokenIdentifier.AccessMode,
StorageType[], String[])</code></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.token.SecretManager.InvalidToken</code></dd>
</dl>
</li>
</ul>
<a name="addKeys-java.lang.String-org.apache.hadoop.hdfs.security.token.block.ExportedBlockKeys-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addKeys</h4>
<pre>public&nbsp;void&nbsp;addKeys(<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>&nbsp;bpid,
org.apache.hadoop.hdfs.security.token.block.ExportedBlockKeys&nbsp;exportedKeys)
throws <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">See <code>BlockTokenSecretManager.addKeys(ExportedBlockKeys)</code>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<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></dd>
</dl>
</li>
</ul>
<a name="generateToken-org.apache.hadoop.hdfs.protocol.ExtendedBlock-java.util.EnumSet-org.apache.hadoop.fs.StorageType:A-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateToken</h4>
<pre>public&nbsp;org.apache.hadoop.security.token.Token&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier&gt;&nbsp;generateToken(org.apache.hadoop.hdfs.protocol.ExtendedBlock&nbsp;b,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;org.apache.hadoop.hdfs.security.token.block.BlockTokenIdentifier.AccessMode&gt;&nbsp;of,
org.apache.hadoop.fs.StorageType[]&nbsp;storageTypes,
<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>[]&nbsp;storageIds)
throws <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">See <code>BlockTokenSecretManager.generateToken(ExtendedBlock, EnumSet,
StorageType[], String[])</code>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<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></dd>
</dl>
</li>
</ul>
<a name="clearAllKeysForTesting--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearAllKeysForTesting</h4>
<pre>public&nbsp;void&nbsp;clearAllKeysForTesting()</pre>
</li>
</ul>
<a name="generateDataEncryptionKey-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateDataEncryptionKey</h4>
<pre>public&nbsp;org.apache.hadoop.hdfs.security.token.block.DataEncryptionKey&nbsp;generateDataEncryptionKey(<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>&nbsp;blockPoolId)</pre>
</li>
</ul>
<a name="retrieveDataEncryptionKey-int-java.lang.String-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>retrieveDataEncryptionKey</h4>
<pre>public&nbsp;byte[]&nbsp;retrieveDataEncryptionKey(int&nbsp;keyId,
<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>&nbsp;blockPoolId,
byte[]&nbsp;nonce)
throws <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>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<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></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/BlockPoolTokenSecretManager.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>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/hdfs/security/token/block/BlockPoolTokenSecretManager.html" target="_top">Frames</a></li>
<li><a href="BlockPoolTokenSecretManager.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><a href="#nested.classes.inherited.from.class.org.apache.hadoop.security.token.SecretManager">Nested</a>&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; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>