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

Interface InitialDeploymentPlanBuilder

All Superinterfaces:

DeploymentPlanBuilder

public interface InitialDeploymentPlanBuilder
extends DeploymentPlanBuilder

Extension of DeploymentPlanBuilder that exposes additional methods meant to be used at the initial stages of the building process, when directives that pertain to the entire plan can be applied.

Author:

Brian Stansberry

Method Summary

Modifier and Type	Method and Description
DeploymentPlanBuilder	withGracefulShutdown(long timeout, TimeUnit timeUnit) Indicates actions specified subsequent to this call should be organized around a full graceful server shutdown.
DeploymentPlanBuilder	withoutRollback() Indicates all deploy, undeploy, replace or remove operations associated with the deployment plan should not be rolled back in case of a failure in any of them.
DeploymentPlanBuilder	withRollback() Deprecated. rollback is the default behavior for a deployment plan and doesn't need to be enabled
DeploymentPlanBuilder	withShutdown() Indicates actions specified subsequent to this call should be organized around a full server shutdown.

Methods inherited from interface org.jboss.as.controller.client.helpers.standalone.DeploymentPlanBuilder

add, add, add, add, add, add, build, deploy, getDeploymentActions, getGracefulShutdownTimeout, getLastAction, isGlobalRollback, isGracefulShutdown, isShutdown, redeploy, remove, replace, replace, replace, replace, replace, replace, replace, undeploy

Method Detail

withRollback

@Deprecated
DeploymentPlanBuilder withRollback()

Deprecated. rollback is the default behavior for a deployment plan and doesn't need to be enabled

Indicates 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:

a builder that can continue building the overall deployment plan

withoutRollback

DeploymentPlanBuilder withoutRollback()

Indicates all deploy, undeploy, replace or remove operations associated with the deployment plan should not be rolled back in case of a failure in any of them.

Returns:

a builder that can continue building the overall deployment plan

withGracefulShutdown

DeploymentPlanBuilder withGracefulShutdown(long timeout,
                                           TimeUnit timeUnit)

Indicates actions specified subsequent to this call should be organized around a full graceful server shutdown. The server will attempt to shut itself down gracefully, waiting for in-process work to complete before shutting down. See the full JBoss AS documentation for details on what "waiting for in-process work to complete" means.

For any deploy or replace actions, the new content will not be deployed until the server is restarted. For any undeploy or replace actions, the old content will be undeployed as part of normal server shutdown processing.

NOTE: In order to organize a deployment plan around a server shutdown, rollback of the plan must be disabled. A rollback is not compatible with a server restart.

NOTE: A Standalone JBoss AS instance is not able to restart itself; it can only shut itself down, and requires external action to start again.

Parameters:

timeout - maximum amount of time the graceful shutdown should wait for existing work to complete before completing the shutdown

timeUnit - TimeUnit in which timeout is expressed

Returns:

a builder that can continue building the overall deployment plan

withShutdown

DeploymentPlanBuilder withShutdown()

Indicates actions specified subsequent to this call should be organized around a full server shutdown. For any deploy or replace actions, the new content will not be deployed until the server is restarted. For any undeploy or replace actions, the old content will be undeployed as part of normal server shutdown processing.

NOTE: In order to organize a deployment plan around a server shutdown, rollback of the plan must be disabled. A rollback is not compatible with a server restart.

NOTE: A Standalone JBoss AS instance is not able to restart itself; it can only shut itself down, and requires external action to start again.

Returns:

a builder that can continue building the overall deployment plan