Package org.apache.hadoop.yarn.server.federation.cache

Class FederationCache

java.lang.Object

org.apache.hadoop.yarn.server.federation.cache.FederationCache

Direct Known Subclasses:

FederationGuavaCache, FederationJCache

public abstract class FederationCache
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FederationCache.ApplicationHomeSubClusterCacheResponse
class	FederationCache.CacheRequest<K,V>	Internal class that encapsulates the cache key and a function that returns the value for the specified key.
class	FederationCache.CacheResponse<R>
class	FederationCache.SubClusterInfoCacheResponse
class	FederationCache.SubClusterPolicyConfigurationCacheResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	GET_APPLICATION_HOME_SUBCLUSTER_CACHEID
protected static java.lang.String	GET_POLICIES_CONFIGURATIONS_CACHEID
protected static java.lang.String	GET_SUBCLUSTERS_CACHEID
protected static java.lang.String	POINT

Constructor Summary

Constructors

Constructor	Description
FederationCache()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	buildCacheKey(java.lang.String className, java.lang.String methodName)	Build CacheKey.
protected java.lang.String	buildCacheKey(java.lang.String className, java.lang.String methodName, java.lang.String argName)	Build CacheKey.
protected FederationCache.CacheRequest<java.lang.String,FederationCache.CacheResponse<SubClusterId>>	buildGetApplicationHomeSubClusterRequest(java.lang.String cacheKey, org.apache.hadoop.yarn.api.records.ApplicationId applicationId)	Build GetApplicationHomeSubCluster CacheRequest.
protected FederationCache.CacheRequest<java.lang.String,FederationCache.CacheResponse<SubClusterPolicyConfiguration>>	buildGetPoliciesConfigurationsCacheRequest(java.lang.String cacheKey)	Build GetPoliciesConfigurations CacheRequest.
protected FederationCache.CacheRequest<java.lang.String,FederationCache.CacheResponse<SubClusterInfo>>	buildGetSubClustersCacheRequest(java.lang.String cacheKey, boolean filterInactiveSubClusters)	Build GetSubClusters CacheRequest.
static java.util.Map<java.lang.String,SubClusterPolicyConfiguration>	buildPolicyConfigMap(FederationCache.CacheRequest<java.lang.String,?> cacheRequest)	According to the cacheRequest, build PolicyConfigMap.
static java.util.Map<java.lang.String,SubClusterPolicyConfiguration>	buildPolicyConfigMap(GetSubClusterPoliciesConfigurationsResponse response)	According to the response, build PolicyConfigMap.
static java.util.Map<SubClusterId,SubClusterInfo>	buildSubClusterInfoMap(FederationCache.CacheRequest<java.lang.String,?> cacheRequest)	According to the cacheRequest, build SubClusterInfoMap.
static java.util.Map<SubClusterId,SubClusterInfo>	buildSubClusterInfoMap(GetSubClustersInfoResponse response)	According to the response, build SubClusterInfoMap.
abstract void	clearCache()	clear cache.
abstract SubClusterId	getApplicationHomeSubCluster(org.apache.hadoop.yarn.api.records.ApplicationId appId)	Returns the home SubClusterId for the specified ApplicationId.
abstract java.util.Map<java.lang.String,SubClusterPolicyConfiguration>	getPoliciesConfigurations()	Get the policies that is represented as SubClusterPolicyConfiguration for all currently active queues in the system.
FederationStateStore	getStateStore()
abstract java.util.Map<SubClusterId,SubClusterInfo>	getSubClusters(boolean filterInactiveSubClusters)	Returns the SubClusterInfo of all active sub cluster(s).
abstract void	initCache(org.apache.hadoop.conf.Configuration pConf, FederationStateStore pStateStore)	Initialize the cache.
abstract boolean	isCachingEnabled()	Determine whether to enable cache.
abstract void	removeSubCluster(boolean filterInactiveSubClusters)	Remove SubCluster from cache.
void	setStateStore(FederationStateStore stateStore)

Methods inherited from class java.lang.Object

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

Field Detail

GET_SUBCLUSTERS_CACHEID

protected static final java.lang.String GET_SUBCLUSTERS_CACHEID

See Also:

Constant Field Values

GET_POLICIES_CONFIGURATIONS_CACHEID

protected static final java.lang.String GET_POLICIES_CONFIGURATIONS_CACHEID

See Also:

Constant Field Values

GET_APPLICATION_HOME_SUBCLUSTER_CACHEID

protected static final java.lang.String GET_APPLICATION_HOME_SUBCLUSTER_CACHEID

See Also:

Constant Field Values

POINT

protected static final java.lang.String POINT

See Also:

Constant Field Values

Constructor Detail

FederationCache

public FederationCache()

Method Detail

isCachingEnabled

public abstract boolean isCachingEnabled()

Determine whether to enable cache. We judge whether to enable the cache according to the cache time. If the cache time is greater than 0, the cache is enabled. If the cache time is less than or equal 0, the cache is not enabled.

Returns:

true, enable cache; false, not enable cache.

initCache

public abstract void initCache(org.apache.hadoop.conf.Configuration pConf,
                               FederationStateStore pStateStore)

Initialize the cache.

Parameters:

pConf - Configuration.

pStateStore - FederationStateStore.

clearCache

public abstract void clearCache()

clear cache.

buildCacheKey

protected java.lang.String buildCacheKey(java.lang.String className,
                                         java.lang.String methodName)

Build CacheKey.

Parameters:

className - Cache Class Name.

methodName - Method Name.

Returns:

append result. Example: className:FederationJCache, methodName:getPoliciesConfigurations. We Will Return FederationJCache.getPoliciesConfigurations.

buildCacheKey

protected java.lang.String buildCacheKey(java.lang.String className,
                                         java.lang.String methodName,
                                         java.lang.String argName)

Build CacheKey.

Parameters:

className - Cache Class Name.

methodName - Method Name.

argName - ArgName.

Returns:

append result. Example: className:FederationJCache, methodName:getApplicationHomeSubCluster, argName: app_1 We Will Return FederationJCache.getApplicationHomeSubCluster.app_1

getSubClusters

public abstract java.util.Map<SubClusterId,SubClusterInfo> getSubClusters(boolean filterInactiveSubClusters)
                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException

Returns the SubClusterInfo of all active sub cluster(s).

Parameters:

filterInactiveSubClusters - whether to filter out inactive sub-clusters

Returns:

the information of all active sub cluster(s)

Throws:

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

getPoliciesConfigurations

public abstract java.util.Map<java.lang.String,SubClusterPolicyConfiguration> getPoliciesConfigurations()
                                                                                                       throws java.lang.Exception

Get the policies that is represented as SubClusterPolicyConfiguration for all currently active queues in the system.

Returns:

the policies for all currently active queues in the system

Throws:

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

java.lang.Exception

getApplicationHomeSubCluster

public abstract SubClusterId getApplicationHomeSubCluster(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                   throws java.lang.Exception

Returns the home SubClusterId for the specified ApplicationId.

Parameters:

appId - the identifier of the application

Returns:

the home sub cluster identifier

Throws:

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

java.lang.Exception

removeSubCluster

public abstract void removeSubCluster(boolean filterInactiveSubClusters)

Remove SubCluster from cache.

Parameters:

filterInactiveSubClusters - whether to filter out inactive sub-clusters.

buildGetSubClustersCacheRequest

protected FederationCache.CacheRequest<java.lang.String,FederationCache.CacheResponse<SubClusterInfo>> buildGetSubClustersCacheRequest(java.lang.String cacheKey,
                                                                                                                                             boolean filterInactiveSubClusters)
                                                                                                                                      throws org.apache.hadoop.yarn.exceptions.YarnException

Build GetSubClusters CacheRequest.

Parameters:

cacheKey - cacheKey.

filterInactiveSubClusters - filter Inactive SubClusters.

Returns:

CacheRequest.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.

buildSubClusterInfoMap

public static java.util.Map<SubClusterId,SubClusterInfo> buildSubClusterInfoMap(GetSubClustersInfoResponse response)

According to the response, build SubClusterInfoMap.

Parameters:

response - GetSubClustersInfoResponse.

Returns:

SubClusterInfoMap.

buildSubClusterInfoMap

public static java.util.Map<SubClusterId,SubClusterInfo> buildSubClusterInfoMap(FederationCache.CacheRequest<java.lang.String,?> cacheRequest)

According to the cacheRequest, build SubClusterInfoMap.

Parameters:

cacheRequest - CacheRequest.

Returns:

SubClusterInfoMap.

buildGetApplicationHomeSubClusterRequest

protected FederationCache.CacheRequest<java.lang.String,FederationCache.CacheResponse<SubClusterId>> buildGetApplicationHomeSubClusterRequest(java.lang.String cacheKey,
                                                                                                                                                    org.apache.hadoop.yarn.api.records.ApplicationId applicationId)
                                                                                                                                             throws org.apache.hadoop.yarn.exceptions.YarnException

Build GetApplicationHomeSubCluster CacheRequest.

Parameters:

cacheKey - cacheKey.

applicationId - applicationId.

Returns:

CacheRequest.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.

buildGetPoliciesConfigurationsCacheRequest

protected FederationCache.CacheRequest<java.lang.String,FederationCache.CacheResponse<SubClusterPolicyConfiguration>> buildGetPoliciesConfigurationsCacheRequest(java.lang.String cacheKey)
                                                                                                                                                                throws org.apache.hadoop.yarn.exceptions.YarnException

Build GetPoliciesConfigurations CacheRequest.

Parameters:

cacheKey - cacheKey.

Returns:

CacheRequest.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - exceptions from yarn servers.

buildPolicyConfigMap

public static java.util.Map<java.lang.String,SubClusterPolicyConfiguration> buildPolicyConfigMap(GetSubClusterPoliciesConfigurationsResponse response)

According to the response, build PolicyConfigMap.

Parameters:

response - GetSubClusterPoliciesConfigurationsResponse.

Returns:

PolicyConfigMap.

buildPolicyConfigMap

public static java.util.Map<java.lang.String,SubClusterPolicyConfiguration> buildPolicyConfigMap(FederationCache.CacheRequest<java.lang.String,?> cacheRequest)

According to the cacheRequest, build PolicyConfigMap.

Parameters:

cacheRequest - CacheRequest.

Returns:

PolicyConfigMap.

getStateStore

public FederationStateStore getStateStore()

setStateStore

public void setStateStore(FederationStateStore stateStore)