org.ow2.orchestra.facade
Interface ManagementAPI

All Known Subinterfaces:

RemoteDeployerMBean

public interface ManagementAPI

Management operations.

Author:

Guillaume Porcher

Method Summary

boolean	activate(ProcessDefinitionUUID processDefinitionUUID) Mark the process with the given UUID as retired.
ProcessDefinition	deploy(Deployment deployment) To deploy the package giving the deployment object.
ProcessDefinition	deployBar(byte[] barFile) To deploy a process giving the bytes table of an archive file.
void	deployWebServices(ProcessDefinitionUUID processDefinitionUUID) Deploy web services for the process processDefinitionUUID on this server.
void	initialize() Redeploy all web services.
boolean	isExtensionSupported(String namespace)
void	refreshProcess(ProcessDefinitionUUID processDefinitionUUID) Refresh the process state from the database (used to propagate process information in a cluster).
boolean	remove(ProcessDefinitionUUID processDefinitionUUID) To delete monitoring information on the process giving the uuid of the process.
boolean	retire(ProcessDefinitionUUID processDefinitionUUID) Activate the process with the given uuid.
boolean	undeploy(ProcessDefinitionUUID processDefinitionUUID) To undeploy the process giving the uuid of the process.
boolean	undeploy(QName processQName) To undeploy the process giving the qualified name of the process.
void	undeployWebServices(ProcessDefinitionUUID processDefinitionUUID) Undeploy web services for the process processDefinitionUUID on this server.

Method Detail

deployBar

ProcessDefinition deployBar(byte[] barFile)

To deploy a process giving the bytes table of an archive file.
The archive should contains the .bpel file and the .wsdl files.

Parameters:

barFile - The bytes table of the bar file.

Returns:

The recorded data of the deployed process.

deploy

ProcessDefinition deploy(Deployment deployment)

To deploy the package giving the deployment object.

Parameters:

deployment - The deployment object that should contain the bpel file and the wsdl definitions.

Returns:

The recorded data of the deployed process.

undeploy

boolean undeploy(QName processQName)

To undeploy the process giving the qualified name of the process.

Parameters:

processQName - The qualified name.

Returns:

true if the process has been succesfully undeployed otherwise returns false.

undeploy

boolean undeploy(ProcessDefinitionUUID processDefinitionUUID)

To undeploy the process giving the uuid of the process.

Parameters:

processDefinitionUUID - te uuid of the process

Returns:

true if the process has been succesfully undeployed otherwise returns false.

remove

boolean remove(ProcessDefinitionUUID processDefinitionUUID)

To delete monitoring information on the process giving the uuid of the process.

Parameters:

processDefinitionUUID - te uuid of the process

Returns:

true if the process has been succesfully deleted otherwise returns false.

initialize

void initialize()

Redeploy all web services. Use after a reboot to restore the previous environment.

deployWebServices

void deployWebServices(ProcessDefinitionUUID processDefinitionUUID)

Deploy web services for the process processDefinitionUUID on this server.

Parameters:

processDefinitionUUID -

undeployWebServices

void undeployWebServices(ProcessDefinitionUUID processDefinitionUUID)

Undeploy web services for the process processDefinitionUUID on this server.

Parameters:

processDefinitionUUID -

retire

boolean retire(ProcessDefinitionUUID processDefinitionUUID)
               throws ProcessNotFoundException

Activate the process with the given uuid. All other versions of the process are set to retired state (retire(ProcessDefinitionUUID). New instances of the process will use this version of the process.

Parameters:

processDefinitionUUID - the uuid of the process definition.

Returns:

true if the process has been set to active. false if the process was already active.

Throws:

ProcessNotFoundException - if processDefinitionUUID cannot be found

activate

boolean activate(ProcessDefinitionUUID processDefinitionUUID)
                 throws ProcessNotFoundException

Mark the process with the given UUID as retired. All running instances of the process can continue execution, but no new instances can be created.

Parameters:

processDefinitionUUID - the uuid of the process definition.

Returns:

true if the process has been set to retired. false if the process was already retired.

Throws:

ProcessNotFoundException - if processDefinitionUUID cannot be found

refreshProcess

void refreshProcess(ProcessDefinitionUUID processDefinitionUUID)

Refresh the process state from the database (used to propagate process information in a cluster).

Parameters:

processDefinitionUUID - the uuid of the process definition.

isExtensionSupported

boolean isExtensionSupported(String namespace)

Parameters:

namespace - the namespace of the extension to check.

Returns:

true if this extension is supported by this instance of Orchestra.