Package org.apache.hadoop.yarn.server.federation.store.impl

Class MemoryFederationStateStore

java.lang.Object

org.apache.hadoop.yarn.server.federation.store.impl.MemoryFederationStateStore

All Implemented Interfaces:

FederationApplicationHomeSubClusterStore, FederationDelegationTokenStateStore, FederationMembershipStateStore, FederationPolicyStore, FederationReservationHomeSubClusterStore, FederationStateStore

public class MemoryFederationStateStore
extends Object
implements FederationStateStore

In-memory implementation of FederationStateStore.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
MemoryFederationStateStore()

Method Summary

Modifier and Type	Method	Description
AddApplicationHomeSubClusterResponse	addApplicationHomeSubCluster(AddApplicationHomeSubClusterRequest request)	Register the home SubClusterId of the newly submitted ApplicationId.
AddReservationHomeSubClusterResponse	addReservationHomeSubCluster(AddReservationHomeSubClusterRequest request)	Register the home SubClusterId of the newly submitted ReservationId.
void	close()	Perform any cleanup operations of the StateStore.
DeletePoliciesConfigurationsResponse	deleteAllPoliciesConfigurations(DeletePoliciesConfigurationsRequest request)	Delete all queue-to-policy configurations.
DeleteApplicationHomeSubClusterResponse	deleteApplicationHomeSubCluster(DeleteApplicationHomeSubClusterRequest request)	Delete the mapping of home SubClusterId of a previously submitted ApplicationId.
DeleteSubClusterPoliciesConfigurationsResponse	deletePoliciesConfigurations(DeleteSubClusterPoliciesConfigurationsRequest request)	Delete PoliciesConfigurations.
DeleteReservationHomeSubClusterResponse	deleteReservationHomeSubCluster(DeleteReservationHomeSubClusterRequest request)	Delete the mapping of home SubClusterId of a previously submitted ReservationId.
void	deleteStateStore()	We will clear the data in stateStore through the deleteStateStore method.
SubClusterDeregisterResponse	deregisterSubCluster(SubClusterDeregisterRequest request)	Deregister a subcluster identified by SubClusterId to change state in federation.
GetApplicationHomeSubClusterResponse	getApplicationHomeSubCluster(GetApplicationHomeSubClusterRequest request)	Get information about the application identified by the input ApplicationId.
GetApplicationsHomeSubClusterResponse	getApplicationsHomeSubCluster(GetApplicationsHomeSubClusterRequest request)	Get the ApplicationHomeSubCluster list representing the mapping of all submitted applications to it's home sub-cluster.
int	getCurrentKeyId()	The Router Supports getCurrentKeyId.
Version	getCurrentVersion()	Get the Version of the underlying federation state store client.
int	getDelegationTokenSeqNum()	The Router Supports getDelegationTokenSeqNum.
RouterMasterKeyResponse	getMasterKeyByDelegationKey(RouterMasterKeyRequest request)	The Router Supports GetMasterKeyByDelegationKey.
Map<SubClusterId,SubClusterInfo>	getMembership()
GetSubClusterPoliciesConfigurationsResponse	getPoliciesConfigurations(GetSubClusterPoliciesConfigurationsRequest request)	Get a map of all queue-to-policy configurations.
GetSubClusterPolicyConfigurationResponse	getPolicyConfiguration(GetSubClusterPolicyConfigurationRequest request)	Get the policy configuration for a given queue.
GetReservationHomeSubClusterResponse	getReservationHomeSubCluster(GetReservationHomeSubClusterRequest request)	Get information about the Reservation identified by the input ReservationId.
GetReservationsHomeSubClusterResponse	getReservationsHomeSubCluster(GetReservationsHomeSubClusterRequest request)	Get the ReservationHomeSubCluster list representing the mapping of all submitted Reservations to it's home sub-cluster.
RouterRMDTSecretManagerState	getRouterRMSecretManagerState()
GetSubClusterInfoResponse	getSubCluster(GetSubClusterInfoRequest request)	Get the membership information of subcluster as identified by SubClusterId.
GetSubClustersInfoResponse	getSubClusters(GetSubClustersInfoRequest request)	Get the membership information of all the subclusters that are currently participating in federation.
RouterRMTokenResponse	getTokenByRouterStoreToken(RouterRMTokenRequest request)	The Router Supports GetTokenByRouterStoreToken.
int	incrementCurrentKeyId()	The Router Supports incrementCurrentKeyId.
int	incrementDelegationTokenSeqNum()	The Router Supports incrementDelegationTokenSeqNum.
void	init(org.apache.hadoop.conf.Configuration conf)	Initialize the FederationStore.
Version	loadVersion()	Load the version information from the federation state store.
SubClusterRegisterResponse	registerSubCluster(SubClusterRegisterRequest request)	Register a subcluster by publishing capabilities as represented by SubClusterInfo to indicate participation in federation.
RouterMasterKeyResponse	removeStoredMasterKey(RouterMasterKeyRequest request)	The Router Supports Remove MasterKey.
RouterRMTokenResponse	removeStoredToken(RouterRMTokenRequest request)	The Router Supports Remove RMDelegationTokenIdentifier.
void	setApplicationContext(String subClusterId, org.apache.hadoop.yarn.api.records.ApplicationId applicationId, long createTime)
void	setDelegationTokenSeqNum(int seqNum)	The Router Supports setDelegationTokenSeqNum.
void	setExpiredHeartbeat(SubClusterId subClusterId, long heartBearTime)
void	setMembership(Map<SubClusterId,SubClusterInfo> membership)
SetSubClusterPolicyConfigurationResponse	setPolicyConfiguration(SetSubClusterPolicyConfigurationRequest request)	Set the policy configuration for a given queue.
void	setSubClusterLastHeartbeat(SubClusterId subClusterId, long lastHeartbeat)
RouterMasterKeyResponse	storeNewMasterKey(RouterMasterKeyRequest request)	The Router Supports Store NewMasterKey.
RouterRMTokenResponse	storeNewToken(RouterRMTokenRequest request)	The Router Supports Store RMDelegationTokenIdentifier.
void	storeVersion()	Store the Version information in federation state store.
SubClusterHeartbeatResponse	subClusterHeartbeat(SubClusterHeartbeatRequest request)	Periodic heartbeat from a ResourceManager participating in federation to indicate liveliness.
UpdateApplicationHomeSubClusterResponse	updateApplicationHomeSubCluster(UpdateApplicationHomeSubClusterRequest request)	Update the home SubClusterId of a previously submitted ApplicationId.
UpdateReservationHomeSubClusterResponse	updateReservationHomeSubCluster(UpdateReservationHomeSubClusterRequest request)	Update the home SubClusterId of a previously submitted ReservationId.
RouterRMTokenResponse	updateStoredToken(RouterRMTokenRequest request)	The Router Supports Update RMDelegationTokenIdentifier.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.yarn.server.federation.store.FederationStateStore

checkVersion

Field Details

LOG

public static final org.slf4j.Logger LOG

Constructor Details

MemoryFederationStateStore

public MemoryFederationStateStore()

Method Details

init

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

Description copied from interface: FederationStateStore

Initialize the FederationStore.

Specified by:

init in interface FederationStateStore

Parameters:

conf - the cluster configuration

close

public void close()

Description copied from interface: FederationStateStore

Perform any cleanup operations of the StateStore.

Specified by:

close in interface FederationStateStore

registerSubCluster

public SubClusterRegisterResponse registerSubCluster(SubClusterRegisterRequest request)
                                              throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationMembershipStateStore

Register a subcluster by publishing capabilities as represented by SubClusterInfo to indicate participation in federation. This is typically done during initialization or restart/failover of the subcluster's ResourceManager. Upon successful registration, an identifier for the subcluster which is unique across the federated cluster is returned. The identifier is static, i.e. preserved across restarts and failover.

Specified by:

registerSubCluster in interface FederationMembershipStateStore

Parameters:

request - the capabilities of the subcluster that wants to participate in federation. The subcluster id is also specified in case registration is triggered by restart/failover

Returns:

response empty on successfully if registration was successful

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

deregisterSubCluster

public SubClusterDeregisterResponse deregisterSubCluster(SubClusterDeregisterRequest request)
                                                  throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationMembershipStateStore

Deregister a subcluster identified by SubClusterId to change state in federation. This can be done to mark the sub cluster lost, deregistered, or decommissioned.

Specified by:

deregisterSubCluster in interface FederationMembershipStateStore

Parameters:

request - - the request to deregister the sub-cluster from federation.

Returns:

response empty on successfully deregistering the subcluster state

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

subClusterHeartbeat

public SubClusterHeartbeatResponse subClusterHeartbeat(SubClusterHeartbeatRequest request)
                                                throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationMembershipStateStore

Periodic heartbeat from a ResourceManager participating in federation to indicate liveliness. The heartbeat publishes the current capabilities as represented by SubClusterInfo of the subcluster. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure.

Specified by:

subClusterHeartbeat in interface FederationMembershipStateStore

Parameters:

request - the capabilities of the subcluster that wants to keep alive its participation in federation

Returns:

response currently empty on if heartbeat was successfully processed

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

setSubClusterLastHeartbeat

@VisibleForTesting
public void setSubClusterLastHeartbeat(SubClusterId subClusterId,
 long lastHeartbeat)
                                throws org.apache.hadoop.yarn.exceptions.YarnException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

getSubCluster

public GetSubClusterInfoResponse getSubCluster(GetSubClusterInfoRequest request)
                                        throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationMembershipStateStore

Get the membership information of subcluster as identified by SubClusterId. The membership information includes the cluster endpoint and current capabilities as represented by SubClusterInfo.

Specified by:

getSubCluster in interface FederationMembershipStateStore

Parameters:

request - the subcluster whose information is required

Returns:

the SubClusterInfo, or null if there is no mapping for the subcluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

getSubClusters

public GetSubClustersInfoResponse getSubClusters(GetSubClustersInfoRequest request)
                                          throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationMembershipStateStore

Get the membership information of all the subclusters that are currently participating in federation. The membership information includes the cluster endpoint and current capabilities as represented by SubClusterInfo.

Specified by:

getSubClusters in interface FederationMembershipStateStore

Parameters:

request - request for sub-clusters information

Returns:

a map of SubClusterInfo keyed by the SubClusterId

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

addApplicationHomeSubCluster

public AddApplicationHomeSubClusterResponse addApplicationHomeSubCluster(AddApplicationHomeSubClusterRequest request)
                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationApplicationHomeSubClusterStore

Register the home SubClusterId of the newly submitted ApplicationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure. If a mapping for the application already existed, the SubClusterId in this response will return the existing mapping which might be different from that in the AddApplicationHomeSubClusterRequest.

Specified by:

addApplicationHomeSubCluster in interface FederationApplicationHomeSubClusterStore

Parameters:

request - the request to register a new application with its home sub-cluster

Returns:

upon successful registration of the application in the StateStore, AddApplicationHomeSubClusterRequest containing the home sub-cluster of the application. Otherwise, an exception reporting reason for a failure

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

updateApplicationHomeSubCluster

public UpdateApplicationHomeSubClusterResponse updateApplicationHomeSubCluster(UpdateApplicationHomeSubClusterRequest request)
                                                                        throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationApplicationHomeSubClusterStore

Update the home SubClusterId of a previously submitted ApplicationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure.

Specified by:

updateApplicationHomeSubCluster in interface FederationApplicationHomeSubClusterStore

Parameters:

request - the request to update the home sub-cluster of an application.

Returns:

empty on successful update of the application in the StateStore, if not an exception reporting reason for a failure

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

getApplicationHomeSubCluster

public GetApplicationHomeSubClusterResponse getApplicationHomeSubCluster(GetApplicationHomeSubClusterRequest request)
                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationApplicationHomeSubClusterStore

Get information about the application identified by the input ApplicationId.

Specified by:

getApplicationHomeSubCluster in interface FederationApplicationHomeSubClusterStore

Parameters:

request - contains the application queried

Returns:

ApplicationHomeSubCluster containing the application's home subcluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

getApplicationsHomeSubCluster

public GetApplicationsHomeSubClusterResponse getApplicationsHomeSubCluster(GetApplicationsHomeSubClusterRequest request)
                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationApplicationHomeSubClusterStore

Get the ApplicationHomeSubCluster list representing the mapping of all submitted applications to it's home sub-cluster.

Specified by:

getApplicationsHomeSubCluster in interface FederationApplicationHomeSubClusterStore

Parameters:

request - empty representing all applications

Returns:

the mapping of all submitted application to it's home sub-cluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

deleteApplicationHomeSubCluster

public DeleteApplicationHomeSubClusterResponse deleteApplicationHomeSubCluster(DeleteApplicationHomeSubClusterRequest request)
                                                                        throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationApplicationHomeSubClusterStore

Delete the mapping of home SubClusterId of a previously submitted ApplicationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure.

Specified by:

deleteApplicationHomeSubCluster in interface FederationApplicationHomeSubClusterStore

Parameters:

request - the request to delete the home sub-cluster of an application.

Returns:

empty on successful update of the application in the StateStore, if not an exception reporting reason for a failure

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

getPolicyConfiguration

public GetSubClusterPolicyConfigurationResponse getPolicyConfiguration(GetSubClusterPolicyConfigurationRequest request)
                                                                throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationPolicyStore

Get the policy configuration for a given queue.

Specified by:

getPolicyConfiguration in interface FederationPolicyStore

Parameters:

request - the queue whose SubClusterPolicyConfiguration is required

Returns:

the SubClusterPolicyConfiguration for the specified queue, or null if there is no mapping for the queue

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

setPolicyConfiguration

public SetSubClusterPolicyConfigurationResponse setPolicyConfiguration(SetSubClusterPolicyConfigurationRequest request)
                                                                throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationPolicyStore

Set the policy configuration for a given queue.

Specified by:

setPolicyConfiguration in interface FederationPolicyStore

Parameters:

request - the SubClusterPolicyConfiguration with the corresponding queue

Returns:

response empty on successfully updating the SubClusterPolicyConfiguration for the specified queue

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

getPoliciesConfigurations

public GetSubClusterPoliciesConfigurationsResponse getPoliciesConfigurations(GetSubClusterPoliciesConfigurationsRequest request)
                                                                      throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationPolicyStore

Get a map of all queue-to-policy configurations.

Specified by:

getPoliciesConfigurations in interface FederationPolicyStore

Parameters:

request - empty to represent all configured queues in the system

Returns:

the policies for all currently active queues in the system

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

deletePoliciesConfigurations

public DeleteSubClusterPoliciesConfigurationsResponse deletePoliciesConfigurations(DeleteSubClusterPoliciesConfigurationsRequest request)
                                                                            throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationPolicyStore

Delete PoliciesConfigurations.

Specified by:

deletePoliciesConfigurations in interface FederationPolicyStore

Parameters:

request - List containing delete queues.

Returns:

response empty means the queue list has been deleted successfully.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

deleteAllPoliciesConfigurations

public DeletePoliciesConfigurationsResponse deleteAllPoliciesConfigurations(DeletePoliciesConfigurationsRequest request)
                                                                     throws Exception

Description copied from interface: FederationPolicyStore

Delete all queue-to-policy configurations.

Specified by:

deleteAllPoliciesConfigurations in interface FederationPolicyStore

Parameters:

request - delete request.

Returns:

If the response is empty, the queue-to-policy configurations are deleted successfully.

Throws:

Exception - if the request is invalid/fails

getCurrentVersion

public Version getCurrentVersion()

Description copied from interface: FederationStateStore

Get the Version of the underlying federation state store client.

Specified by:

getCurrentVersion in interface FederationStateStore

Returns:

the Version of the underlying federation store client

loadVersion

public Version loadVersion()
                    throws Exception

Description copied from interface: FederationStateStore

Load the version information from the federation state store.

Specified by:

loadVersion in interface FederationStateStore

Returns:

the Version of the federation state store

Throws:

Exception - an exception occurred in load version.

storeVersion

public void storeVersion()
                  throws Exception

Description copied from interface: FederationStateStore

Store the Version information in federation state store.

Specified by:

storeVersion in interface FederationStateStore

Throws:

Exception - an exception occurred in store version.

deleteStateStore

public void deleteStateStore()
                      throws Exception

Description copied from interface: FederationStateStore

We will clear the data in stateStore through the deleteStateStore method.

Specified by:

deleteStateStore in interface FederationStateStore

Throws:

Exception - an exception occurred in delete store.

addReservationHomeSubCluster

public AddReservationHomeSubClusterResponse addReservationHomeSubCluster(AddReservationHomeSubClusterRequest request)
                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationReservationHomeSubClusterStore

Register the home SubClusterId of the newly submitted ReservationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure. If a mapping for the Reservation already existed, the SubClusterId in this response will return the existing mapping which might be different from that in the AddReservationHomeSubClusterRequest.

Specified by:

addReservationHomeSubCluster in interface FederationReservationHomeSubClusterStore

Parameters:

request - the request to register a new Reservation with its home sub-cluster

Returns:

upon successful registration of the Reservation in the StateStore, AddReservationHomeSubClusterRequest containing the home sub-cluster of the Reservation. Otherwise, an exception reporting reason for a failure

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

getReservationHomeSubCluster

public GetReservationHomeSubClusterResponse getReservationHomeSubCluster(GetReservationHomeSubClusterRequest request)
                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationReservationHomeSubClusterStore

Get information about the Reservation identified by the input ReservationId.

Specified by:

getReservationHomeSubCluster in interface FederationReservationHomeSubClusterStore

Parameters:

request - contains the Reservation queried

Returns:

ReservationHomeSubCluster containing the Reservation's home subcluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

getReservationsHomeSubCluster

public GetReservationsHomeSubClusterResponse getReservationsHomeSubCluster(GetReservationsHomeSubClusterRequest request)
                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationReservationHomeSubClusterStore

Get the ReservationHomeSubCluster list representing the mapping of all submitted Reservations to it's home sub-cluster.

Specified by:

getReservationsHomeSubCluster in interface FederationReservationHomeSubClusterStore

Parameters:

request - empty representing all Reservations

Returns:

the mapping of all submitted Reservation to it's home sub-cluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

updateReservationHomeSubCluster

public UpdateReservationHomeSubClusterResponse updateReservationHomeSubCluster(UpdateReservationHomeSubClusterRequest request)
                                                                        throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationReservationHomeSubClusterStore

Update the home SubClusterId of a previously submitted ReservationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure.

Specified by:

updateReservationHomeSubCluster in interface FederationReservationHomeSubClusterStore

Parameters:

request - the request to update the home sub-cluster of a reservation.

Returns:

empty on successful update of the Reservation in the StateStore, if not an exception reporting reason for a failure

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

deleteReservationHomeSubCluster

public DeleteReservationHomeSubClusterResponse deleteReservationHomeSubCluster(DeleteReservationHomeSubClusterRequest request)
                                                                        throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationReservationHomeSubClusterStore

Delete the mapping of home SubClusterId of a previously submitted ReservationId. Currently response is empty if the operation was successful, if not an exception reporting reason for a failure.

Specified by:

deleteReservationHomeSubCluster in interface FederationReservationHomeSubClusterStore

Parameters:

request - the request to delete the home sub-cluster of a reservation.

Returns:

empty on successful update of the Reservation in the StateStore, if not an exception reporting reason for a failure

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid/fails

storeNewMasterKey

public RouterMasterKeyResponse storeNewMasterKey(RouterMasterKeyRequest request)
                                          throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports Store NewMasterKey. During this Process, Facade will call the specific StateStore to store the MasterKey.

Specified by:

storeNewMasterKey in interface FederationDelegationTokenStateStore

Parameters:

request - The request contains RouterMasterKey, which is an abstraction for DelegationKey

Returns:

routerMasterKeyResponse

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful

IOException - An IO Error occurred

removeStoredMasterKey

public RouterMasterKeyResponse removeStoredMasterKey(RouterMasterKeyRequest request)
                                              throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports Remove MasterKey. During this Process, Facade will call the specific StateStore to remove the MasterKey.

Specified by:

removeStoredMasterKey in interface FederationDelegationTokenStateStore

Parameters:

request - The request contains RouterMasterKey, which is an abstraction for DelegationKey

Returns:

routerMasterKeyResponse

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful

IOException - An IO Error occurred

getMasterKeyByDelegationKey

public RouterMasterKeyResponse getMasterKeyByDelegationKey(RouterMasterKeyRequest request)
                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports GetMasterKeyByDelegationKey.

Specified by:

getMasterKeyByDelegationKey in interface FederationDelegationTokenStateStore

Parameters:

request - The request contains RouterMasterKey, which is an abstraction for DelegationKey

Returns:

routerMasterKeyResponse

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful

IOException - An IO Error occurred

storeNewToken

public RouterRMTokenResponse storeNewToken(RouterRMTokenRequest request)
                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports Store RMDelegationTokenIdentifier.

Specified by:

storeNewToken in interface FederationDelegationTokenStateStore

Parameters:

request - The request contains RouterRMToken (RMDelegationTokenIdentifier and renewDate)

Returns:

routerRMTokenResponse.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful

IOException - An IO Error occurred

updateStoredToken

public RouterRMTokenResponse updateStoredToken(RouterRMTokenRequest request)
                                        throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports Update RMDelegationTokenIdentifier.

Specified by:

updateStoredToken in interface FederationDelegationTokenStateStore

Parameters:

request - The request contains RouterRMToken (RMDelegationTokenIdentifier and renewDate)

Returns:

RouterRMTokenResponse.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful

IOException - An IO Error occurred

removeStoredToken

public RouterRMTokenResponse removeStoredToken(RouterRMTokenRequest request)
                                        throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports Remove RMDelegationTokenIdentifier.

Specified by:

removeStoredToken in interface FederationDelegationTokenStateStore

Parameters:

request - The request contains RouterRMToken (RMDelegationTokenIdentifier and renewDate)

Returns:

RouterRMTokenResponse.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful

IOException - An IO Error occurred

getTokenByRouterStoreToken

public RouterRMTokenResponse getTokenByRouterStoreToken(RouterRMTokenRequest request)
                                                 throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports GetTokenByRouterStoreToken.

Specified by:

getTokenByRouterStoreToken in interface FederationDelegationTokenStateStore

Parameters:

request - The request contains RouterRMToken (RMDelegationTokenIdentifier and renewDate)

Returns:

RouterRMTokenResponse.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful

IOException - An IO Error occurred

incrementDelegationTokenSeqNum

public int incrementDelegationTokenSeqNum()

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports incrementDelegationTokenSeqNum.

Specified by:

incrementDelegationTokenSeqNum in interface FederationDelegationTokenStateStore

Returns:

DelegationTokenSeqNum.

getDelegationTokenSeqNum

public int getDelegationTokenSeqNum()

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports getDelegationTokenSeqNum.

Specified by:

getDelegationTokenSeqNum in interface FederationDelegationTokenStateStore

Returns:

DelegationTokenSeqNum.

setDelegationTokenSeqNum

public void setDelegationTokenSeqNum(int seqNum)

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports setDelegationTokenSeqNum.

Specified by:

setDelegationTokenSeqNum in interface FederationDelegationTokenStateStore

Parameters:

seqNum - DelegationTokenSeqNum.

getCurrentKeyId

public int getCurrentKeyId()

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports getCurrentKeyId.

Specified by:

getCurrentKeyId in interface FederationDelegationTokenStateStore

Returns:

CurrentKeyId.

incrementCurrentKeyId

public int incrementCurrentKeyId()

Description copied from interface: FederationDelegationTokenStateStore

The Router Supports incrementCurrentKeyId.

Specified by:

incrementCurrentKeyId in interface FederationDelegationTokenStateStore

Returns:

CurrentKeyId.

getRouterRMSecretManagerState

@VisibleForTesting
public RouterRMDTSecretManagerState getRouterRMSecretManagerState()

getMembership

@VisibleForTesting
public Map<SubClusterId,SubClusterInfo> getMembership()

setMembership

@VisibleForTesting
public void setMembership(Map<SubClusterId,SubClusterInfo> membership)

setExpiredHeartbeat

@VisibleForTesting
public void setExpiredHeartbeat(SubClusterId subClusterId,
 long heartBearTime)
                         throws org.apache.hadoop.yarn.exceptions.YarnRuntimeException

Throws:

org.apache.hadoop.yarn.exceptions.YarnRuntimeException

setApplicationContext

@VisibleForTesting
public void setApplicationContext(String subClusterId,
 org.apache.hadoop.yarn.api.records.ApplicationId applicationId,
 long createTime)