ProgressObject

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> enterprise >> deploy >> spi >> [ status overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of javax.enterprise.deploy.spi.status.ProgressObject

SOURCE |

Download javax.enterprise.deploy.spi.status.ProgressObject

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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.

Version:: $Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $

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(javax.enterprise.deploy.spi.TargetModuleID id)
          Return the ClientConfiguration object associated with the TargetModuleID.

DeploymentStatus getDeploymentStatus()
          Retrieve the status of this activity.

javax.enterprise.deploy.spi.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

getDeploymentStatus

public DeploymentStatus getDeploymentStatus()

Retrieve the status of this activity.

getResultTargetModuleIDs

public javax.enterprise.deploy.spi.TargetModuleID[] getResultTargetModuleIDs()

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

getClientConfiguration

public ClientConfiguration getClientConfiguration(javax.enterprise.deploy.spi.TargetModuleID id)

Return the ClientConfiguration object associated with the TargetModuleID.

isCancelSupported

public boolean isCancelSupported()

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

cancel

public void cancel()
            throws javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException

(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.

isStopSupported

public boolean isStopSupported()

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

stop

public void stop()
          throws javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException

(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.

addProgressListener

public void addProgressListener(ProgressListener pol)

Add a listener to receive progress events on deployment actions.

removeProgressListener

public void removeProgressListener(ProgressListener pol)

Remove a progress listener.