Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.deployment.spi.status
Class ProgressObjectImpl

java.lang.Object
  extended byorg.jboss.deployment.spi.status.ProgressObjectImpl
All Implemented Interfaces:
ProgressObject (src)
public class ProgressObjectImpl
extends java.lang.Object
implements ProgressObject (src)

The ProgressObject interface tracks and reports the progress of the deployment activities, distribute, start, stop, undeploy.

Constructor Summary
ProgressObjectImpl(DeploymentStatus (src)  deploymentStatus, TargetModuleID (src) [] targetModules)
           
 
Method Summary
 void addProgressListener(ProgressListener (src)  listener)
          Add a progress listener
 void cancel()
          Cancels the deployment
 ClientConfiguration (src) getClientConfiguration(TargetModuleID (src)  id)
          Return the client configuration associated with the module
 DeploymentStatus (src) getDeploymentStatus()
          Retrieve the status of the deployment
 TargetModuleID (src) [] getResultTargetModuleIDs()
          Retrieve the resulting target module ids
 boolean isCancelSupported()
          Is cancel supported
 boolean isStopSupported()
          Is stop supported
 void removeProgressListener(ProgressListener (src)  listener)
          Remove a progress listener
 void sendProgressEvent(StateType (src)  stateType, java.lang.String message, TargetModuleID (src)  moduleID)
          Set the current deployment status
 void stop()
          Stops the deployment
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressObjectImpl

public ProgressObjectImpl(DeploymentStatus (src)  deploymentStatus,
                          TargetModuleID (src) [] targetModules)
Method Detail

sendProgressEvent

public void sendProgressEvent(StateType (src)  stateType,
                              java.lang.String message,
                              TargetModuleID (src)  moduleID)
Set the current deployment status

getDeploymentStatus

public DeploymentStatus (src)  getDeploymentStatus()
Retrieve the status of the deployment

Specified by:
getDeploymentStatus in interface ProgressObject (src)
Returns:
the status

getResultTargetModuleIDs

public TargetModuleID (src) [] getResultTargetModuleIDs()
Retrieve the resulting target module ids

Specified by:
getResultTargetModuleIDs in interface ProgressObject (src)
Returns:
the module ids

getClientConfiguration

public ClientConfiguration (src)  getClientConfiguration(TargetModuleID (src)  id)
Return the client configuration associated with the module

Specified by:
getClientConfiguration in interface ProgressObject (src)
Parameters:
id - the module id
Returns:
the client configuration or null if none exists

isCancelSupported

public boolean isCancelSupported()
Is cancel supported

Specified by:
isCancelSupported in interface ProgressObject (src)
Returns:
true when cancel is supported, false otherwise

cancel

public void cancel()
            throws OperationUnsupportedException (src)
Cancels the deployment

Specified by:
cancel in interface ProgressObject (src)
Throws:
OperationUnsupportedException (src) - when cancel is not supported

isStopSupported

public boolean isStopSupported()
Is stop supported

Specified by:
isStopSupported in interface ProgressObject (src)
Returns:
true when stop is supported, false otherwise

stop

public void stop()
          throws OperationUnsupportedException (src)
Stops the deployment

Specified by:
stop in interface ProgressObject (src)
Throws:
OperationUnsupportedException (src) - when stop is not supported

addProgressListener

public void addProgressListener(ProgressListener (src)  listener)
Add a progress listener

Specified by:
addProgressListener in interface ProgressObject (src)
Parameters:
listener - the listener

removeProgressListener

public void removeProgressListener(ProgressListener (src)  listener)
Remove a progress listener

Specified by:
removeProgressListener in interface ProgressObject (src)
Parameters:
listener - the listener
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD