org.jboss.deployers.client.spi
Interface DeployerClient

All Known Subinterfaces:

MainDeployer

All Known Implementing Classes:

MainDeployerImpl

public interface DeployerClient

DeployerClient.

Version:

$Revision: 1.1 $

Author:

Adrian Brock

Method Summary

void	addDeployment(Deployment deployment) Add a deployment
void	change(String deploymentName, DeploymentStage stage) Change the state of a deployment
void	checkComplete() Check all the deployments are complete
void	checkComplete(Deployment... deployment) Check if deployments are complete
void	checkComplete(String... names) Check if deployments are complete
void	checkStructureComplete(Deployment... deployments) Check if deployments are recognized
void	checkStructureComplete(String... names) Check if deployments are recognized
void	deploy(Deployment... deployments) Deploy the deployments
org.jboss.util.graph.Graph<Map<String,org.jboss.managed.api.ManagedObject>>	getDeepManagedObjects(String name) Get the graph of managed objects starting with the top-level deployment associated with name.
Deployment	getDeployment(String name) Get a deployment
DeploymentStage	getDeploymentStage(String deploymentName) Get the deployment stage for a deployment
DeploymentState	getDeploymentState(String name) Get a the state of deployment
org.jboss.managed.api.ManagedDeployment	getManagedDeployment(String name) Get the managed deployment.
Map<String,org.jboss.managed.api.ManagedObject>	getManagedObjects(String name) Get the managed objects for a deployment context.
Collection<Deployment>	getTopLevel() Get the top level deployments
void	process() Process the outstanding deployments.
boolean	removeDeployment(Deployment deployment) Remove a deployment
boolean	removeDeployment(String name) Remove a deployment by name
void	undeploy(Deployment... deployments) Undeploy the deployments
void	undeploy(String... names) Undeploy a deployments by name

Method Detail

getTopLevel

Collection<Deployment> getTopLevel()

Get the top level deployments

Returns:

the top level deployments

getDeployment

Deployment getDeployment(String name)

Get a deployment

Parameters:

name - the name of the deployment

Returns:

the deployment or null if not found

addDeployment

void addDeployment(Deployment deployment)
                   throws DeploymentException

Add a deployment

Parameters:

deployment - the deployment

Throws:

DeploymentException - for any error

removeDeployment

boolean removeDeployment(Deployment deployment)
                         throws DeploymentException

Remove a deployment

Parameters:

deployment - the deployment to remove

Returns:

false when the context was previously unknown

Throws:

DeploymentException - for any error

removeDeployment

boolean removeDeployment(String name)
                         throws DeploymentException

Remove a deployment by name

Parameters:

name - the name of the deployment

Returns:

false when the context was previously unknown

Throws:

DeploymentException - for any error

process

void process()

Process the outstanding deployments.

deploy

void deploy(Deployment... deployments)
            throws DeploymentException

Deploy the deployments

Parameters:

deployments - the deployments

Throws:

DeploymentException - for any error

undeploy

void undeploy(Deployment... deployments)
              throws DeploymentException

Undeploy the deployments

Parameters:

deployments - the deployments

Throws:

DeploymentException - for any error

change

void change(String deploymentName,
            DeploymentStage stage)
            throws DeploymentException

Change the state of a deployment

Parameters:

deploymentName - the deployment name

stage - the stage

Throws:

DeploymentException - for any error

getDeploymentStage

DeploymentStage getDeploymentStage(String deploymentName)
                                   throws DeploymentException

Get the deployment stage for a deployment

Parameters:

deploymentName - the deployment name

Returns:

the stage

Throws:

DeploymentException - for any error

checkComplete

void checkComplete()
                   throws DeploymentException

Check all the deployments are complete

Throws:

DeploymentException - when some deployment is not complete

checkComplete

void checkComplete(Deployment... deployment)
                   throws DeploymentException

Check if deployments are complete

Parameters:

deployment - the deployment

Throws:

DeploymentException - when some deployments are not complete

checkComplete

void checkComplete(String... names)
                   throws DeploymentException

Check if deployments are complete

Parameters:

names - the deployment name

Throws:

DeploymentException - when some deployments are not complete

checkStructureComplete

void checkStructureComplete(Deployment... deployments)
                            throws DeploymentException

Check if deployments are recognized

Parameters:

deployments - the deployments

Throws:

DeploymentException - when some deployments are not recognized

checkStructureComplete

void checkStructureComplete(String... names)
                            throws DeploymentException

Check if deployments are recognized

Parameters:

names - the deployment names

Throws:

DeploymentException - when some deployments are not recognized

undeploy

void undeploy(String... names)
              throws DeploymentException

Undeploy a deployments by name

Parameters:

names - the names of the deployments

Throws:

DeploymentException - for any error

getDeploymentState

DeploymentState getDeploymentState(String name)

Get a the state of deployment

Parameters:

name - the name of the deployment

Returns:

the deployment state

getManagedObjects

Map<String,org.jboss.managed.api.ManagedObject> getManagedObjects(String name)
                                                                  throws DeploymentException

Get the managed objects for a deployment context. This is a mapping of the attachment names to the associated ManagedObject.

Parameters:

name - the name of the deployment

Returns:

the managed object map keyed by the attachment names.

Throws:

DeploymentException - for any error

getDeepManagedObjects

org.jboss.util.graph.Graph<Map<String,org.jboss.managed.api.ManagedObject>> getDeepManagedObjects(String name)
                                                                                                  throws DeploymentException

Get the graph of managed objects starting with the top-level deployment associated with name.

Parameters:

name - - the name of the top-level DeploymentContext to process.

Returns:

the graph of managed objects for the top-level DeploymentContex and its children.

Throws:

DeploymentException - for any error

getManagedDeployment

org.jboss.managed.api.ManagedDeployment getManagedDeployment(String name)
                                                             throws DeploymentException

Get the managed deployment.

Parameters:

name - the name of the deployment

Returns:

the managed deployment

Throws:

DeploymentException - for any error