javax.enterprise.deploy.spi.status

Interface ProgressObject

public interface ProgressObject

Tracks the progress of a deployment

Version:

$Revision$

Author:

Adrian Brock

Method Summary

Methods

Modifier and Type	Method and Description
void	addProgressListener(ProgressListener listener) Add a progress listener
void	cancel() Cancels the deployment
ClientConfiguration	getClientConfiguration(TargetModuleID id) Return the client configuration associated with the module
DeploymentStatus	getDeploymentStatus() Retrieve the status of the deployment
TargetModuleID[]	getResultTargetModuleIDs() Retrieve the resulting target module ids
boolean	isCancelSupported() Is cancel supported
boolean	isStopSupported() Is stop supported
void	removeProgressListener(ProgressListener listener) Remove a progress listener
void	stop() Stops the deployment

Method Detail

getDeploymentStatus

DeploymentStatus getDeploymentStatus()

Retrieve the status of the deployment

Returns:

the status

getResultTargetModuleIDs

TargetModuleID[] getResultTargetModuleIDs()

Retrieve the resulting target module ids

Returns:

the module ids

getClientConfiguration

ClientConfiguration getClientConfiguration(TargetModuleID id)

Return the client configuration associated with the module

Parameters:

id - the module id

Returns:

the client configuration or null if none exists

isCancelSupported

boolean isCancelSupported()

Is cancel supported

Returns:

true when cancel is supported, false otherwise

cancel

void cancel()
            throws OperationUnsupportedException

Cancels the deployment

Throws:

OperationUnsupportedException - when cancel is not supported

isStopSupported

boolean isStopSupported()

Is stop supported

Returns:

true when stop is supported, false otherwise

stop

void stop()
          throws OperationUnsupportedException

Stops the deployment

Throws:

OperationUnsupportedException - when stop is not supported

addProgressListener

void addProgressListener(ProgressListener listener)

Add a progress listener

Parameters:

listener - the listener

removeProgressListener

void removeProgressListener(ProgressListener listener)

Remove a progress listener

Parameters:

listener - the listener