Package org.apache.hadoop.yarn.server.federation.policies.manager

Class AbstractPolicyManager

java.lang.Object

org.apache.hadoop.yarn.server.federation.policies.manager.AbstractPolicyManager

All Implemented Interfaces:

FederationPolicyManager

Direct Known Subclasses:

HashBroadcastPolicyManager, HomePolicyManager, PriorityBroadcastPolicyManager, RejectAllPolicyManager, UniformBroadcastPolicyManager, WeightedHomePolicyManager, WeightedLocalityPolicyManager

public abstract class AbstractPolicyManager
extends Object
implements FederationPolicyManager

This class provides basic implementation for common methods that multiple policies will need to implement.

Field Summary

Fields

Modifier and Type	Field	Description
protected Class	amrmProxyFederationPolicy
static final org.slf4j.Logger	LOG
protected Class	routerFederationPolicy

Constructor Summary

Constructors

Constructor	Description
AbstractPolicyManager()

Method Summary

Modifier and Type	Method	Description
FederationAMRMProxyPolicy	getAMRMPolicy(FederationPolicyInitializationContext federationPolicyContext, FederationAMRMProxyPolicy oldInstance)	This default implementation validates the FederationPolicyInitializationContext, then checks whether it needs to reinstantiate the class (null or mismatching type), and reinitialize the policy.
String	getQueue()	This method returns the queue this policy is configured for.
FederationRouterPolicy	getRouterPolicy(FederationPolicyInitializationContext federationPolicyContext, FederationRouterPolicy oldInstance)	This default implementation validates the FederationPolicyInitializationContext, then checks whether it needs to reinstantiate the class (null or mismatching type), and reinitialize the policy.
abstract WeightedPolicyInfo	getWeightedPolicyInfo()	We get the WeightedPolicyInfo of the subCluster.
SubClusterPolicyConfiguration	serializeConf()	This method is invoked to derive a SubClusterPolicyConfiguration.
void	setQueue(String queue)	This methods provides a setter for the queue this policy is specified for.
abstract void	setWeightedPolicyInfo(WeightedPolicyInfo weightedPolicyInfo)	We set the WeightedPolicyInfo of the subCluster.

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.policies.manager.FederationPolicyManager

isSupportWeightedPolicyInfo

Field Details

routerFederationPolicy

protected Class routerFederationPolicy

amrmProxyFederationPolicy

protected Class amrmProxyFederationPolicy

LOG

public static final org.slf4j.Logger LOG

Constructor Details

AbstractPolicyManager

public AbstractPolicyManager()

Method Details

getAMRMPolicy

public FederationAMRMProxyPolicy getAMRMPolicy(FederationPolicyInitializationContext federationPolicyContext,
 FederationAMRMProxyPolicy oldInstance)
                                        throws FederationPolicyInitializationException

This default implementation validates the FederationPolicyInitializationContext, then checks whether it needs to reinstantiate the class (null or mismatching type), and reinitialize the policy.

Specified by:

getAMRMPolicy in interface FederationPolicyManager

Parameters:

federationPolicyContext - the current context

oldInstance - the existing (possibly null) instance.

Returns:

a valid and fully reinitialized FederationAMRMProxyPolicy instance

Throws:

FederationPolicyInitializationException - if the reinitialization is not valid, and ensure previous state is preserved

getRouterPolicy

public FederationRouterPolicy getRouterPolicy(FederationPolicyInitializationContext federationPolicyContext,
 FederationRouterPolicy oldInstance)
                                       throws FederationPolicyInitializationException

This default implementation validates the FederationPolicyInitializationContext, then checks whether it needs to reinstantiate the class (null or mismatching type), and reinitialize the policy.

Specified by:

getRouterPolicy in interface FederationPolicyManager

Parameters:

federationPolicyContext - the current context

oldInstance - the existing (possibly null) instance.

Returns:

a valid and fully reinitialized FederationRouterPolicy instance

Throws:

FederationPolicyInitializationException - if the reinitialization is not valid, and ensure previous state is preserved

serializeConf

public SubClusterPolicyConfiguration serializeConf()
                                            throws FederationPolicyInitializationException

Description copied from interface: FederationPolicyManager

This method is invoked to derive a SubClusterPolicyConfiguration. This is to be used when writing a policy object in the federation policy store.

Specified by:

serializeConf in interface FederationPolicyManager

Returns:

a valid policy configuration representing this object parametrization.

Throws:

FederationPolicyInitializationException - if the current state cannot be serialized properly

getQueue

public String getQueue()

Description copied from interface: FederationPolicyManager

This method returns the queue this policy is configured for.

Specified by:

getQueue in interface FederationPolicyManager

Returns:

the name of the queue.

setQueue

public void setQueue(String queue)

Description copied from interface: FederationPolicyManager

This methods provides a setter for the queue this policy is specified for.

Specified by:

setQueue in interface FederationPolicyManager

Parameters:

queue - the name of the queue.

getWeightedPolicyInfo

public abstract WeightedPolicyInfo getWeightedPolicyInfo()

We get the WeightedPolicyInfo of the subCluster.

Specified by:

getWeightedPolicyInfo in interface FederationPolicyManager

Returns:

WeightedPolicyInfo.

setWeightedPolicyInfo

public abstract void setWeightedPolicyInfo(WeightedPolicyInfo weightedPolicyInfo)

We set the WeightedPolicyInfo of the subCluster.

Specified by:

setWeightedPolicyInfo in interface FederationPolicyManager

Parameters:

weightedPolicyInfo - weightedPolicyInfo of the subCluster.