org.jboss.as.controller.client.helpers.domain

Interface InitialDeploymentPlanBuilder

All Superinterfaces:

DeploymentPlanBuilder, InitialDeploymentSetBuilder

public interface InitialDeploymentPlanBuilder
extends InitialDeploymentSetBuilder

Variant of a DeploymentPlanBuilder that is 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

Methods

Modifier and Type	Method and Description
InitialDeploymentSetBuilder	withGracefulShutdown(long timeout, TimeUnit timeUnit) Indicates actions specified subsequent to this call should be organized around a full graceful server shutdown and restart.
InitialDeploymentSetBuilder	withoutSingleServerRollback() Indicates that on a given server all deploy, undeploy or replace operations associated with the deployment set should not be rolled back in case of a failure in any of them.
InitialDeploymentSetBuilder	withRollbackAcrossGroups() Indicates that the actions in the plan need to be rolled back across any single given server group, then it should be rolled back across all server groups.
InitialDeploymentSetBuilder	withShutdown() Indicates actions specified subsequent to this call should be organized around a full server restart.
InitialDeploymentSetBuilder	withSingleServerRollback() Deprecated. single server rollback is the default behavior for a deployment plan and doesn't need to be enabled

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

add, add, add, add, add, add, add, build, deploy, getLastAction, redeploy, remove, replace, replace, replace, replace, replace, replace, replace, undeploy

Method Detail

withRollbackAcrossGroups

InitialDeploymentSetBuilder withRollbackAcrossGroups()

Indicates that the actions in the plan need to be rolled back across any single given server group, then it should be rolled back across all server groups.

Returns:

a builder that can continue building the overall deployment plan

withSingleServerRollback

@Deprecated
InitialDeploymentSetBuilder withSingleServerRollback()

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

Indicates that on a given server all deploy, undeploy or replace operations associated with the deployment set should be rolled back in case of a failure in any of them.

Note: This directive does not span across servers, i.e. a rollback on one server will not trigger rollback on others. Use ServerGroupDeploymentPlanBuilder.withRollback() to trigger rollback across servers.

Specified by:

withSingleServerRollback in interface InitialDeploymentSetBuilder

Returns:

a builder that can continue building the overall deployment plan

withoutSingleServerRollback

InitialDeploymentSetBuilder withoutSingleServerRollback()

Indicates that on a given server all deploy, undeploy or replace operations associated with the deployment set should not be rolled back in case of a failure in any of them.

Specified by:

withoutSingleServerRollback in interface InitialDeploymentSetBuilder

Returns:

a builder that can continue building the overall deployment plan

withGracefulShutdown

InitialDeploymentSetBuilder withGracefulShutdown(long timeout,
                                               TimeUnit timeUnit)

Indicates actions specified subsequent to this call should be organized around a full graceful server shutdown and restart. 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.

Specified by:

withGracefulShutdown in interface InitialDeploymentSetBuilder

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

InitialDeploymentSetBuilder withShutdown()

Indicates actions specified subsequent to this call should be organized around a full server restart. 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.

Specified by:

withShutdown in interface InitialDeploymentSetBuilder

Returns:

a builder that can continue building the overall deployment plan