Class DeploymentPlanImpl

java.lang.Object
org.jboss.as.controller.client.helpers.standalone.impl.DeploymentPlanImpl
All Implemented Interfaces:
Serializable, DeploymentPlan

public class DeploymentPlanImpl extends Object implements DeploymentPlan
Describes a set of actions to take to change the deployment content available to and/or deployed in a standalone server.
Author:
Brian Stansberry
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
     
    Same as getDeploymentActions() except the type of the list contents reflects the actual implementation class.
    Gets the list of deployment actions that are part of the deployment plan, in the order in which they were added to the plan.
    long
    Gets the maximum period, in ms, the deployment plan is configured to wait for potentially long-running in-process work ito complete before shutdown proceeds.
    Gets the unique id of the plan.
    boolean
    Gets whether all deploy, undeploy, replace or remove operations associated with the deployment plan should be rolled back in case of a failure in any of them.
    boolean
    Gets whether the deployment plan is organized around a graceful shutdown of the server, where potentially long-running in-process work is given time to complete before shutdown proceeds.
    boolean
    Gets whether the deployment plan is organized around a shutdown of the server.

    Methods inherited from class java.lang.Object

    clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • getId

      public UUID getId()
      Description copied from interface: DeploymentPlan
      Gets the unique id of the plan.
      Specified by:
      getId in interface DeploymentPlan
      Returns:
      the id. Will not be null
    • getDeploymentActions

      public List<DeploymentAction> getDeploymentActions()
      Description copied from interface: DeploymentPlan
      Gets the list of deployment actions that are part of the deployment plan, in the order in which they were added to the plan.
      Specified by:
      getDeploymentActions in interface DeploymentPlan
      Returns:
      the actions. Will not be null
    • isGlobalRollback

      public boolean isGlobalRollback()
      Description copied from interface: DeploymentPlan
      Gets whether all deploy, undeploy, replace or remove operations associated with the deployment plan should be rolled back in case of a failure in any of them.
      Specified by:
      isGlobalRollback in interface DeploymentPlan
      Returns:
      true if all operations should be rolled back if any of them fail
    • getGracefulShutdownTimeout

      public long getGracefulShutdownTimeout()
      Description copied from interface: DeploymentPlan
      Gets the maximum period, in ms, the deployment plan is configured to wait for potentially long-running in-process work ito complete before shutdown proceeds.
      Specified by:
      getGracefulShutdownTimeout in interface DeploymentPlan
      Returns:
      the period in ms, or -1 if DeploymentPlan.isGracefulShutdown() would return true
    • isGracefulShutdown

      public boolean isGracefulShutdown()
      Description copied from interface: DeploymentPlan
      Gets whether the deployment plan is organized around a graceful shutdown of the server, where potentially long-running in-process work is given time to complete before shutdown proceeds.
      Specified by:
      isGracefulShutdown in interface DeploymentPlan
      Returns:
      true if the plan will be organized around a graceful shutdown, false otherwise
    • isShutdown

      public boolean isShutdown()
      Description copied from interface: DeploymentPlan
      Gets whether the deployment plan is organized around a shutdown of the server.
      Specified by:
      isShutdown in interface DeploymentPlan
      Returns:
      true if the plan will be organized around a shutdown, false otherwise
    • getDeploymentActionImpls

      public List<DeploymentActionImpl> getDeploymentActionImpls()
      Same as getDeploymentActions() except the type of the list contents reflects the actual implementation class.
      Returns:
      the actions. Will not be null
    • finalize

      protected void finalize() throws Throwable
      Overrides:
      finalize in class Object
      Throws:
      Throwable