当前页面: 在线文档首页 > JBoss 4.0.1 sp1 deployment API Documentation 英文版文档

ProgressObjectImpl (JBoss JSR-88 Deployment API) - JBoss 4.0.1 sp1 deployment API Documentation 英文版文档

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

---

org.jboss.deployment.spi.status
Class ProgressObjectImpl

java.lang.Object
  org.jboss.deployment.spi.status.ProgressObjectImpl

All Implemented Interfaces:

javax.enterprise.deploy.spi.status.ProgressObject

---

public class ProgressObjectImpl

extends Object

implements javax.enterprise.deploy.spi.status.ProgressObject

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

Version:

$Revision: 1.1.1.1 $

Author:

thomas.diesler@jboss.org

---

Constructor Summary

ProgressObjectImpl(javax.enterprise.deploy.spi.status.DeploymentStatus deploymentStatus, javax.enterprise.deploy.spi.TargetModuleID[] targetModules)

 

Method Summary
void	addProgressListener(javax.enterprise.deploy.spi.status.ProgressListener listener)           Add a progress listener
void	cancel()           Cancels the deployment
javax.enterprise.deploy.spi.status.ClientConfiguration	getClientConfiguration(javax.enterprise.deploy.spi.TargetModuleID id)           Return the client configuration associated with the module
javax.enterprise.deploy.spi.status.DeploymentStatus	getDeploymentStatus()           Retrieve the status of the deployment
javax.enterprise.deploy.spi.TargetModuleID[]	getResultTargetModuleIDs()           Retrieve the resulting target module ids
boolean	isCancelSupported()           Is cancel supported
boolean	isStopSupported()           Is stop supported
void	removeProgressListener(javax.enterprise.deploy.spi.status.ProgressListener listener)           Remove a progress listener
void	sendProgressEvent(javax.enterprise.deploy.shared.StateType stateType, String message, javax.enterprise.deploy.spi.TargetModuleID 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(javax.enterprise.deploy.spi.status.DeploymentStatus deploymentStatus,
                          javax.enterprise.deploy.spi.TargetModuleID[] targetModules)

Method Detail

sendProgressEvent

public void sendProgressEvent(javax.enterprise.deploy.shared.StateType stateType,
                              String message,
                              javax.enterprise.deploy.spi.TargetModuleID moduleID)

Set the current deployment status

---

getDeploymentStatus

public javax.enterprise.deploy.spi.status.DeploymentStatus getDeploymentStatus()

Retrieve the status of the deployment

Specified by:

getDeploymentStatus in interface javax.enterprise.deploy.spi.status.ProgressObject

Returns:

the status

---

getResultTargetModuleIDs

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

Retrieve the resulting target module ids

Specified by:

getResultTargetModuleIDs in interface javax.enterprise.deploy.spi.status.ProgressObject

Returns:

the module ids

---

getClientConfiguration

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

Return the client configuration associated with the module

Specified by:

getClientConfiguration in interface javax.enterprise.deploy.spi.status.ProgressObject

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

Returns:

true when cancel is supported, false otherwise

---

cancel

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

Cancels the deployment

Specified by:

cancel in interface javax.enterprise.deploy.spi.status.ProgressObject

Throws:

javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException - when cancel is not supported

---

isStopSupported

public boolean isStopSupported()

Is stop supported

Specified by:

isStopSupported in interface javax.enterprise.deploy.spi.status.ProgressObject

Returns:

true when stop is supported, false otherwise

---

stop

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

Stops the deployment

Specified by:

stop in interface javax.enterprise.deploy.spi.status.ProgressObject

Throws:

javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException - when stop is not supported

---

addProgressListener

public void addProgressListener(javax.enterprise.deploy.spi.status.ProgressListener listener)

Add a progress listener

Specified by:

addProgressListener in interface javax.enterprise.deploy.spi.status.ProgressObject

Parameters:

listener - the listener

---

removeProgressListener

public void removeProgressListener(javax.enterprise.deploy.spi.status.ProgressListener listener)

Remove a progress listener

Specified by:

removeProgressListener in interface javax.enterprise.deploy.spi.status.ProgressObject

Parameters:

listener - the listener

---

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

---

Copyright © 2002 JBoss Group, LLC. All Rights Reserved.