net.roboconf.dm.rest.client.delegates

Class ApplicationWsDelegate

java.lang.Object

net.roboconf.dm.rest.client.delegates.ApplicationWsDelegate

public class ApplicationWsDelegate
extends Object

Author:

Vincent Zurczak - Linagora

Constructor Summary

Constructors

Constructor and Description
ApplicationWsDelegate(com.sun.jersey.api.client.WebResource resource) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addInstance(String applicationName, String parentInstancePath, net.roboconf.core.model.beans.Instance instance) Adds an instance into an application.
void	bindApplication(String applicationName, String boundTplName, String boundApp) Binds an application for external exports.
void	changeInstanceState(String applicationName, net.roboconf.core.model.beans.Instance.InstanceStatus newStatus, String instancePath) Changes the state of an instance.
void	deployAndStartAll(String applicationName, String instancePath) Deploys and starts several instances at once.
List<net.roboconf.core.model.beans.Component>	findComponentAncestors(String applicationName, String componentName) Finds the instances on which you could deploy a new instance of a component.
List<net.roboconf.core.model.beans.Component>	findComponentChildren(String applicationName, String componentName) Finds the component names you could instantiate and deploy on an existing instance.
List<String>	listAllCommands(String applicationName) Lists application commands.
List<net.roboconf.core.model.beans.Component>	listAllComponents(String applicationName) Lists all the components from a given application.
List<net.roboconf.core.model.beans.Instance>	listChildrenInstances(String applicationName, String instancePath, boolean all) Lists all the children of an instance.
void	removeInstance(String applicationName, String instancePath) Removes an instance.
void	resynchronize(String applicationName) Resynchronizes all the instances / agents.
void	setDescription(String applicationName, String newDesc) Changes the description of an application.
void	stopAll(String applicationName, String instancePath) Stops several instances at once.
void	undeployAll(String applicationName, String instancePath) Undeploys several instances at once.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationWsDelegate

public ApplicationWsDelegate(com.sun.jersey.api.client.WebResource resource)

Constructor.

Parameters:

resource - a web resource

Method Detail

changeInstanceState

public void changeInstanceState(String applicationName,
                                net.roboconf.core.model.beans.Instance.InstanceStatus newStatus,
                                String instancePath)
                         throws ApplicationWsException

Changes the state of an instance.

Notice that these actions, like of most of the others, are performed asynchronously. It means invoking these REST operations is equivalent to submitting a request. How it will be processed concretely will depend then on the agent.

Parameters:

applicationName - the application name

newStatus - the new state of the instance

instancePath - the instance path (not null)

Throws:

ApplicationWsException - if something went wrong

setDescription

public void setDescription(String applicationName,
                           String newDesc)
                    throws ApplicationWsException

Changes the description of an application.

Parameters:

applicationName - the application name

newDesc - the new description to set

Throws:

ApplicationWsException - if something went wrong

deployAndStartAll

public void deployAndStartAll(String applicationName,
                              String instancePath)
                       throws ApplicationWsException

Deploys and starts several instances at once.

Parameters:

applicationName - the application name

instancePath - the instance path (null for all the application instances)

Throws:

ApplicationWsException - if something went wrong

stopAll

public void stopAll(String applicationName,
                    String instancePath)
             throws ApplicationWsException

Stops several instances at once.

Parameters:

applicationName - the application name

instancePath - the path of the instance to stop (null for all the application instances)

Throws:

ApplicationWsException - if something went wrong

undeployAll

public void undeployAll(String applicationName,
                        String instancePath)
                 throws ApplicationWsException

Undeploys several instances at once.

Parameters:

applicationName - the application name

instancePath - the path of the instance to undeploy (null for all the application instances)

Throws:

ApplicationWsException - if something went wrong

listChildrenInstances

public List<net.roboconf.core.model.beans.Instance> listChildrenInstances(String applicationName,
                                                                          String instancePath,
                                                                          boolean all)

Lists all the children of an instance.

Parameters:

applicationName - the application name

instancePath - the instance path (null to get root instances)

all - true to list indirect children too, false to only list direct children

Returns:

a non-null list of instance paths

addInstance

public void addInstance(String applicationName,
                        String parentInstancePath,
                        net.roboconf.core.model.beans.Instance instance)
                 throws ApplicationWsException

Adds an instance into an application.

Parameters:

applicationName - the application name

parentInstancePath - the path of the parent instance (null to create a root instance)

instance - the instance to add

Throws:

ApplicationWsException - if a problem occurred with the instance management

removeInstance

public void removeInstance(String applicationName,
                           String instancePath)

Removes an instance.

Parameters:

applicationName - the application name

instancePath - the path of the instance to remove

resynchronize

public void resynchronize(String applicationName)

Resynchronizes all the instances / agents.

Parameters:

applicationName - the application name

listAllComponents

public List<net.roboconf.core.model.beans.Component> listAllComponents(String applicationName)

Lists all the components from a given application.

Parameters:

applicationName - the application name

Returns:

a non-null list of components

findComponentChildren

public List<net.roboconf.core.model.beans.Component> findComponentChildren(String applicationName,
                                                                           String componentName)

Finds the component names you could instantiate and deploy on an existing instance.

Parameters:

applicationName - the application name

componentName - a component name (null to get root components)

Returns:

a non-null list of component names

findComponentAncestors

public List<net.roboconf.core.model.beans.Component> findComponentAncestors(String applicationName,
                                                                            String componentName)

Finds the instances on which you could deploy a new instance of a component.

Parameters:

applicationName - the application name

componentName - a component name

Returns:

a non-null list of instance paths

bindApplication

public void bindApplication(String applicationName,
                            String boundTplName,
                            String boundApp)
                     throws ApplicationWsException

Binds an application for external exports.

Parameters:

applicationName - the application name

boundTplName - the template name (no qualifier as it does not make sense for external exports)

boundApp - the name of the application (instance of tplName)

Throws:

ApplicationWsException - if something went wrong

listAllCommands

public List<String> listAllCommands(String applicationName)

Lists application commands.

Parameters:

applicationName - an application name

Returns:

a non-null list of command names