javax.enterprise.deploy.spi.status

Interface ProgressObject

Contents

  • 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 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

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/enterprise/deploy/spi/status/ProgressObject.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, ProgressObject (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.