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

Class AbstractAMRMProxyPolicy

java.lang.Object

org.apache.hadoop.yarn.server.federation.policies.AbstractConfigurableFederationPolicy

org.apache.hadoop.yarn.server.federation.policies.amrmproxy.AbstractAMRMProxyPolicy

All Implemented Interfaces:

FederationAMRMProxyPolicy, ConfigurableFederationPolicy

Direct Known Subclasses:

BroadcastAMRMProxyPolicy, HomeAMRMProxyPolicy, LocalityMulticastAMRMProxyPolicy, RejectAMRMProxyPolicy

public abstract class AbstractAMRMProxyPolicy
extends AbstractConfigurableFederationPolicy
implements FederationAMRMProxyPolicy

Base abstract class for FederationAMRMProxyPolicy implementations, that provides common validation for reinitialization.

Constructor Summary

Constructors

Constructor	Description
AbstractAMRMProxyPolicy()

Method Summary

Modifier and Type	Method	Description
void	notifyOfResponse(SubClusterId subClusterId, org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse response)	This method should be invoked to notify the policy about responses being received.
void	validate(WeightedPolicyInfo newPolicyInfo)	Overridable validation step for the policy configuration.

Methods inherited from class org.apache.hadoop.yarn.server.federation.policies.AbstractConfigurableFederationPolicy

getActiveSubclusters, getIsDirty, getPolicyContext, getPolicyInfo, reinitialize, setPolicyContext, setPolicyInfo

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.ConfigurableFederationPolicy

reinitialize

Methods inherited from interface org.apache.hadoop.yarn.server.federation.policies.amrmproxy.FederationAMRMProxyPolicy

splitResourceRequests

Constructor Details

AbstractAMRMProxyPolicy

public AbstractAMRMProxyPolicy()

Method Details

validate

public void validate(WeightedPolicyInfo newPolicyInfo)
              throws FederationPolicyInitializationException

Description copied from class: AbstractConfigurableFederationPolicy

Overridable validation step for the policy configuration.

Overrides:

validate in class AbstractConfigurableFederationPolicy

Parameters:

newPolicyInfo - the configuration to test.

Throws:

FederationPolicyInitializationException - if the configuration is not valid.

notifyOfResponse

public void notifyOfResponse(SubClusterId subClusterId,
 org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse response)
                      throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: FederationAMRMProxyPolicy

This method should be invoked to notify the policy about responses being received. This is useful for stateful policies that make decisions based on previous responses being received.

Specified by:

notifyOfResponse in interface FederationAMRMProxyPolicy

Parameters:

subClusterId - the id of the subcluster sending the notification

response - the response received from one of the RMs

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - in case the response is not valid