Package org.apache.hadoop.mapreduce.v2.hs

Class HistoryServerStateStoreService

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.mapreduce.v2.hs.HistoryServerStateStoreService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.service.Service

Direct Known Subclasses:

HistoryServerFileSystemStateStoreService, HistoryServerLeveldbStateStoreService, HistoryServerNullStateStoreService

@Private
@Unstable
public abstract class HistoryServerStateStoreService
extends org.apache.hadoop.service.AbstractService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HistoryServerStateStoreService.HistoryServerState

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Constructor Summary

Constructors

Constructor	Description
HistoryServerStateStoreService()

Method Summary

Modifier and Type	Method	Description
protected abstract void	closeStorage()	Implementation-specific shutdown.
protected abstract void	initStorage(org.apache.hadoop.conf.Configuration conf)	Implementation-specific initialization.
abstract HistoryServerStateStoreService.HistoryServerState	loadState()	Load the history server state from the state storage.
abstract void	removeToken(org.apache.hadoop.mapreduce.v2.api.MRDelegationTokenIdentifier tokenId)	Blocking method to remove a delegation token from the state storage.
abstract void	removeTokenMasterKey(org.apache.hadoop.security.token.delegation.DelegationKey key)	Blocking method to remove a delegation token master key.
void	serviceInit(org.apache.hadoop.conf.Configuration conf)	Initialize the state storage
void	serviceStart()	Start the state storage for use
void	serviceStop()	Shutdown the state storage.
protected abstract void	startStorage()	Implementation-specific startup.
abstract void	storeToken(org.apache.hadoop.mapreduce.v2.api.MRDelegationTokenIdentifier tokenId, java.lang.Long renewDate)	Blocking method to store a delegation token along with the current token sequence number to the state storage.
abstract void	storeTokenMasterKey(org.apache.hadoop.security.token.delegation.DelegationKey key)	Blocking method to store a delegation token master key.
abstract void	updateToken(org.apache.hadoop.mapreduce.v2.api.MRDelegationTokenIdentifier tokenId, java.lang.Long renewDate)	Blocking method to update the expiration of a delegation token in the state storage.

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryServerStateStoreService

public HistoryServerStateStoreService()

Method Detail

serviceInit

public void serviceInit(org.apache.hadoop.conf.Configuration conf)
                 throws java.io.IOException

Initialize the state storage

Overrides:

serviceInit in class org.apache.hadoop.service.AbstractService

Parameters:

conf - the configuration

Throws:

java.io.IOException

serviceStart

public void serviceStart()
                  throws java.io.IOException

Start the state storage for use

Overrides:

serviceStart in class org.apache.hadoop.service.AbstractService

Throws:

java.io.IOException

serviceStop

public void serviceStop()
                 throws java.io.IOException

Shutdown the state storage.

Overrides:

serviceStop in class org.apache.hadoop.service.AbstractService

Throws:

java.io.IOException

initStorage

protected abstract void initStorage(org.apache.hadoop.conf.Configuration conf)
                             throws java.io.IOException

Implementation-specific initialization.

Parameters:

conf - the configuration

Throws:

java.io.IOException

startStorage

protected abstract void startStorage()
                              throws java.io.IOException

Implementation-specific startup.

Throws:

java.io.IOException

closeStorage

protected abstract void closeStorage()
                              throws java.io.IOException

Implementation-specific shutdown.

Throws:

java.io.IOException

loadState

public abstract HistoryServerStateStoreService.HistoryServerState loadState()
                                                                     throws java.io.IOException

Load the history server state from the state storage.

Throws:

java.io.IOException

storeToken

public abstract void storeToken(org.apache.hadoop.mapreduce.v2.api.MRDelegationTokenIdentifier tokenId,
                                java.lang.Long renewDate)
                         throws java.io.IOException

Blocking method to store a delegation token along with the current token sequence number to the state storage. Implementations must not return from this method until the token has been committed to the state store.

Parameters:

tokenId - the token to store

renewDate - the token renewal deadline

Throws:

java.io.IOException

updateToken

public abstract void updateToken(org.apache.hadoop.mapreduce.v2.api.MRDelegationTokenIdentifier tokenId,
                                 java.lang.Long renewDate)
                          throws java.io.IOException

Blocking method to update the expiration of a delegation token in the state storage. Implementations must not return from this method until the expiration date of the token has been updated in the state store.

Parameters:

tokenId - the token to update

renewDate - the new token renewal deadline

Throws:

java.io.IOException

removeToken

public abstract void removeToken(org.apache.hadoop.mapreduce.v2.api.MRDelegationTokenIdentifier tokenId)
                          throws java.io.IOException

Blocking method to remove a delegation token from the state storage. Implementations must not return from this method until the token has been removed from the state store.

Parameters:

tokenId - the token to remove

Throws:

java.io.IOException

storeTokenMasterKey

public abstract void storeTokenMasterKey(org.apache.hadoop.security.token.delegation.DelegationKey key)
                                  throws java.io.IOException

Blocking method to store a delegation token master key. Implementations must not return from this method until the key has been committed to the state store.

Parameters:

key - the master key to store

Throws:

java.io.IOException

removeTokenMasterKey

public abstract void removeTokenMasterKey(org.apache.hadoop.security.token.delegation.DelegationKey key)
                                   throws java.io.IOException

Blocking method to remove a delegation token master key. Implementations must not return from this method until the key has been removed from the state store.

Parameters:

key - the master key to remove

Throws:

java.io.IOException