public interface DeploymentPlan
DomainDeploymentManager
should
take to update the set of deployment content available for deployment in the
domain and/or change the content deployed in the domain's servers.Modifier and Type | Method and Description |
---|---|
List<DeploymentAction> |
getDeploymentActions()
Gets the list of deploy, replace and undeploy actions that are part
of the deployment plan.
|
long |
getGracefulShutdownTimeout()
Gets the maximum period, in ms, the deployment set 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.
|
List<Set<ServerGroupDeploymentPlan>> |
getServerGroupDeploymentPlans()
Gets the configuration of how the
deployment
actions are to be applied to the server groups in the domain. |
boolean |
isGracefulShutdown()
Gets whether the deployment set 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 |
isRollbackAcrossGroups() |
boolean |
isShutdown()
Gets whether the deployment set plan is organized around a shutdown of the server.
|
boolean |
isSingleServerRollback()
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. |
UUID getId()
null
List<DeploymentAction> getDeploymentActions()
null
boolean isSingleServerRollback()
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.
boolean isRollbackAcrossGroups()
boolean isShutdown()
true
if the plan will be organized around a shutdown,
false
otherwiseboolean isGracefulShutdown()
true
if the plan will be organized around a graceful shutdown,
false
otherwiselong getGracefulShutdownTimeout()
-1
if isGracefulShutdown()
would return false
List<Set<ServerGroupDeploymentPlan>> getServerGroupDeploymentPlans()
deployment
actions
are to be applied to the server groups in the domain. Each
ServerGroupDeploymentPlan
in the returned data structure specifies
how the actions are to be applied to the servers within a particular server group. The data
structure itself is a list of sets of ServerGroupDeploymentPlans. Each
set indicates a collection of server groups to which actions can be
applied concurrently. Each element in the overall list delineates actions
should be applied in series.
So, for example, assume we the overall deployment
set plan is intended to apply deployments to 3 server groups: A
,
B
and C
. Assume elements within curly braces
represent and set and elements within brackets represent an item in a list:
[{A,B}],[{C}]
would describe a plan to concurrently
execute the deployment actions on server groups A and B and then when A
and B are complete, continue on to server group C.[{A}],[{B}],[{C}]
would describe a plan to
execute the deployment actions on server group A, and then when A
is complete, continue on to server group B and then to C.[{A,B,C}]
would describe a plan to concurrently
execute the deployment actions on server groups A and B and C.deployment
actions
are to be applied to the server groups in the domain.Copyright © 2019 JBoss by Red Hat. All rights reserved.