org.apache.slider.client.ipc

Class SliderApplicationIpcClient

java.lang.Object

org.apache.slider.client.ipc.SliderApplicationIpcClient

All Implemented Interfaces:

SliderApplicationApi

public class SliderApplicationIpcClient
extends Object
implements SliderApplicationApi

Implementation of the Slider RESTy Application API over IPC.

Operations are executed via the SliderClusterOperations instance passed in; raised exceptions may be converted into ones consistent with the REST API.

Constructor Summary

Constructors

Constructor and Description
SliderApplicationIpcClient(SliderClusterOperations operations)
SliderApplicationIpcClient(SliderClusterProtocol proxy)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,ComponentInformation>	enumComponents() List all components into a map of [name:info]
Map<String,ContainerInformation>	enumContainers() Get a map of live containers [containerId:info]
ApplicationLivenessInformation	getApplicationLiveness() Get the application liveness
ComponentInformation	getComponent(String componentName) Get information about a component
ContainerInformation	getContainer(String containerId) Get a container from the container Id
ConfTreeOperations	getDesiredAppconf() Get the desired application configuration
AggregateConf	getDesiredModel() Get the aggregate desired model
ConfTreeOperations	getDesiredResources() Get the desired YARN resources
NodeInformation	getLiveNode(String hostname) Get information about a node
NodeInformationList	getLiveNodes() List all nodes into a map of [name:info]
ConfTreeOperations	getLiveResources() Get the live YARN resources
ConfTreeOperations	getResolvedAppconf() Get the resolved application configuration
AggregateConf	getResolvedModel() Get the aggregate resolved model
ConfTreeOperations	getResolvedResources() Get the resolved YARN resources
PingInformation	ping(String text) Ping as a GET
void	putDesiredResources(ConfTree updated) Put an updated resources structure.
void	stop(String text) Stop the AM (async operation)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SliderApplicationIpcClient

public SliderApplicationIpcClient(SliderClusterOperations operations)

SliderApplicationIpcClient

public SliderApplicationIpcClient(SliderClusterProtocol proxy)

Method Detail

getDesiredModel

public AggregateConf getDesiredModel()
                              throws IOException

Description copied from interface: SliderApplicationApi

Get the aggregate desired model

Specified by:

getDesiredModel in interface SliderApplicationApi

Returns:

the aggregate configuration of what was asked for -before resolution has taken place

Throws:

IOException - on any failure

getDesiredAppconf

public ConfTreeOperations getDesiredAppconf()
                                     throws IOException

Description copied from interface: SliderApplicationApi

Get the desired application configuration

Specified by:

getDesiredAppconf in interface SliderApplicationApi

Returns:

the application configuration asked for -before resolution has taken place

Throws:

IOException - on any failure

getDesiredResources

public ConfTreeOperations getDesiredResources()
                                       throws IOException

Description copied from interface: SliderApplicationApi

Get the desired YARN resources

Specified by:

getDesiredResources in interface SliderApplicationApi

Returns:

the resources asked for -before resolution has taken place

Throws:

IOException - on any failure

putDesiredResources

public void putDesiredResources(ConfTree updated)
                         throws IOException

Description copied from interface: SliderApplicationApi

Put an updated resources structure. This triggers a cluster flex operation

Specified by:

putDesiredResources in interface SliderApplicationApi

Parameters:

updated - updated resources

Throws:

IOException - on any problem.

getResolvedModel

public AggregateConf getResolvedModel()
                               throws IOException

Description copied from interface: SliderApplicationApi

Get the aggregate resolved model

Specified by:

getResolvedModel in interface SliderApplicationApi

Returns:

the aggregate configuration of what was asked for -after resolution has taken place

Throws:

IOException - on any failure

getResolvedAppconf

public ConfTreeOperations getResolvedAppconf()
                                      throws IOException

Description copied from interface: SliderApplicationApi

Get the resolved application configuration

Specified by:

getResolvedAppconf in interface SliderApplicationApi

Returns:

the application configuration asked for -after resolution has taken place

Throws:

IOException - on any failure

getResolvedResources

public ConfTreeOperations getResolvedResources()
                                        throws IOException

Description copied from interface: SliderApplicationApi

Get the resolved YARN resources

Specified by:

getResolvedResources in interface SliderApplicationApi

Returns:

the resources asked for -after resolution has taken place

Throws:

IOException - on any failure

getLiveResources

public ConfTreeOperations getLiveResources()
                                    throws IOException

Description copied from interface: SliderApplicationApi

Get the live YARN resources

Specified by:

getLiveResources in interface SliderApplicationApi

Returns:

the live set of resources in the cluster

Throws:

IOException - on any failure

enumContainers

public Map<String,ContainerInformation> enumContainers()
                                                throws IOException

Description copied from interface: SliderApplicationApi

Get a map of live containers [containerId:info]

Specified by:

enumContainers in interface SliderApplicationApi

Returns:

a possibly empty list of serialized containers

Throws:

IOException - on any failure

getContainer

public ContainerInformation getContainer(String containerId)
                                  throws IOException

Description copied from interface: SliderApplicationApi

Get a container from the container Id

Specified by:

getContainer in interface SliderApplicationApi

Parameters:

containerId - YARN container ID

Returns:

the container information

Throws:

IOException - on any failure

enumComponents

public Map<String,ComponentInformation> enumComponents()
                                                throws IOException

Description copied from interface: SliderApplicationApi

List all components into a map of [name:info]

Specified by:

enumComponents in interface SliderApplicationApi

Returns:

a possibly empty map of components

Throws:

IOException - on any failure

getComponent

public ComponentInformation getComponent(String componentName)
                                  throws IOException

Description copied from interface: SliderApplicationApi

Get information about a component

Specified by:

getComponent in interface SliderApplicationApi

Parameters:

componentName - name of the component

Returns:

the component details

Throws:

IOException - on any failure

getLiveNodes

public NodeInformationList getLiveNodes()
                                 throws IOException

Description copied from interface: SliderApplicationApi

List all nodes into a map of [name:info]

Specified by:

getLiveNodes in interface SliderApplicationApi

Returns:

a possibly empty list of nodes

Throws:

IOException - on any failure

getLiveNode

public NodeInformation getLiveNode(String hostname)
                            throws IOException

Description copied from interface: SliderApplicationApi

Get information about a node

Specified by:

getLiveNode in interface SliderApplicationApi

Parameters:

hostname - name of the node

Returns:

the node details

Throws:

IOException - on any failure

ping

public PingInformation ping(String text)
                     throws IOException

Description copied from interface: SliderApplicationApi

Ping as a GET

Specified by:

ping in interface SliderApplicationApi

Parameters:

text - text to include

Returns:

the response

Throws:

IOException - on any failure

stop

public void stop(String text)
          throws IOException

Description copied from interface: SliderApplicationApi

Stop the AM (async operation)

Specified by:

stop in interface SliderApplicationApi

Parameters:

text - text to include

Throws:

IOException - on any failure

getApplicationLiveness

public ApplicationLivenessInformation getApplicationLiveness()
                                                      throws IOException

Description copied from interface: SliderApplicationApi

Get the application liveness

Specified by:

getApplicationLiveness in interface SliderApplicationApi

Returns:

current liveness information

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object