org.apache.hadoop.hive.thrift

Class DBTokenStore

java.lang.Object

org.apache.hadoop.hive.thrift.DBTokenStore

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.conf.Configurable, DelegationTokenStore

public class DBTokenStore
extends Object
implements DelegationTokenStore

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hive.thrift.DelegationTokenStore

DelegationTokenStore.TokenStoreException

Constructor Summary

Constructors

Constructor and Description
DBTokenStore()

Method Summary

Methods

Modifier and Type	Method and Description
int	addMasterKey(String s) Add new master key.
boolean	addToken(DelegationTokenIdentifier tokenIdentifier, org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation token) Add token.
void	close()
List<DelegationTokenIdentifier>	getAllDelegationTokenIdentifiers() List of all token identifiers in the store.
org.apache.hadoop.conf.Configuration	getConf()
String[]	getMasterKeys() Return all master keys.
org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation	getToken(DelegationTokenIdentifier tokenIdentifier) Get token.
void	init(Object rawStore, HadoopThriftAuthBridge.Server.ServerMode smode)
boolean	removeMasterKey(int keySeq) Remove key for given id.
boolean	removeToken(DelegationTokenIdentifier tokenIdentifier) Remove token.
void	setConf(org.apache.hadoop.conf.Configuration conf)
void	updateMasterKey(int keySeq, String s) Update master key (for expiration and setting store assigned sequence within key)

Methods inherited from class java.lang.Object

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

Constructor Detail

DBTokenStore

public DBTokenStore()

Method Detail

addMasterKey

public int addMasterKey(String s)
                 throws DelegationTokenStore.TokenStoreException

Description copied from interface: DelegationTokenStore

Add new master key. The token store assigns and returns the sequence number. Caller needs to use the identifier to update the key (since it is embedded in the key).

Specified by:

addMasterKey in interface DelegationTokenStore

Returns:

sequence number for new key

Throws:

DelegationTokenStore.TokenStoreException

updateMasterKey

public void updateMasterKey(int keySeq,
                   String s)
                     throws DelegationTokenStore.TokenStoreException

Description copied from interface: DelegationTokenStore

Update master key (for expiration and setting store assigned sequence within key)

Specified by:

updateMasterKey in interface DelegationTokenStore

Throws:

DelegationTokenStore.TokenStoreException

removeMasterKey

public boolean removeMasterKey(int keySeq)

Description copied from interface: DelegationTokenStore

Remove key for given id.

Specified by:

removeMasterKey in interface DelegationTokenStore

Returns:

false if key no longer present, true otherwise.

getMasterKeys

public String[] getMasterKeys()
                       throws DelegationTokenStore.TokenStoreException

Description copied from interface: DelegationTokenStore

Return all master keys.

Specified by:

getMasterKeys in interface DelegationTokenStore

Returns:

Throws:

DelegationTokenStore.TokenStoreException

addToken

public boolean addToken(DelegationTokenIdentifier tokenIdentifier,
               org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation token)
                 throws DelegationTokenStore.TokenStoreException

Description copied from interface: DelegationTokenStore

Add token. If identifier is already present, token won't be added.

Specified by:

addToken in interface DelegationTokenStore

Returns:

true if token was added, false for existing identifier

Throws:

DelegationTokenStore.TokenStoreException

getToken

public org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation getToken(DelegationTokenIdentifier tokenIdentifier)
                                                                                                                     throws DelegationTokenStore.TokenStoreException

Description copied from interface: DelegationTokenStore

Get token. Returns null if the token does not exist.

Specified by:

getToken in interface DelegationTokenStore

Returns:

Throws:

DelegationTokenStore.TokenStoreException

removeToken

public boolean removeToken(DelegationTokenIdentifier tokenIdentifier)
                    throws DelegationTokenStore.TokenStoreException

Description copied from interface: DelegationTokenStore

Remove token. Return value can be used by caller to detect concurrency.

Specified by:

removeToken in interface DelegationTokenStore

Returns:

true if token was removed, false if it was already removed.

Throws:

DelegationTokenStore.TokenStoreException

getAllDelegationTokenIdentifiers

public List<DelegationTokenIdentifier> getAllDelegationTokenIdentifiers()
                                                                 throws DelegationTokenStore.TokenStoreException

Description copied from interface: DelegationTokenStore

List of all token identifiers in the store. This is used to remove expired tokens and a potential scalability improvement would be to partition by master key id

Specified by:

getAllDelegationTokenIdentifiers in interface DelegationTokenStore

Returns:

Throws:

DelegationTokenStore.TokenStoreException

init

public void init(Object rawStore,
        HadoopThriftAuthBridge.Server.ServerMode smode)
          throws DelegationTokenStore.TokenStoreException

Specified by:

init in interface DelegationTokenStore

Parameters:

rawStore - ObjectStore used by DBTokenStore

smode - Indicate whether this is a metastore or hiveserver2 token store

Throws:

DelegationTokenStore.TokenStoreException

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

getConf

public org.apache.hadoop.conf.Configuration getConf()

Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException