ProviderAppState (Slider Core 0.90.2-incubating API)

java.lang.Object
- org.apache.slider.server.appmaster.state.ProviderAppState

All Implemented Interfaces:

StateAccessForProviders
```
public class ProviderAppState
extends Object
implements StateAccessForProviders
```
Implementation of StateAccessForProviders, which means state access for providers, web UI and IPC/REST views.

Constructor Summary

Constructors
Constructor and Description

ProviderAppState(String applicationName, AppState appState)

Constructors
Constructor and Description
`ProviderAppState(String applicationName, AppState appState)`

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
`void`	`setApplicationName(String applicationName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProviderAppState
```
public ProviderAppState(String applicationName,
                AppState appState)
```
- Method Detail
  - setApplicationName
```
public void setApplicationName(String applicationName)
```
  - getApplicationName
```
public String getApplicationName()
```
    Description copied from interface: StateAccessForProviders
    
    Get the name of the application
    
    Specified by:
    
    getApplicationName in interface StateAccessForProviders
    
    Returns:
    the name
  - getPublishedSliderConfigurations
```
public PublishedConfigSet getPublishedSliderConfigurations()
```
    Description copied from interface: StateAccessForProviders
    
    Get the published configurations
    
    Specified by:
    
    getPublishedSliderConfigurations in interface StateAccessForProviders
    
    Returns:
    the configuration set
  - getPublishedExportsSet
```
public PublishedExportsSet getPublishedExportsSet()
```
    Description copied from interface: StateAccessForProviders
    
    Get the published exports set
    
    Specified by:
    
    getPublishedExportsSet in interface StateAccessForProviders
    
    Returns:
  - getPublishedConfigSet
```
public PublishedConfigSet getPublishedConfigSet(String name)
```
    Description copied from interface: StateAccessForProviders
    
    Get a named published config set
    
    Specified by:
    
    getPublishedConfigSet in interface StateAccessForProviders
    
    Parameters:
    name - name to look up
    
    Returns:
    the instance or null
  - getOrCreatePublishedConfigSet
```
public PublishedConfigSet getOrCreatePublishedConfigSet(String name)
```
    Description copied from interface: StateAccessForProviders
    
    Get a named published config set, creating it if need be.
    
    Specified by:
    
    getOrCreatePublishedConfigSet in interface StateAccessForProviders
    
    Parameters:
    name - name to look up
    
    Returns:
    the instance -possibly a new one
  - listConfigSets
```
public List<String> listConfigSets()
```
    Description copied from interface: StateAccessForProviders
    
    List the config sets -this takes a clone of the current set
    
    Specified by:
    
    listConfigSets in interface StateAccessForProviders
    
    Returns:
    a list of config sets
  - getRoleStatusMap
```
public Map<Integer,RoleStatus> getRoleStatusMap()
```
    Description copied from interface: StateAccessForProviders
    
    Get a map of role status entries by role Id
    
    Specified by:
    
    getRoleStatusMap in interface StateAccessForProviders
    
    Returns:
    the map of currently defined roles.
  - getFailedContainers
```
public Map<org.apache.hadoop.yarn.api.records.ContainerId,RoleInstance> getFailedContainers()
```
    Description copied from interface: StateAccessForProviders
    
    Get a map of all the failed containers
    
    Specified by:
    
    getFailedContainers in interface StateAccessForProviders
    
    Returns:
    map of recorded failed containers
  - getLiveContainers
```
public Map<org.apache.hadoop.yarn.api.records.ContainerId,RoleInstance> getLiveContainers()
```
    Description copied from interface: StateAccessForProviders
    
    Get the live containers.
    
    Specified by:
    
    getLiveContainers in interface StateAccessForProviders
    
    Returns:
    the live nodes
  - getClusterStatus
```
public ClusterDescription getClusterStatus()
```
    Description copied from interface: StateAccessForProviders
    
    Get the current cluster description
    
    Specified by:
    
    getClusterStatus in interface StateAccessForProviders
    
    Returns:
    the actual state of the cluster
  - getResourcesSnapshot
```
public ConfTreeOperations getResourcesSnapshot()
```
    Description copied from interface: StateAccessForProviders
    
    Get at the snapshot of the resource config Changes here do not affect the application state.
    
    Specified by:
    
    getResourcesSnapshot in interface StateAccessForProviders
    
    Returns:
    the most recent settings
  - getAppConfSnapshot
```
public ConfTreeOperations getAppConfSnapshot()
```
    Description copied from interface: StateAccessForProviders
    
    Get at the snapshot of the appconf config Changes here do not affect the application state.
    
    Specified by:
    
    getAppConfSnapshot in interface StateAccessForProviders
    
    Returns:
    the most recent settings
  - getInternalsSnapshot
```
public ConfTreeOperations getInternalsSnapshot()
```
    Description copied from interface: StateAccessForProviders
    
    Get at the snapshot of the internals config. Changes here do not affect the application state.
    
    Specified by:
    
    getInternalsSnapshot in interface StateAccessForProviders
    
    Returns:
    the internals settings
  - isApplicationLive
```
public boolean isApplicationLive()
```
    Description copied from interface: StateAccessForProviders
    
    Flag set to indicate the application is live -this only happens after the buildInstance operation
    
    Specified by:
    
    isApplicationLive in interface StateAccessForProviders
  - getSnapshotTime
```
public long getSnapshotTime()
```
    Specified by:
    
    getSnapshotTime in interface StateAccessForProviders
  - getInstanceDefinitionSnapshot
```
public AggregateConf getInstanceDefinitionSnapshot()
```
    Description copied from interface: StateAccessForProviders
    
    Get a snapshot of the entire aggregate configuration
    
    Specified by:
    
    getInstanceDefinitionSnapshot in interface StateAccessForProviders
    
    Returns:
    the aggregate configuration
  - getUnresolvedInstanceDefinition
```
public AggregateConf getUnresolvedInstanceDefinition()
```
    Description copied from interface: StateAccessForProviders
    
    Get the desired/unresolved value
    
    Specified by:
    
    getUnresolvedInstanceDefinition in interface StateAccessForProviders
    
    Returns:
    unresolved
  - lookupRoleStatus
```
public RoleStatus lookupRoleStatus(int key)
```
    Description copied from interface: StateAccessForProviders
    
    Look up a role from its key -or fail
    
    Specified by:
    
    lookupRoleStatus in interface StateAccessForProviders
    
    Parameters:
    key - key to resolve
    
    Returns:
    the status
  - lookupRoleStatus
```
public RoleStatus lookupRoleStatus(org.apache.hadoop.yarn.api.records.Container c)
                            throws org.apache.hadoop.yarn.exceptions.YarnRuntimeException
```
    Description copied from interface: StateAccessForProviders
    
    Look up a role from its key -or fail
    
    Specified by:
    
    lookupRoleStatus in interface StateAccessForProviders
    
    Parameters:
    c - container in a role
    
    Returns:
    the status
    
    Throws:
    
    org.apache.hadoop.yarn.exceptions.YarnRuntimeException - on no match
  - lookupRoleStatus
```
public RoleStatus lookupRoleStatus(String name)
                            throws org.apache.hadoop.yarn.exceptions.YarnRuntimeException
```
    Description copied from interface: StateAccessForProviders
    
    Look up a role from its key -or fail
    
    Specified by:
    
    lookupRoleStatus in interface StateAccessForProviders
    
    Parameters:
    name - container in a role
    
    Returns:
    the status
    
    Throws:
    
    org.apache.hadoop.yarn.exceptions.YarnRuntimeException - on no match
  - cloneOwnedContainerList
```
public List<RoleInstance> cloneOwnedContainerList()
```
    Description copied from interface: StateAccessForProviders
    
    Clone a list of active containers
    
    Specified by:
    
    cloneOwnedContainerList in interface StateAccessForProviders
    
    Returns:
    the active containers at the time the call was made
  - getNumOwnedContainers
```
public int getNumOwnedContainers()
```
    Description copied from interface: StateAccessForProviders
    
    Get the number of active containers
    
    Specified by:
    
    getNumOwnedContainers in interface StateAccessForProviders
    
    Returns:
    the number of active containers the time the call was made
  - getOwnedContainer
```
public RoleInstance getOwnedContainer(org.apache.hadoop.yarn.api.records.ContainerId id)
```
    Description copied from interface: StateAccessForProviders
    
    Get any active container with the given ID
    
    Specified by:
    
    getOwnedContainer in interface StateAccessForProviders
    
    Parameters:
    id - container Id
    
    Returns:
    the active container or null if it is not found
  - getOwnedContainer
```
public RoleInstance getOwnedContainer(String id)
                               throws NoSuchNodeException
```
    Description copied from interface: StateAccessForProviders
    
    Get any active container with the given ID
    
    Specified by:
    
    getOwnedContainer in interface StateAccessForProviders
    
    Parameters:
    id - container Id
    
    Returns:
    the active container or null if it is not found
    
    Throws:
    
    NoSuchNodeException
  - cloneLiveContainerInfoList
```
public List<RoleInstance> cloneLiveContainerInfoList()
```
    Description copied from interface: StateAccessForProviders
    
    Create a clone of the list of live cluster nodes.
    
    Specified by:
    
    cloneLiveContainerInfoList in interface StateAccessForProviders
    
    Returns:
    the list of nodes, may be empty
  - getLiveInstanceByContainerID
```
public RoleInstance getLiveInstanceByContainerID(String containerId)
                                          throws NoSuchNodeException
```
    Description copied from interface: StateAccessForProviders
    
    Get the RoleInstance details on a container. This is an O(n) operation
    
    Specified by:
    
    getLiveInstanceByContainerID in interface StateAccessForProviders
    
    Parameters:
    containerId - the container ID
    
    Returns:
    null if there is no such node
    
    Throws:
    
    NoSuchNodeException - if the node cannot be found
  - getLiveInstancesByContainerIDs
```
public List<RoleInstance> getLiveInstancesByContainerIDs(Collection<String> containerIDs)
```
    Description copied from interface: StateAccessForProviders
    
    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
    
    Specified by:
    
    getLiveInstancesByContainerIDs in interface StateAccessForProviders
    
    Parameters:
    containerIDs - the containers
    
    Returns:
    list of instances
  - refreshClusterStatus
```
public ClusterDescription refreshClusterStatus()
```
    Description copied from interface: StateAccessForProviders
    
    Update the cluster description with anything interesting
    
    Specified by:
    
    refreshClusterStatus in interface StateAccessForProviders
  - cloneRoleStatusList
```
public List<RoleStatus> cloneRoleStatusList()
```
    Description copied from interface: StateAccessForProviders
    
    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
    
    Specified by:
    
    cloneRoleStatusList in interface StateAccessForProviders
    
    Returns:
    a snapshot of the role status entries
  - getApplicationLivenessInformation
```
public ApplicationLivenessInformation getApplicationLivenessInformation()
```
    Description copied from interface: StateAccessForProviders
    
    get application liveness information
    
    Specified by:
    
    getApplicationLivenessInformation in interface StateAccessForProviders
    
    Returns:
    a snapshot of the current liveness information
  - getLiveStatistics
```
public Map<String,Integer> getLiveStatistics()
```
    Description copied from interface: StateAccessForProviders
    
    Get the live statistics map
    
    Specified by:
    
    getLiveStatistics in interface StateAccessForProviders
    
    Returns:
    a map of statistics values, defined in the StatusKeys keylist.
  - getComponentInfoSnapshot
```
public Map<String,ComponentInformation> getComponentInfoSnapshot()
```
    Description copied from interface: StateAccessForProviders
    
    Get a snapshot of component information.
    This does not include any container list, which is more expensive to create.
    
    Specified by:
    
    getComponentInfoSnapshot in interface StateAccessForProviders
    
    Returns:
    a map of current role status values.
  - getRoleClusterNodeMapping
```
public Map<String,Map<String,ClusterNode>> getRoleClusterNodeMapping()
```
    Description copied from interface: StateAccessForProviders
    
    Find out about the nodes for specific roles
    
    Specified by:
    
    getRoleClusterNodeMapping in interface StateAccessForProviders
    
    Returns:
  - enumLiveInstancesInRole
```
public List<RoleInstance> enumLiveInstancesInRole(String role)
```
    Description copied from interface: StateAccessForProviders
    
    Enum all role instances by role.
    
    Specified by:
    
    enumLiveInstancesInRole in interface StateAccessForProviders
    
    Parameters:
    role - role, or "" for all roles
    
    Returns:
    a list of instances, may be empty
  - lookupRoleContainers
```
public List<RoleInstance> lookupRoleContainers(String component)
```
    Description copied from interface: StateAccessForProviders
    
    Look up all containers of a specific component name
    
    Specified by:
    
    lookupRoleContainers in interface StateAccessForProviders
    
    Parameters:
    component - component/role name
    
    Returns:
    list of instances. This is a snapshot
  - getComponentInformation
```
public ComponentInformation getComponentInformation(String component)
```
    Description copied from interface: StateAccessForProviders
    
    Get the JSON serializable information about a component
    
    Specified by:
    
    getComponentInformation in interface StateAccessForProviders
    
    Parameters:
    component - component to look up
    
    Returns:
    a structure describing the component.
  - getNodeInformationSnapshot
```
public Map<String,NodeInformation> getNodeInformationSnapshot()
```
    Description copied from interface: StateAccessForProviders
    
    Get a clone of the nodemap. The instances inside are not cloned
    
    Specified by:
    
    getNodeInformationSnapshot in interface StateAccessForProviders
    
    Returns:
    a possibly empty map of hostname top info
  - getNodeInformation
```
public NodeInformation getNodeInformation(String hostname)
```
    Description copied from interface: StateAccessForProviders
    
    get information on a node
    
    Specified by:
    
    getNodeInformation in interface StateAccessForProviders
    
    Parameters:
    hostname - hostname to look up
    
    Returns:
    the information, or null if there is no information held.
  - getRoleStatistics
```
public RoleStatistics getRoleStatistics()
```
    Description copied from interface: StateAccessForProviders
    
    Get the aggregate statistics across all roles
    
    Specified by:
    
    getRoleStatistics in interface StateAccessForProviders
    
    Returns:
    role statistics

Class ProviderAppState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProviderAppState

Method Detail

setApplicationName

getApplicationName

getPublishedSliderConfigurations

getPublishedExportsSet

getPublishedConfigSet

getOrCreatePublishedConfigSet

listConfigSets

getRoleStatusMap

getFailedContainers

getLiveContainers

getClusterStatus

getResourcesSnapshot

getAppConfSnapshot

getInternalsSnapshot

isApplicationLive

getSnapshotTime

getInstanceDefinitionSnapshot

getUnresolvedInstanceDefinition

lookupRoleStatus

lookupRoleStatus

lookupRoleStatus

cloneOwnedContainerList

getNumOwnedContainers

getOwnedContainer

getOwnedContainer

cloneLiveContainerInfoList

getLiveInstanceByContainerID

getLiveInstancesByContainerIDs

refreshClusterStatus

cloneRoleStatusList

getApplicationLivenessInformation

getLiveStatistics

getComponentInfoSnapshot

getRoleClusterNodeMapping

enumLiveInstancesInRole

lookupRoleContainers

getComponentInformation

getNodeInformationSnapshot

getNodeInformation

getRoleStatistics