Package org.apache.hadoop.yarn.server.router.clientrm

Class AbstractClientRequestInterceptor

java.lang.Object

org.apache.hadoop.yarn.server.router.clientrm.AbstractClientRequestInterceptor

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.yarn.api.ApplicationBaseProtocol, org.apache.hadoop.yarn.api.ApplicationClientProtocol, ClientRequestInterceptor

Direct Known Subclasses:

DefaultClientRequestInterceptor, FederationClientInterceptor, PassThroughClientRequestInterceptor

public abstract class AbstractClientRequestInterceptor
extends java.lang.Object
implements ClientRequestInterceptor

Implements the ClientRequestInterceptor interface and provides common functionality which can can be used and/or extended by other concrete interceptor classes.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.hadoop.security.UserGroupInformation	user

Constructor Summary

Constructors

Constructor	Description
AbstractClientRequestInterceptor()

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.conf.Configuration	getConf()	Gets the Configuration.
ClientRequestInterceptor	getNextInterceptor()	Gets the next ClientRequestInterceptor in the chain.
RouterDelegationTokenSecretManager	getTokenSecretManager()	Get RouterDelegationTokenSecretManager.
void	init(java.lang.String userName)	Initializes the ClientRequestInterceptor.
void	setConf(org.apache.hadoop.conf.Configuration conf)	Sets the Configuration.
void	setNextInterceptor(ClientRequestInterceptor nextInterceptor)	Sets the ClientRequestInterceptor in the chain.
void	setTokenSecretManager(RouterDelegationTokenSecretManager tokenSecretManager)	Set RouterDelegationTokenSecretManager for specific interceptor to support Token operations, including create Token, update Token, and delete Token.
void	shutdown()	Disposes the ClientRequestInterceptor.

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.api.ApplicationBaseProtocol

cancelDelegationToken, getApplicationAttemptReport, getApplicationAttempts, getApplicationReport, getApplications, getContainerReport, getContainers, getDelegationToken, renewDelegationToken

Methods inherited from interface org.apache.hadoop.yarn.api.ApplicationClientProtocol

deleteReservation, failApplicationAttempt, forceKillApplication, getAttributesToNodes, getClusterMetrics, getClusterNodeAttributes, getClusterNodeLabels, getClusterNodes, getLabelsToNodes, getNewApplication, getNewReservation, getNodesToAttributes, getNodeToLabels, getQueueInfo, getQueueUserAcls, getResourceProfile, getResourceProfiles, getResourceTypeInfo, listReservations, moveApplicationAcrossQueues, signalToContainer, submitApplication, submitReservation, updateApplicationPriority, updateApplicationTimeouts, updateReservation

Field Detail

user

protected org.apache.hadoop.security.UserGroupInformation user

Constructor Detail

AbstractClientRequestInterceptor

public AbstractClientRequestInterceptor()

Method Detail

setNextInterceptor

public void setNextInterceptor(ClientRequestInterceptor nextInterceptor)

Sets the ClientRequestInterceptor in the chain.

Specified by:

setNextInterceptor in interface ClientRequestInterceptor

Parameters:

nextInterceptor - the ClientRequestInterceptor to set in the pipeline

setConf

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

Sets the Configuration.

Specified by:

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

getConf

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

Gets the Configuration.

Specified by:

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

init

public void init(java.lang.String userName)

Initializes the ClientRequestInterceptor.

Specified by:

init in interface ClientRequestInterceptor

Parameters:

userName - the name of the client

shutdown

public void shutdown()

Disposes the ClientRequestInterceptor.

Specified by:

shutdown in interface ClientRequestInterceptor

getNextInterceptor

public ClientRequestInterceptor getNextInterceptor()

Gets the next ClientRequestInterceptor in the chain.

Specified by:

getNextInterceptor in interface ClientRequestInterceptor

Returns:

the next interceptor in the chain

getTokenSecretManager

public RouterDelegationTokenSecretManager getTokenSecretManager()

Description copied from interface: ClientRequestInterceptor

Get RouterDelegationTokenSecretManager.

Specified by:

getTokenSecretManager in interface ClientRequestInterceptor

Returns:

Router DelegationTokenSecretManager.

setTokenSecretManager

public void setTokenSecretManager(RouterDelegationTokenSecretManager tokenSecretManager)

Description copied from interface: ClientRequestInterceptor

Set RouterDelegationTokenSecretManager for specific interceptor to support Token operations, including create Token, update Token, and delete Token.

Specified by:

setTokenSecretManager in interface ClientRequestInterceptor

Parameters:

tokenSecretManager - Router DelegationTokenSecretManager