javax.enterprise.deploy.spi.status

Interface ProgressObject

public interface ProgressObject

The ProgressObject interface tracks and reports the progress of the deployment activities: distribute, start, stop, undeploy. This class has an optional cancel method. The support of the cancel function can be tested by the isCancelSupported method. The ProgressObject structure allows the user the option of polling for status or to provide a callback.

Method Summary
void	addProgressListener(ProgressListener pol) Add a listener to receive progress events on deployment actions.
void	cancel() (optional) A cancel request on an in-process operation stops all further processing of the operation and returns the environment to it original state before the operation was executed.
ClientConfiguration	getClientConfiguration(TargetModuleID id) Return the ClientConfiguration object associated with the TargetModuleID.
DeploymentStatus	getDeploymentStatus() Retrieve the status of this activity.
TargetModuleID[]	getResultTargetModuleIDs() Retrieve the list of TargetModuleIDs successfully processed or created by the associated DeploymentManager operation.
boolean	isCancelSupported() Tests whether the vendor supports a cancel operation for this deployment action.
boolean	isStopSupported() Tests whether the vendor supports a stop operation for the deployment action.
void	removeProgressListener(ProgressListener pol) Remove a progress listener.
void	stop() (optional) A stop request on an in-process operation allows the operation on the current TargetModuleID to run to completion but does not process any of the remaining unprocessed TargetModuleID objects.

Method Detail

addProgressListener

public void addProgressListener(ProgressListener pol)

Add a listener to receive progress events on deployment actions.

Parameters: pol the listener to receive events

cancel

public void cancel()

(optional) A cancel request on an in-process operation stops all further processing of the operation and returns the environment to it original state before the operation was executed. An operation that has run to completion cannot be cancelled.

Throws: OperationUnsupportedException occurs when this optional command is not supported by this implementation.

getClientConfiguration

public ClientConfiguration getClientConfiguration(TargetModuleID id)

Return the ClientConfiguration object associated with the TargetModuleID.

Returns: ClientConfiguration for a given TargetModuleID or null if none exists.

getDeploymentStatus

public DeploymentStatus getDeploymentStatus()

Retrieve the status of this activity.

Returns: An object containing the status information.

getResultTargetModuleIDs

public TargetModuleID[] getResultTargetModuleIDs()

Retrieve the list of TargetModuleIDs successfully processed or created by the associated DeploymentManager operation.

Returns: a list of TargetModuleIDs.

isCancelSupported

public boolean isCancelSupported()

Tests whether the vendor supports a cancel operation for this deployment action.

Returns: true if this platform allows this action to be canceled.

isStopSupported

public boolean isStopSupported()

Tests whether the vendor supports a stop operation for the deployment action.

Returns: true if this platform allows this action to be stopped.

removeProgressListener

public void removeProgressListener(ProgressListener pol)

Remove a progress listener.

Parameters: pol the listener to remove

stop

public void stop()

(optional) A stop request on an in-process operation allows the operation on the current TargetModuleID to run to completion but does not process any of the remaining unprocessed TargetModuleID objects. The processed TargetModuleIDs must be returned by the method getResultTargetModuleIDs.

Throws: OperationUnsupportedException occurs when this optional command is not supported by this implementation.