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

Class FederationGuavaCache

java.lang.Object

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

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

public class FederationGuavaCache
extends FederationCache

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.federation.cache.FederationCache

FederationCache.ApplicationHomeSubClusterCacheResponse, FederationCache.CacheRequest<K,V>, FederationCache.CacheResponse<R>, FederationCache.SubClusterInfoCacheResponse, FederationCache.SubClusterPolicyConfigurationCacheResponse

Field Summary

Fields inherited from class org.apache.hadoop.yarn.server.federation.cache.FederationCache

GET_APPLICATION_HOME_SUBCLUSTER_CACHEID, GET_POLICIES_CONFIGURATIONS_CACHEID, GET_SUBCLUSTERS_CACHEID, POINT

Constructor Summary

Constructors

Constructor	Description
FederationGuavaCache()

Method Summary

Modifier and Type	Method	Description
void	clearCache()	clear cache.
SubClusterId	getApplicationHomeSubCluster(org.apache.hadoop.yarn.api.records.ApplicationId appId)	Returns the home SubClusterId for the specified ApplicationId.
java.util.Map<java.lang.String,SubClusterPolicyConfiguration>	getPoliciesConfigurations()	Get the policies that is represented as SubClusterPolicyConfiguration for all currently active queues in the system.
java.util.Map<SubClusterId,SubClusterInfo>	getSubClusters(boolean filterInactiveSubClusters)	Returns the SubClusterInfo of all active sub cluster(s).
void	initCache(org.apache.hadoop.conf.Configuration pConf, FederationStateStore pStateStore)	Initialize the cache.
boolean	isCachingEnabled()	Determine whether to enable cache.
void	removeSubCluster(boolean flushCache)	Remove SubCluster from cache.

Methods inherited from class org.apache.hadoop.yarn.server.federation.cache.FederationCache

buildCacheKey, buildCacheKey, buildGetApplicationHomeSubClusterRequest, buildGetPoliciesConfigurationsCacheRequest, buildGetSubClustersCacheRequest, buildPolicyConfigMap, buildPolicyConfigMap, buildSubClusterInfoMap, buildSubClusterInfoMap, getStateStore, setStateStore

Methods inherited from class java.lang.Object

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

Constructor Detail

FederationGuavaCache

public FederationGuavaCache()

Method Detail

isCachingEnabled

public boolean isCachingEnabled()

Description copied from class: FederationCache

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.

Specified by:

isCachingEnabled in class FederationCache

Returns:

true, enable cache; false, not enable cache.

initCache

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

Description copied from class: FederationCache

Initialize the cache.

Specified by:

initCache in class FederationCache

Parameters:

pConf - Configuration.

pStateStore - FederationStateStore.

clearCache

public void clearCache()

Description copied from class: FederationCache

clear cache.

Specified by:

clearCache in class FederationCache

getSubClusters

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

Description copied from class: FederationCache

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

Specified by:

getSubClusters in class FederationCache

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 java.util.Map<java.lang.String,SubClusterPolicyConfiguration> getPoliciesConfigurations()
                                                                                              throws java.lang.Exception

Description copied from class: FederationCache

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

Specified by:

getPoliciesConfigurations in class FederationCache

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 SubClusterId getApplicationHomeSubCluster(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                          throws java.lang.Exception

Description copied from class: FederationCache

Returns the home SubClusterId for the specified ApplicationId.

Specified by:

getApplicationHomeSubCluster in class FederationCache

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 void removeSubCluster(boolean flushCache)

Description copied from class: FederationCache

Remove SubCluster from cache.

Specified by:

removeSubCluster in class FederationCache

Parameters:

flushCache - whether to filter out inactive sub-clusters.