-
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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description 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(TargetModuleID id)
Return the ClientConfiguration object associated with the TargetModuleID.DeploymentStatus
getDeploymentStatus()
Retrieve the status of this activity.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 opertation for deployment activities.boolean
isStopSupported()
Tests whether the vendor supports a stop opertation for deployment activities.void
removeProgressListener(ProgressListener pol)
Remove a ProgressObject 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
DeploymentStatus getDeploymentStatus()
Retrieve the status of this activity.- Returns:
- An object containing the status information.
-
getResultTargetModuleIDs
TargetModuleID[] getResultTargetModuleIDs()
Retrieve the list of TargetModuleIDs successfully processed or created by the associated DeploymentManager operation.- Returns:
- a list of TargetModuleIDs.
-
getClientConfiguration
ClientConfiguration getClientConfiguration(TargetModuleID id)
Return the ClientConfiguration object associated with the TargetModuleID.- Returns:
- ClientConfiguration for a given TargetModuleID or null if none exists.
-
isCancelSupported
boolean isCancelSupported()
Tests whether the vendor supports a cancel opertation for deployment activities.- Returns:
true
if canceling an activity is supported by this platform.
-
cancel
void cancel() throws 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.- Throws:
OperationUnsupportedException
- this optional command is not supported by this implementation.
-
isStopSupported
boolean isStopSupported()
Tests whether the vendor supports a stop opertation for deployment activities.- Returns:
true
if canceling an activity is supported by this platform.
-
stop
void stop() throws 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.- Throws:
OperationUnsupportedException
- this optional command is not supported by this implementation.
-
addProgressListener
void addProgressListener(ProgressListener pol)
Add a listener to receive Progress events on deployment actions.- Parameters:
pol
- the listener to receive events- See Also:
ProgressEvent
-
removeProgressListener
void removeProgressListener(ProgressListener pol)
Remove a ProgressObject listener.- Parameters:
pol
- the listener being removed- See Also:
ProgressEvent
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 17:03:37 Cette version de la page est en cache (à la date du 21/08/2025 17:03:37) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 14/04/2008, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/enterprise/deploy/spi/status/ProgressObject.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.