org.apache.hadoop.security.token

クラス Token<T extends TokenIdentifier>

java.lang.Object

org.apache.hadoop.security.token.Token<T>

すべての実装されたインタフェース:

Writable

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class Token<T extends TokenIdentifier>
extends Object
implements Writable

The client-side form of the token.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static org.apache.commons.logging.Log	LOG

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Token() Default constructor.
Token(byte[] identifier, byte[] password, Text kind, Text service) Construct a token from the components.
Token(org.apache.hadoop.security.proto.SecurityProtos.TokenProto tokenPB) Construct a Token from a TokenProto.
Token(Token<T> other) Clone a token.
Token(T id, SecretManager<T> mgr) Construct a token given a token identifier and a secret manager for the type of the token identifier.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	buildCacheKey()
void	cancel(Configuration conf) Cancel this delegation token.
Token<T>	copyToken()
void	decodeFromUrlString(String newValue) Decode the given url safe string into this token.
T	decodeIdentifier() Get the token identifier object, or null if it could not be constructed (because the class could not be loaded, for example).
String	encodeToUrlString() Encode this token as a url safe string.
boolean	equals(Object right)
byte[]	getIdentifier() Get the token identifier's byte representation.
Text	getKind() Get the token kind.
byte[]	getPassword() Get the token password/secret.
Text	getService() Get the service on which the token is supposed to be used.
int	hashCode()
boolean	isManaged() Is this token managed so that it can be renewed or cancelled?
void	readFields(DataInput in) Deserialize the fields of this object from in.
long	renew(Configuration conf) Renew this delegation token.
void	setService(Text newService) Set the service on which the token is supposed to be used.
String	toString()
org.apache.hadoop.security.proto.SecurityProtos.TokenProto	toTokenProto() Construct a TokenProto from this Token instance.
void	write(DataOutput out) Serialize the fields of this object to out.

クラスから継承されたメソッド java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

フィールドの詳細

LOG

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

コンストラクタの詳細

Token

public Token(T id,
             SecretManager<T> mgr)

Construct a token given a token identifier and a secret manager for the type of the token identifier.

パラメータ:

id - the token identifier

mgr - the secret manager

Token

public Token(byte[] identifier,
             byte[] password,
             Text kind,
             Text service)

Construct a token from the components.

パラメータ:

identifier - the token identifier

password - the token's password

kind - the kind of token

service - the service for this token

Token

public Token()

Default constructor.

Token

public Token(Token<T> other)

Clone a token.

パラメータ:

other - the token to clone

Token

public Token(org.apache.hadoop.security.proto.SecurityProtos.TokenProto tokenPB)

Construct a Token from a TokenProto.

パラメータ:

tokenPB - the TokenProto object

メソッドの詳細

copyToken

public Token<T> copyToken()

toTokenProto

public org.apache.hadoop.security.proto.SecurityProtos.TokenProto toTokenProto()

Construct a TokenProto from this Token instance.

戻り値:

a new TokenProto object holding copies of data in this instance

getIdentifier

public byte[] getIdentifier()

Get the token identifier's byte representation.

戻り値:

the token identifier's byte representation

decodeIdentifier

public T decodeIdentifier()
                   throws IOException

Get the token identifier object, or null if it could not be constructed (because the class could not be loaded, for example).

戻り値:

the token identifier, or null

例外:

IOException

getPassword

public byte[] getPassword()

Get the token password/secret.

戻り値:

the token password/secret

getKind

public Text getKind()

Get the token kind.

戻り値:

the kind of the token

getService

public Text getService()

Get the service on which the token is supposed to be used.

戻り値:

the service name

setService

public void setService(Text newService)

Set the service on which the token is supposed to be used.

パラメータ:

newService - the service name

readFields

public void readFields(DataInput in)
                throws IOException

インタフェースからコピーされた説明: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

定義:

readFields インタフェース内 Writable

パラメータ:

in - DataInput to deseriablize this object from.

例外:

IOException

write

public void write(DataOutput out)
           throws IOException

インタフェースからコピーされた説明: Writable

Serialize the fields of this object to out.

定義:

write インタフェース内 Writable

パラメータ:

out - DataOuput to serialize this object into.

例外:

IOException

encodeToUrlString

public String encodeToUrlString()
                         throws IOException

Encode this token as a url safe string.

戻り値:

the encoded string

例外:

IOException

decodeFromUrlString

public void decodeFromUrlString(String newValue)
                         throws IOException

Decode the given url safe string into this token.

パラメータ:

newValue - the encoded string

例外:

IOException

equals

public boolean equals(Object right)

オーバーライド:

equals クラス内 Object

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object

toString

public String toString()

オーバーライド:

toString クラス内 Object

buildCacheKey

public String buildCacheKey()

isManaged

public boolean isManaged()
                  throws IOException

Is this token managed so that it can be renewed or cancelled?

戻り値:

true, if it can be renewed and cancelled.

例外:

IOException

renew

public long renew(Configuration conf)
           throws IOException,
                  InterruptedException

Renew this delegation token.

戻り値:

the new expiration time

例外:

IOException

InterruptedException

cancel

public void cancel(Configuration conf)
            throws IOException,
                   InterruptedException

Cancel this delegation token.

例外:

IOException

InterruptedException