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

Interface DeploymentPlanBuilder

All Known Subinterfaces:

AddDeploymentPlanBuilder, InitialDeploymentPlanBuilder, ReplaceDeploymentPlanBuilder, UndeployDeploymentPlanBuilder

public interface DeploymentPlanBuilder

Builder capable of creating a DeploymentPlan. This interface defines the core set of builder operations; various subinterfaces define additional operations that become available as a result of executing the methods in this interface.a

Author:

Brian Stansberry

Method Summary

Methods

Modifier and Type	Method and Description
AddDeploymentPlanBuilder	add(File file) Indicates the content of the specified file should be added to the content repository.
AddDeploymentPlanBuilder	add(String name, File file) Indicates the content of the specified fileL should be added to the content repository.
AddDeploymentPlanBuilder	add(String name, InputStream stream) Indicates the content readable from the specified InputStream should be added to the content repository.
AddDeploymentPlanBuilder	add(String name, String commonName, InputStream stream) Indicates the content readable from the specified InputStream should be added to the content repository.
AddDeploymentPlanBuilder	add(String name, URL url) Indicates the content at the specified URL should be added to the content repository.
AddDeploymentPlanBuilder	add(URL url) Indicates the content at the specified URL should be added to the content repository.
DeploymentPlan	build() Creates the deployment plan.
DeploymentPlanBuilder	deploy(String deploymentName) Indicates the specified deployment content should be deployed.
List<DeploymentAction>	getDeploymentActions() Gets the list of DeploymentActions created as a recent of builder operations, in order of when they were created.
long	getGracefulShutdownTimeout() Gets the maximum period, in ms, the builder will configure the deployment plan to wait for potentially long-running in-process work ito complete before shutdown proceeds.
DeploymentAction	getLastAction() Gets the DeploymentAction most recently created as a result of builder operations.
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 builder will create a deployment plan 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 builder will create a deployment plan organized around a shutdown of the server.
DeploymentPlanBuilder	redeploy(String deploymentName) Indicates the specified deployment content should be redeployed (i.e.
DeploymentPlanBuilder	remove(String deploymentName) Indicates the specified deployment content should be removed from the content repository.
DeploymentPlanBuilder	replace(File file) Indicates the content of the specified file should be added to the content repository and replace existing content of the same name.
DeploymentPlanBuilder	replace(String name, File file) Indicates the content of the specified file should be added to the content repository and replace existing content of the same name.
DeploymentPlanBuilder	replace(String name, InputStream stream) Indicates the content readable from the specified InputStream should be added to the content repository and replace existing content of the same name.
ReplaceDeploymentPlanBuilder	replace(String replacementDeploymentName, String toReplaceDeploymentName) Indicates the specified deployment content should be deployed, replacing the specified existing deployment.
DeploymentPlanBuilder	replace(String name, String commonName, InputStream stream) Indicates the content readable from the specified InputStream should be added to the content repository and replace existing content of the same name.
DeploymentPlanBuilder	replace(String name, URL url) Indicates the content at the specified URL should be added to the content repository and replace existing content of the same name.
DeploymentPlanBuilder	replace(URL url) Indicates the content at the specified URL should be added to the content repository and replace existing content of the same name.
UndeployDeploymentPlanBuilder	undeploy(String deploymentName) Indicates the specified deployment content should be undeployed.

Method Detail

getLastAction

DeploymentAction getLastAction()

Gets the DeploymentAction most recently created as a result of builder operations.

Returns:

the last action or null if there have been no actions.

getDeploymentActions

List<DeploymentAction> getDeploymentActions()

Gets the list of DeploymentActions created as a recent of builder operations, in order of when they were created.

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 builder will create a deployment plan 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 builder will create a deployment plan 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 builder will configure the deployment plan 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

add

AddDeploymentPlanBuilder add(File file)
                             throws IOException

Indicates the content of the specified file should be added to the content repository. The name of the deployment will be the value returned by file.getName().

Note that this operation does not indicate the content should be deployed into the runtime. See AddDeploymentPlanBuilder.andDeploy().

Parameters:

file - file containing the new content

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

add

AddDeploymentPlanBuilder add(URL url)
                             throws IOException

Indicates the content at the specified URL should be added to the content repository. The name of the deployment will be the last segment of the value returned by url.getPath().

Note that this operation does not indicate the content should be deployed into the runtime. See AddDeploymentPlanBuilder.andDeploy().

Parameters:

url - URL pointing to the new content

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

add

AddDeploymentPlanBuilder add(String name,
                           File file)
                             throws IOException

Indicates the content of the specified fileL should be added to the content repository.

Note that this operation does not indicate the content should be deployed into the runtime. See AddDeploymentPlanBuilder.andDeploy().

Parameters:

name - name that should be given to the new content to uniquely identify it within the server's management system. Must be different from the name given to an other deployment content presently available on the server

file - file containing the new content

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

add

AddDeploymentPlanBuilder add(String name,
                           URL url)
                             throws IOException

Indicates the content at the specified URL should be added to the content repository.

Note that this operation does not indicate the content should be deployed into the runtime. See AddDeploymentPlanBuilder.andDeploy().

Parameters:

name - name that should be given to the new content to uniquely identify it within the server. Must be different from the name given to an other deployment content presently available on the server

url - URL pointing to the new content

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

add

AddDeploymentPlanBuilder add(String name,
                           InputStream stream)

Indicates the content readable from the specified InputStream should be added to the content repository.

Note that this operation does not indicate the content should be deployed into the runtime. See AddDeploymentPlanBuilder.andDeploy().

Parameters:

name - name that should be given to the new content to uniquely identify it within the server's management system. Must be different from the name given to an other deployment content presently available on the server

stream - InputStream from which the new content should be read This stream has to be closed by the caller.

Returns:

a builder that can continue building the overall deployment plan

add

AddDeploymentPlanBuilder add(String name,
                           String commonName,
                           InputStream stream)
                             throws IOException

Indicates the content readable from the specified InputStream should be added to the content repository.

Note that this operation does not indicate the content should be deployed into the runtime. See AddDeploymentPlanBuilder.andDeploy().

Parameters:

name - name that should be given to the new content to uniquely identify it within the server's management system. Must be different from the name given to an other deployment content presently available on the server

commonName - name by which the deployment should be known within the runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as name (in which case add(String, InputStream) would normally be used, but in some cases users may wish to have two deployments with the same common name may (e.g. two versions of "foo.war" both available in the deployment content repository), in which case the deployments would need to have distinct name values but would have the same commonName

stream - InputStream from which the new content should be read This stream has to be closed by the caller.

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

deploy

DeploymentPlanBuilder deploy(String deploymentName)

Indicates the specified deployment content should be deployed.

Parameters:

deploymentName - unique identifier of the deployment content

Returns:

a builder that can continue building the overall deployment plan

undeploy

UndeployDeploymentPlanBuilder undeploy(String deploymentName)

Indicates the specified deployment content should be undeployed.

Parameters:

deploymentName - unique identifier of the deployment content

Returns:

a builder that can continue building the overall deployment plan

redeploy

DeploymentPlanBuilder redeploy(String deploymentName)

Indicates the specified deployment content should be redeployed (i.e. undeployed and then deployed again).

Parameters:

deploymentName - unique identifier of the deployment content

Returns:

a builder that can continue building the overall deployment plan

replace

ReplaceDeploymentPlanBuilder replace(String replacementDeploymentName,
                                   String toReplaceDeploymentName)

Indicates the specified deployment content should be deployed, replacing the specified existing deployment.

Parameters:

replacementDeploymentName - unique identifier of the content to deploy

toReplaceDeploymentName - unique identifier of the currently deployed content to replace

Returns:

a builder that can continue building the overall deployment plan

replace

DeploymentPlanBuilder replace(File file)
                              throws IOException

Indicates the content of the specified file should be added to the content repository and replace existing content of the same name. The name of the deployment will be the value returned by file.getName().

Whether this operation will result in the new content being deployed into the runtime depends on whether the existing content being replaced is deployed. If the content being replaced is deployed the old content will be undeployed and the new content will be deployed.

Parameters:

file - file containing the new content

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

replace

DeploymentPlanBuilder replace(URL url)
                              throws IOException

Indicates the content at the specified URL should be added to the content repository and replace existing content of the same name. The name of the deployment will be the last segment of the value returned by url.getPath().

Whether this operation will result in the new content being deployed into the runtime depends on whether the existing content being replaced is deployed. If the content being replaced is deployed the old content will be undeployed and the new content will be deployed.

Parameters:

url - URL pointing to the new content

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

replace

DeploymentPlanBuilder replace(String name,
                            File file)
                              throws IOException

Indicates the content of the specified file should be added to the content repository and replace existing content of the same name.

Whether this operation will result in the new content being deployed into the runtime depends on whether the existing content being replaced is deployed. If the content being replaced is deployed the old content will be undeployed and the new content will be deployed.

Parameters:

name - name that should be given to the new content

file - file containing the new content

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

replace

DeploymentPlanBuilder replace(String name,
                            URL url)
                              throws IOException

Indicates the content at the specified URL should be added to the content repository and replace existing content of the same name.

Whether this operation will result in the new content being deployed into the runtime depends on whether the existing content being replaced is deployed. If the content being replaced is deployed the old content will be undeployed and the new content will be deployed.

Parameters:

name - name that should be given to the new content

url - URL pointing to the new content

Returns:

a builder that can continue building the overall deployment plan

Throws:

IOException

replace

DeploymentPlanBuilder replace(String name,
                            InputStream stream)

Indicates the content readable from the specified InputStream should be added to the content repository and replace existing content of the same name.

Whether this operation will result in the new content being deployed into the runtime depends on whether the existing content being replaced is deployed. If the content being replaced is deployed the old content will be undeployed and the new content will be deployed.

Parameters:

name - name that should be given to the new content

stream - InputStream from which the new content should be read This stream has to be closed by the caller.

Returns:

a builder that can continue building the overall deployment plan

replace

DeploymentPlanBuilder replace(String name,
                            String commonName,
                            InputStream stream)

Indicates the content readable from the specified InputStream should be added to the content repository and replace existing content of the same name.

Whether this operation will result in the new content being deployed into the runtime depends on whether the existing content being replaced is deployed. If the content being replaced is deployed the old content will be undeployed and the new content will be deployed.

Parameters:

name - name that should be given to the new content

commonName - name by which the deployment should be known within the runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as name (in which case add(String, InputStream) would normally be used, but in some cases users may wish to have two deployments with the same common name may (e.g. two versions of "foo.war" both available in the deployment content repository), in which case the deployments would need to have distinct name values but would have the same commonName

stream - InputStream from which the new content should be read. This stream has to be closed by the caller.

Returns:

a builder that can continue building the overall deployment plan

remove

DeploymentPlanBuilder remove(String deploymentName)

Indicates the specified deployment content should be removed from the content repository.

Parameters:

deploymentName - unique identifier of the deployment content

Returns:

a builder that can continue building the overall deployment plan

build

DeploymentPlan build()

Creates the deployment plan.

Returns:

the deployment plan