FileDocCategorySizeDatePackage
ProgressObject.javaAPI DocGlassfish v2 API5266Fri May 04 22:35:52 BST 2007javax.enterprise.deploy.spi.status

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.

Fields Summary
Constructors Summary
Methods Summary
public voidaddProgressListener(ProgressListener pol)
Add a listener to receive Progress events on deployment actions.

param
pol the listener to receive events
see
ProgressEvent

public voidcancel()
(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 this optional command is not supported by this implementation.

public ClientConfigurationgetClientConfiguration(javax.enterprise.deploy.spi.TargetModuleID id)
Return the ClientConfiguration object associated with the TargetModuleID.

return
ClientConfiguration for a given TargetModuleID or null if none exists.

public DeploymentStatusgetDeploymentStatus()
Retrieve the status of this activity.

return
An object containing the status information.

public javax.enterprise.deploy.spi.TargetModuleID[]getResultTargetModuleIDs()
Retrieve the list of TargetModuleIDs successfully processed or created by the associated DeploymentManager operation.

return
a list of TargetModuleIDs.

public booleanisCancelSupported()
Tests whether the vendor supports a cancel opertation for deployment activities.

return
true if canceling an activity is supported by this platform.

public booleanisStopSupported()
Tests whether the vendor supports a stop opertation for deployment activities.

return
true if canceling an activity is supported by this platform.

public voidremoveProgressListener(ProgressListener pol)
Remove a ProgressObject listener.

param
pol the listener being removed
see
ProgressEvent

public voidstop()
(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 this optional command is not supported by this implementation.