Package org.apache.hadoop.yarn.server.resourcemanager.resource

Class ResourceProfilesManagerImpl

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.resource.ResourceProfilesManagerImpl

All Implemented Interfaces:

ResourceProfilesManager

public class ResourceProfilesManagerImpl
extends java.lang.Object
implements ResourceProfilesManager

PBImpl class to handle all proto related implementation for ResourceProfilesManager.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_PROFILE
static java.lang.String	MAXIMUM_PROFILE
static java.lang.String	MINIMUM_PROFILE
protected java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock	readLock
protected java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock	writeLock

Constructor Summary

Constructors

Constructor	Description
ResourceProfilesManagerImpl()

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.yarn.api.records.Resource	getDefaultProfile()	Get default supported resource profile.
org.apache.hadoop.yarn.api.records.Resource	getMaximumProfile()	Get maximum supported resource profile.
org.apache.hadoop.yarn.api.records.Resource	getMinimumProfile()	Get minimum supported resource profile.
org.apache.hadoop.yarn.api.records.Resource	getProfile(java.lang.String profile)	Get the resource capability associated with given profile name.
java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.Resource>	getResourceProfiles()	Get all supported resource profiles.
void	init(org.apache.hadoop.conf.Configuration config)	Method to handle all initialization steps for ResourceProfilesManager.
void	reloadProfiles()	Reload profiles based on updated configuration.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROFILE

public static final java.lang.String DEFAULT_PROFILE

See Also:

Constant Field Values

MINIMUM_PROFILE

public static final java.lang.String MINIMUM_PROFILE

See Also:

Constant Field Values

MAXIMUM_PROFILE

public static final java.lang.String MAXIMUM_PROFILE

See Also:

Constant Field Values

readLock

protected final java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock readLock

writeLock

protected final java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock writeLock

Constructor Detail

ResourceProfilesManagerImpl

public ResourceProfilesManagerImpl()

Method Detail

init

public void init(org.apache.hadoop.conf.Configuration config)
          throws java.io.IOException

Description copied from interface: ResourceProfilesManager

Method to handle all initialization steps for ResourceProfilesManager.

Specified by:

init in interface ResourceProfilesManager

Parameters:

config - Configuration object

Throws:

java.io.IOException - when invalid resource profile names are loaded

getProfile

public org.apache.hadoop.yarn.api.records.Resource getProfile(java.lang.String profile)
                                                       throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: ResourceProfilesManager

Get the resource capability associated with given profile name.

Specified by:

getProfile in interface ResourceProfilesManager

Parameters:

profile - name of resource profile

Returns:

resource capability for given profile

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - when any invalid profile name or feature is disabled

getResourceProfiles

public java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.Resource> getResourceProfiles()
                                                                                                      throws org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException

Description copied from interface: ResourceProfilesManager

Get all supported resource profiles.

Specified by:

getResourceProfiles in interface ResourceProfilesManager

Returns:

a map of resource objects associated with each profile

Throws:

org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException - when feature is disabled

reloadProfiles

@VisibleForTesting
public void reloadProfiles()
                    throws java.io.IOException

Description copied from interface: ResourceProfilesManager

Reload profiles based on updated configuration.

Specified by:

reloadProfiles in interface ResourceProfilesManager

Throws:

java.io.IOException - when invalid resource profile names are loaded

getDefaultProfile

public org.apache.hadoop.yarn.api.records.Resource getDefaultProfile()
                                                              throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: ResourceProfilesManager

Get default supported resource profile.

Specified by:

getDefaultProfile in interface ResourceProfilesManager

Returns:

resource object which is default

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - when any invalid profile name or feature is disabled

getMinimumProfile

public org.apache.hadoop.yarn.api.records.Resource getMinimumProfile()
                                                              throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: ResourceProfilesManager

Get minimum supported resource profile.

Specified by:

getMinimumProfile in interface ResourceProfilesManager

Returns:

resource object which is minimum

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - when any invalid profile name or feature is disabled

getMaximumProfile

public org.apache.hadoop.yarn.api.records.Resource getMaximumProfile()
                                                              throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from interface: ResourceProfilesManager

Get maximum supported resource profile.

Specified by:

getMaximumProfile in interface ResourceProfilesManager

Returns:

resource object which is maximum

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - when any invalid profile name or feature is disabled