Package org.jboss.as.controller.client.helpers.standalone

Interface DeploymentPlan

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    DeploymentPlanImpl
    public interface DeploymentPlan
extends Serializable
    Encapsulates a set of actions a ServerDeploymentManager should take to update the set of deployment content available for deployment in the server and/or change the content deployed in the server.
    Author:
    Brian Stansberry

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      List<DeploymentAction> getDeploymentActions()
      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 getGracefulShutdownTimeout()
      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.
      UUID getId()
      Gets the unique id of the plan.
      boolean isGlobalRollback()
      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 isGracefulShutdown()
      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 isShutdown()
      Gets whether the deployment plan is organized around a shutdown of the server.

    • Method Detail

      • getId

        UUID getId()
        Gets the unique id of the plan.
        Returns:
        the id. Will not be null

      • getDeploymentActions

        List<DeploymentAction> getDeploymentActions()
        Gets the list of deployment actions that are part of the deployment plan, in the order in which they were added to the plan.
        Returns:
        the actions. Will not be null

      • isGlobalRollback

        boolean isGlobalRollback()
        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.
        Returns:
        true if all operations should be rolled back if any of them fail

      • isShutdown

        boolean isShutdown()
        Gets whether the deployment plan is organized around a shutdown of the server.
        Returns:
        true if the plan will be organized around a shutdown, false otherwise

      • isGracefulShutdown

        boolean isGracefulShutdown()
        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.
        Returns:
        true if the plan will be organized around a graceful shutdown, false otherwise

      • getGracefulShutdownTimeout

        long getGracefulShutdownTimeout()
        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.
        Returns:
        the period in ms, or -1 if isGracefulShutdown() would return true