org.apache.slider.server.appmaster.state

Interface StateAccessForProviders

All Known Implementing Classes:

ProviderAppState

public interface StateAccessForProviders

The methods to offer state access to the providers and other parts of the system which want read-only access to the state.

Method Summary

Methods

Modifier and Type	Method and Description
List<RoleInstance>	cloneLiveContainerInfoList() Create a clone of the list of live cluster nodes.
List<RoleInstance>	cloneOwnedContainerList() Clone a list of active containers
List<RoleStatus>	cloneRoleStatusList() Get a deep clone of the role status list.
List<RoleInstance>	enumLiveInstancesInRole(String role) Enum all role instances by role.
ConfTreeOperations	getAppConfSnapshot() Get at the snapshot of the appconf config Changes here do not affect the application state.
ApplicationLivenessInformation	getApplicationLivenessInformation() get application liveness information
String	getApplicationName() Get the name of the application
ClusterDescription	getClusterStatus() Get the current cluster description
ComponentInformation	getComponentInformation(String component) Get the JSON serializable information about a component
Map<String,ComponentInformation>	getComponentInfoSnapshot() Get a snapshot of component information.
Map<org.apache.hadoop.yarn.api.records.ContainerId,RoleInstance>	getFailedContainers() Get a map of all the failed containers
AggregateConf	getInstanceDefinitionSnapshot() Get a snapshot of the entire aggregate configuration
ConfTreeOperations	getInternalsSnapshot() Get at the snapshot of the internals config.
Map<org.apache.hadoop.yarn.api.records.ContainerId,RoleInstance>	getLiveContainers() Get the live containers.
RoleInstance	getLiveInstanceByContainerID(String containerId) Get the RoleInstance details on a container.
List<RoleInstance>	getLiveInstancesByContainerIDs(Collection<String> containerIDs) Get the details on a list of instaces referred to by ID.
Map<String,Integer>	getLiveStatistics() Get the live statistics map
NodeInformation	getNodeInformation(String hostname) get information on a node
Map<String,NodeInformation>	getNodeInformationSnapshot() Get a clone of the nodemap.
int	getNumOwnedContainers() Get the number of active containers
PublishedConfigSet	getOrCreatePublishedConfigSet(String name) Get a named published config set, creating it if need be.
RoleInstance	getOwnedContainer(org.apache.hadoop.yarn.api.records.ContainerId id) Get any active container with the given ID
RoleInstance	getOwnedContainer(String id) Get any active container with the given ID
PublishedConfigSet	getPublishedConfigSet(String name) Get a named published config set
PublishedExportsSet	getPublishedExportsSet() Get the published exports set
PublishedConfigSet	getPublishedSliderConfigurations() Get the published configurations
ConfTreeOperations	getResourcesSnapshot() Get at the snapshot of the resource config Changes here do not affect the application state.
Map<String,Map<String,ClusterNode>>	getRoleClusterNodeMapping() Find out about the nodes for specific roles
RoleStatistics	getRoleStatistics() Get the aggregate statistics across all roles
Map<Integer,RoleStatus>	getRoleStatusMap() Get a map of role status entries by role Id
long	getSnapshotTime()
AggregateConf	getUnresolvedInstanceDefinition() Get the desired/unresolved value
boolean	isApplicationLive() Flag set to indicate the application is live -this only happens after the buildInstance operation
List<String>	listConfigSets() List the config sets -this takes a clone of the current set
List<RoleInstance>	lookupRoleContainers(String component) Look up all containers of a specific component name
RoleStatus	lookupRoleStatus(org.apache.hadoop.yarn.api.records.Container c) Look up a role from its key -or fail
RoleStatus	lookupRoleStatus(int key) Look up a role from its key -or fail
RoleStatus	lookupRoleStatus(String name) Look up a role from its key -or fail
ClusterDescription	refreshClusterStatus() Update the cluster description with anything interesting

Method Detail

getRoleStatusMap

Map<Integer,RoleStatus> getRoleStatusMap()

Get a map of role status entries by role Id

Returns:

the map of currently defined roles.

getApplicationName

String getApplicationName()

Get the name of the application

Returns:

the name

getPublishedSliderConfigurations

PublishedConfigSet getPublishedSliderConfigurations()

Get the published configurations

Returns:

the configuration set

getPublishedExportsSet

PublishedExportsSet getPublishedExportsSet()

Get the published exports set

Returns:

getPublishedConfigSet

PublishedConfigSet getPublishedConfigSet(String name)

Get a named published config set

Parameters:

name - name to look up

Returns:

the instance or null

getOrCreatePublishedConfigSet

PublishedConfigSet getOrCreatePublishedConfigSet(String name)

Get a named published config set, creating it if need be.

Parameters:

name - name to look up

Returns:

the instance -possibly a new one

listConfigSets

List<String> listConfigSets()

List the config sets -this takes a clone of the current set

Returns:

a list of config sets

getFailedContainers

Map<org.apache.hadoop.yarn.api.records.ContainerId,RoleInstance> getFailedContainers()

Get a map of all the failed containers

Returns:

map of recorded failed containers

getLiveContainers

Map<org.apache.hadoop.yarn.api.records.ContainerId,RoleInstance> getLiveContainers()

Get the live containers.

Returns:

the live nodes

getClusterStatus

ClusterDescription getClusterStatus()

Get the current cluster description

Returns:

the actual state of the cluster

getResourcesSnapshot

ConfTreeOperations getResourcesSnapshot()

Get at the snapshot of the resource config Changes here do not affect the application state.

Returns:

the most recent settings

getAppConfSnapshot

ConfTreeOperations getAppConfSnapshot()

Get at the snapshot of the appconf config Changes here do not affect the application state.

Returns:

the most recent settings

getInternalsSnapshot

ConfTreeOperations getInternalsSnapshot()

Get at the snapshot of the internals config. Changes here do not affect the application state.

Returns:

the internals settings

isApplicationLive

boolean isApplicationLive()

Flag set to indicate the application is live -this only happens after the buildInstance operation

getSnapshotTime

long getSnapshotTime()

getInstanceDefinitionSnapshot

AggregateConf getInstanceDefinitionSnapshot()

Get a snapshot of the entire aggregate configuration

Returns:

the aggregate configuration

getUnresolvedInstanceDefinition

AggregateConf getUnresolvedInstanceDefinition()

Get the desired/unresolved value

Returns:

unresolved

lookupRoleStatus

RoleStatus lookupRoleStatus(int key)

Look up a role from its key -or fail

Parameters:

key - key to resolve

Returns:

the status

Throws:

org.apache.hadoop.yarn.exceptions.YarnRuntimeException - on no match

lookupRoleStatus

RoleStatus lookupRoleStatus(org.apache.hadoop.yarn.api.records.Container c)
                            throws org.apache.hadoop.yarn.exceptions.YarnRuntimeException

Look up a role from its key -or fail

Parameters:

c - container in a role

Returns:

the status

Throws:

org.apache.hadoop.yarn.exceptions.YarnRuntimeException - on no match

lookupRoleStatus

RoleStatus lookupRoleStatus(String name)
                            throws org.apache.hadoop.yarn.exceptions.YarnRuntimeException

Look up a role from its key -or fail

Parameters:

name - container in a role

Returns:

the status

Throws:

org.apache.hadoop.yarn.exceptions.YarnRuntimeException - on no match

cloneOwnedContainerList

List<RoleInstance> cloneOwnedContainerList()

Clone a list of active containers

Returns:

the active containers at the time the call was made

getNumOwnedContainers

int getNumOwnedContainers()

Get the number of active containers

Returns:

the number of active containers the time the call was made

getOwnedContainer

RoleInstance getOwnedContainer(org.apache.hadoop.yarn.api.records.ContainerId id)

Get any active container with the given ID

Parameters:

id - container Id

Returns:

the active container or null if it is not found

getOwnedContainer

RoleInstance getOwnedContainer(String id)
                               throws NoSuchNodeException

Get any active container with the given ID

Parameters:

id - container Id

Returns:

the active container or null if it is not found

Throws:

NoSuchNodeException

cloneLiveContainerInfoList

List<RoleInstance> cloneLiveContainerInfoList()

Create a clone of the list of live cluster nodes.

Returns:

the list of nodes, may be empty

getLiveInstanceByContainerID

RoleInstance getLiveInstanceByContainerID(String containerId)
                                          throws NoSuchNodeException

Get the RoleInstance details on a container. This is an O(n) operation

Parameters:

containerId - the container ID

Returns:

null if there is no such node

Throws:

NoSuchNodeException - if the node cannot be found

getLiveInstancesByContainerIDs

List<RoleInstance> getLiveInstancesByContainerIDs(Collection<String> containerIDs)

Get the details on a list of instaces referred to by ID. Unknown nodes are not returned Important: the order of the results are undefined

Parameters:

containerIDs - the containers

Returns:

list of instances

refreshClusterStatus

ClusterDescription refreshClusterStatus()

Update the cluster description with anything interesting

cloneRoleStatusList

List<RoleStatus> cloneRoleStatusList()

Get a deep clone of the role status list. Concurrent events may mean this list (or indeed, some of the role status entries) may be inconsistent

Returns:

a snapshot of the role status entries

getApplicationLivenessInformation

ApplicationLivenessInformation getApplicationLivenessInformation()

get application liveness information

Returns:

a snapshot of the current liveness information

getLiveStatistics

Map<String,Integer> getLiveStatistics()

Get the live statistics map

Returns:

a map of statistics values, defined in the StatusKeys keylist.

getComponentInfoSnapshot

Map<String,ComponentInformation> getComponentInfoSnapshot()

Get a snapshot of component information.

This does not include any container list, which is more expensive to create.

Returns:

a map of current role status values.

getRoleClusterNodeMapping

Map<String,Map<String,ClusterNode>> getRoleClusterNodeMapping()

Find out about the nodes for specific roles

Returns:

enumLiveInstancesInRole

List<RoleInstance> enumLiveInstancesInRole(String role)

Enum all role instances by role.

Parameters:

role - role, or "" for all roles

Returns:

a list of instances, may be empty

lookupRoleContainers

List<RoleInstance> lookupRoleContainers(String component)

Look up all containers of a specific component name

Parameters:

component - component/role name

Returns:

list of instances. This is a snapshot

getComponentInformation

ComponentInformation getComponentInformation(String component)

Get the JSON serializable information about a component

Parameters:

component - component to look up

Returns:

a structure describing the component.

getNodeInformationSnapshot

Map<String,NodeInformation> getNodeInformationSnapshot()

Get a clone of the nodemap. The instances inside are not cloned

Returns:

a possibly empty map of hostname top info

getNodeInformation

NodeInformation getNodeInformation(String hostname)

get information on a node

Parameters:

hostname - hostname to look up

Returns:

the information, or null if there is no information held.

getRoleStatistics

RoleStatistics getRoleStatistics()

Get the aggregate statistics across all roles

Returns:

role statistics