org.apache.hadoop.hdfs.security.token.block

类 BlockTokenSecretManager

java.lang.Object

org.apache.hadoop.security.token.SecretManager<BlockTokenIdentifier>

org.apache.hadoop.hdfs.security.token.block.BlockTokenSecretManager

public class BlockTokenSecretManager
extends SecretManager<BlockTokenIdentifier>

BlockTokenSecretManager can be instantiated in 2 modes, master mode and slave mode. Master can generate new block keys and export block keys to slaves, while slaves can only import and use block keys received from master. Both master and slave can generate and verify block tokens. Typically, master mode is used by NN and slave mode is used by DN.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	BlockTokenSecretManager.AccessMode

从类继承的嵌套类/接口 org.apache.hadoop.security.token.SecretManager

SecretManager.InvalidToken

字段概要

字段

限定符和类型	字段和说明
static Token<BlockTokenIdentifier>	DUMMY_TOKEN
static org.apache.commons.logging.Log	LOG

构造器概要

构造器

构造器和说明
BlockTokenSecretManager(boolean isMaster, long keyUpdateInterval, long tokenLifetime) Constructor

方法概要

方法

限定符和类型	方法和说明
void	checkAccess(BlockTokenIdentifier id, String userId, Block block, BlockTokenSecretManager.AccessMode mode) Check if access should be allowed. userID is not checked if null.
void	checkAccess(Token<BlockTokenIdentifier> token, String userId, Block block, BlockTokenSecretManager.AccessMode mode) Check if access should be allowed. userID is not checked if null
BlockTokenIdentifier	createIdentifier() Create an empty block token identifier
protected byte[]	createPassword(BlockTokenIdentifier identifier) Create a new password/secret for the given block token identifier.
ExportedBlockKeys	exportKeys() Export block keys, only to be used in master mode
Token<BlockTokenIdentifier>	generateToken(Block block, EnumSet<BlockTokenSecretManager.AccessMode> modes) Generate an block token for current user
Token<BlockTokenIdentifier>	generateToken(long[] blockIds, EnumSet<BlockTokenSecretManager.AccessMode> modes) Generate a block token for the current user based on a collection of blockIds
Token<BlockTokenIdentifier>	generateToken(String userId, Block block, EnumSet<BlockTokenSecretManager.AccessMode> modes) Generate a block token for a specified user
Token<BlockTokenIdentifier>	generateToken(String userID, long[] blockIds, EnumSet<BlockTokenSecretManager.AccessMode> modes) Generate a block token based on a collection of blockIds
byte[]	retrievePassword(BlockTokenIdentifier identifier) Look up the token password/secret for the given block token identifier.
void	setKeys(ExportedBlockKeys exportedKeys) Set block keys, only to be used in slave mode
void	setTokenLifetime(long tokenLifetime) set token lifetime.
void	updateKeys() Update block keys, only to be used in master mode

从类继承的方法 org.apache.hadoop.security.token.SecretManager

createPassword, createSecretKey, generateSecret

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

LOG

public static final org.apache.commons.logging.Log LOG

DUMMY_TOKEN

public static final Token<BlockTokenIdentifier> DUMMY_TOKEN

构造器详细资料

BlockTokenSecretManager

public BlockTokenSecretManager(boolean isMaster,
                       long keyUpdateInterval,
                       long tokenLifetime)
                        throws IOException

Constructor

参数:

isMaster -

keyUpdateInterval -

tokenLifetime -

抛出:

IOException

方法详细资料

exportKeys

public ExportedBlockKeys exportKeys()

Export block keys, only to be used in master mode

setKeys

public void setKeys(ExportedBlockKeys exportedKeys)
             throws IOException

Set block keys, only to be used in slave mode

抛出:

IOException

updateKeys

public void updateKeys()
                throws IOException

Update block keys, only to be used in master mode

抛出:

IOException

generateToken

public Token<BlockTokenIdentifier> generateToken(Block block,
                                        EnumSet<BlockTokenSecretManager.AccessMode> modes)
                                          throws IOException

Generate an block token for current user

抛出:

IOException

generateToken

public Token<BlockTokenIdentifier> generateToken(String userId,
                                        Block block,
                                        EnumSet<BlockTokenSecretManager.AccessMode> modes)
                                          throws IOException

Generate a block token for a specified user

抛出:

IOException

generateToken

public Token<BlockTokenIdentifier> generateToken(long[] blockIds,
                                        EnumSet<BlockTokenSecretManager.AccessMode> modes)
                                          throws IOException

Generate a block token for the current user based on a collection of blockIds

抛出:

IOException

generateToken

public Token<BlockTokenIdentifier> generateToken(String userID,
                                        long[] blockIds,
                                        EnumSet<BlockTokenSecretManager.AccessMode> modes)

Generate a block token based on a collection of blockIds

checkAccess

public void checkAccess(BlockTokenIdentifier id,
               String userId,
               Block block,
               BlockTokenSecretManager.AccessMode mode)
                 throws SecretManager.InvalidToken

Check if access should be allowed. userID is not checked if null. This method doesn't check if token password is correct. It should be used only when token password has already been verified (e.g., in the RPC layer).

抛出:

SecretManager.InvalidToken

checkAccess

public void checkAccess(Token<BlockTokenIdentifier> token,
               String userId,
               Block block,
               BlockTokenSecretManager.AccessMode mode)
                 throws SecretManager.InvalidToken

Check if access should be allowed. userID is not checked if null

抛出:

SecretManager.InvalidToken

setTokenLifetime

public void setTokenLifetime(long tokenLifetime)

set token lifetime.

createIdentifier

public BlockTokenIdentifier createIdentifier()

Create an empty block token identifier

指定者:

createIdentifier 在类中 SecretManager<BlockTokenIdentifier>

返回:

a newly created empty block token identifier

createPassword

protected byte[] createPassword(BlockTokenIdentifier identifier)

Create a new password/secret for the given block token identifier.

指定者:

createPassword 在类中 SecretManager<BlockTokenIdentifier>

参数:

identifier - the block token identifier

返回:

token password/secret

retrievePassword

public byte[] retrievePassword(BlockTokenIdentifier identifier)
                        throws SecretManager.InvalidToken

Look up the token password/secret for the given block token identifier.

指定者:

retrievePassword 在类中 SecretManager<BlockTokenIdentifier>

参数:

identifier - the block token identifier to look up

返回:

token password/secret as byte[]

抛出:

InvalidToken

SecretManager.InvalidToken