Token (Apache Hadoop Main 3.3.0-SNAPSHOT API)

java.lang.Object
- org.apache.hadoop.security.token.Token<T>

All Implemented Interfaces:: Writable

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

The client-side form of the token.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Token.TrivialRenewer
A trivial renewer for token kinds that aren't managed.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Token.TrivialRenewer` A trivial renewer for token kinds that aren't managed.

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Logger LOG

Fields
Modifier and Type	Field and Description
`static org.slf4j.Logger`	`LOG`

Constructor Summary

Constructors
Constructor and Description
`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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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[]`	`getDnHandshakeSecret()`
`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?
`boolean`	`isPrivate()` Whether this is a private token.
`boolean`	`isPrivateCloneOf(Text thePublicService)` Whether this is a private clone of a public token.
`Token<T>`	`privateClone(Text newService)` Create a private clone of a public token.
`void`	`readFields(DataInput in)` Deserialize the fields of this object from `in`.
`long`	`renew(Configuration conf)` Renew this delegation token.
`void`	`setDNHandshakeSecret(byte[] secret)`
`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`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
public static final org.slf4j.Logger LOG
```
- Constructor Detail
  - 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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    other - the token to clone
  - Token
```
public Token(org.apache.hadoop.security.proto.SecurityProtos.TokenProto tokenPB)
```
    Construct a Token from a TokenProto.
    
    Parameters:
    
    tokenPB - the TokenProto object
- Method Detail
  - copyToken
```
public Token<T> copyToken()
```
  - toTokenProto
```
public org.apache.hadoop.security.proto.SecurityProtos.TokenProto toTokenProto()
```
    Construct a TokenProto from this Token instance.
    
    Returns:
    
    a new TokenProto object holding copies of data in this instance
  - getIdentifier
```
public byte[] getIdentifier()
```
    Get the token identifier's byte representation.
    
    Returns:
    
    the token identifier's byte representation
  - getDnHandshakeSecret
```
public byte[] getDnHandshakeSecret()
```
  - setDNHandshakeSecret
```
public void setDNHandshakeSecret(byte[] secret)
```
  - 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).
    
    Returns:
    
    the token identifier, or null if there was no class found for it
    
    Throws:
    
    IOException - failure to unmarshall the data
    
    RuntimeException - if the token class could not be instantiated.
  - getPassword
```
public byte[] getPassword()
```
    Get the token password/secret.
    
    Returns:
    
    the token password/secret
  - getKind
```
public Text getKind()
```
    Get the token kind.
    
    Returns:
    
    the kind of the token
  - getService
```
public Text getService()
```
    Get the service on which the token is supposed to be used.
    
    Returns:
    
    the service name
  - setService
```
public void setService(Text newService)
```
    Set the service on which the token is supposed to be used.
    
    Parameters:
    
    newService - the service name
  - isPrivate
```
public boolean isPrivate()
```
    Whether this is a private token.
    
    Returns:
    
    false always for non-private tokens
  - isPrivateCloneOf
```
public boolean isPrivateCloneOf(Text thePublicService)
```
    Whether this is a private clone of a public token.
    
    Parameters:
    
    thePublicService - the public service name
    
    Returns:
    
    false always for non-private tokens
  - privateClone
```
public Token<T> privateClone(Text newService)
```
    Create a private clone of a public token.
    
    Parameters:
    
    newService - the new service name
    
    Returns:
    
    a private token
  - readFields
```
public void readFields(DataInput in)
                throws IOException
```
    Description copied from interface: Writable
    
    Deserialize the fields of this object from in.
    For efficiency, implementations should attempt to re-use storage in the existing object where possible.
    
    Specified by:
    
    readFields in interface Writable
    
    Parameters:
    
    in - DataInput to deseriablize this object from.
    
    Throws:
    
    IOException
  - write
```
public void write(DataOutput out)
           throws IOException
```
    Description copied from interface: Writable
    
    Serialize the fields of this object to out.
    
    Specified by:
    
    write in interface Writable
    
    Parameters:
    
    out - DataOuput to serialize this object into.
    
    Throws:
    
    IOException
  - encodeToUrlString
```
public String encodeToUrlString()
                         throws IOException
```
    Encode this token as a url safe string.
    
    Returns:
    
    the encoded string
    
    Throws:
    
    IOException
  - decodeFromUrlString
```
public void decodeFromUrlString(String newValue)
                         throws IOException
```
    Decode the given url safe string into this token.
    
    Parameters:
    
    newValue - the encoded string
    
    Throws:
    
    IOException
  - equals
```
public boolean equals(Object right)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - buildCacheKey
```
public String buildCacheKey()
```
  - isManaged
```
public boolean isManaged()
                  throws IOException
```
    Is this token managed so that it can be renewed or cancelled?
    
    Returns:
    
    true, if it can be renewed and cancelled.
    
    Throws:
    
    IOException
  - renew
```
public long renew(Configuration conf)
           throws IOException,
                  InterruptedException
```
    Renew this delegation token.
    
    Returns:
    
    the new expiration time
    
    Throws:
    
    IOException
    
    InterruptedException
  - cancel
```
public void cancel(Configuration conf)
            throws IOException,
                   InterruptedException
```
    Cancel this delegation token.
    
    Throws:
    
    IOException
    
    InterruptedException

Class Token<T extends TokenIdentifier>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

Constructor Detail

Token

Token

Token

Token

Token

Method Detail

copyToken

toTokenProto

getIdentifier

getDnHandshakeSecret

setDNHandshakeSecret

decodeIdentifier

getPassword

getKind

getService

setService

isPrivate

isPrivateCloneOf

privateClone

readFields

write

encodeToUrlString

decodeFromUrlString

equals

hashCode

toString

buildCacheKey

isManaged

renew

cancel