public class InitialDeploymentSetBuilderImpl extends Object implements InitialDeploymentSetBuilder
DeploymentPlanBuilderImpl
that is meant
to be used at the initial stages of the building process, when directives that
pertain to the entire DeploymentSetPlan
can be applied.Modifier and Type | Method and Description |
---|---|
AddDeploymentPlanBuilder |
add(File file)
Indicates the content of the specified file should be added to the default content
repository.
|
AddDeploymentPlanBuilder |
add(String name)
Indicates a deployment that has already been added to the deployment
content repository should be added to the server groups associated with
the current
DeploymentSetPlan . |
AddDeploymentPlanBuilder |
add(String name,
File file)
Indicates the content of the specified fileL should be added to the default content
repository.
|
AddDeploymentPlanBuilder |
add(String name,
InputStream stream)
Indicates the content readable from the specified
InputStream
should be added to the default 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 default content
repository.
|
AddDeploymentPlanBuilder |
add(URL url)
Indicates the content at the specified URL should be added to the default content
repository.
|
DeploymentPlan |
build()
Creates the deployment plan.
|
DeployDeploymentPlanBuilder |
deploy(String key)
Indicates the specified deployment content should be deployed.
|
DeploymentAction |
getLastAction() |
DeploymentPlanBuilder |
redeploy(String deploymentName)
Indicates the specified deployment content should be redeployed (i.e.
|
RemoveDeploymentPlanBuilder |
remove(String key)
Indicates the specified deployment content should be removed from the
content repository.
|
RemoveDeploymentPlanBuilder |
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.
|
RemoveDeploymentPlanBuilder |
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.
|
RemoveDeploymentPlanBuilder |
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 replacement,
String toReplace)
Indicates the specified deployment content should be deployed, replacing
the specified existing deployment.
|
RemoveDeploymentPlanBuilder |
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. |
RemoveDeploymentPlanBuilder |
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.
|
RemoveDeploymentPlanBuilder |
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 key)
Indicates the specified deployment content should be undeployed.
|
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 |
withShutdown()
Indicates actions specified subsequent to this call should be organized
around a full server restart.
|
InitialDeploymentSetBuilder |
withSingleServerRollback()
Deprecated.
|
public InitialDeploymentSetBuilder withGracefulShutdown(long timeout, TimeUnit timeUnit)
InitialDeploymentSetBuilder
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.
withGracefulShutdown
in interface InitialDeploymentSetBuilder
timeout
- maximum amount of time the graceful shutdown should wait for
existing work to complete before completing the shutdowntimeUnit
- TimeUnit
in which timeout
is expressedpublic InitialDeploymentSetBuilder withShutdown()
InitialDeploymentSetBuilder
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.withShutdown
in interface InitialDeploymentSetBuilder
@Deprecated public InitialDeploymentSetBuilder withSingleServerRollback()
InitialDeploymentSetBuilder
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.
withSingleServerRollback
in interface InitialDeploymentSetBuilder
public InitialDeploymentSetBuilder withoutSingleServerRollback()
InitialDeploymentSetBuilder
deploy
, undeploy
or
replace
operations associated with the deployment set
should not be rolled back in case of a failure in any of them.withoutSingleServerRollback
in interface InitialDeploymentSetBuilder
public AddDeploymentPlanBuilder add(File file) throws IOException, DuplicateDeploymentNameException
DeploymentPlanBuilder
file.getName()
.
Note that this operation does not indicate the content should be deployed into the runtime.
add
in interface DeploymentPlanBuilder
file
- file containing the new contentDuplicateDeploymentNameException
- if the name of the deployment is
the same as that of other deployment content already present
in the domainIOException
public AddDeploymentPlanBuilder add(URL url) throws IOException, DuplicateDeploymentNameException
DeploymentPlanBuilder
url.getPath()
.
Note that this operation does not indicate the content should be deployed into the runtime.
add
in interface DeploymentPlanBuilder
url
- URL pointing to the new contentDuplicateDeploymentNameException
- if the name of the deployment is
the same as that of other deployment content already present
in the domainIOException
public AddDeploymentPlanBuilder add(String name, File file) throws IOException, DuplicateDeploymentNameException
DeploymentPlanBuilder
Note that this operation does not indicate the content should be deployed into the runtime.
add
in interface DeploymentPlanBuilder
name
- name that should be given to the new contentfile
- file containing the new contentDuplicateDeploymentNameException
- if the name of the deployment is
the same as that of other deployment content already present
in the domainIOException
public AddDeploymentPlanBuilder add(String name, URL url) throws IOException, DuplicateDeploymentNameException
DeploymentPlanBuilder
Note that this operation does not indicate the content should be deployed into the runtime.
add
in interface DeploymentPlanBuilder
name
- name that should be given to the new contenturl
- URL pointing to the new contentDuplicateDeploymentNameException
- if the name of the deployment is
the same as that of other deployment content already present
in the domainIOException
public AddDeploymentPlanBuilder add(String name, InputStream stream) throws IOException, DuplicateDeploymentNameException
DeploymentPlanBuilder
InputStream
should be added to the default content repository.
Note that this operation does not indicate the content should be deployed into the runtime.
add
in interface DeploymentPlanBuilder
name
- name that should be given to the new contentstream
- InputStream
from which the new content should be read
This stream has to be closed by the caller.DuplicateDeploymentNameException
- if the name of the deployment is
the same as that of other deployment content already present
in the domainIOException
public AddDeploymentPlanBuilder add(String name, String commonName, InputStream stream) throws IOException, DuplicateDeploymentNameException
DeploymentPlanBuilder
InputStream
should be added to the content repository.
Note that this operation does not indicate the content should be deployed into the runtime.
add
in interface DeploymentPlanBuilder
name
- name that should be given to the new content to uniquely
identify it within the domain's management system. Must be different from the
name given to an other deployment content presently available
on the servercommonName
- name by which the deployment should be known within
a server's 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 DeploymentPlanBuilder.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.DuplicateDeploymentNameException
- if the name
of the deployment is
the same as that of other deployment content already present
in the domainIOException
public AddDeploymentPlanBuilder add(String name) throws IOException
DeploymentPlanBuilder
DeploymentSetPlan
. Typically this is used to add
content that was added as part of a previously executed plan to one or more
new server groups.add
in interface DeploymentPlanBuilder
name
- name that uniquely identifies the deployment within
the domain's management system.IOException
public DeployDeploymentPlanBuilder deploy(String key)
DeploymentPlanBuilder
deploy
in interface DeploymentPlanBuilder
key
- unique identifier of the deployment contentpublic UndeployDeploymentPlanBuilder undeploy(String key)
DeploymentPlanBuilder
undeploy
in interface DeploymentPlanBuilder
key
- unique identifier of the deployment contentpublic DeploymentPlanBuilder redeploy(String deploymentName)
DeploymentPlanBuilder
redeploy
in interface DeploymentPlanBuilder
deploymentName
- unique identifier of the deployment contentpublic ReplaceDeploymentPlanBuilder replace(String replacement, String toReplace)
DeploymentPlanBuilder
replace
in interface DeploymentPlanBuilder
replacement
- unique identifier of the content to deploytoReplace
- unique identifier of the currently deployed content to replacepublic RemoveDeploymentPlanBuilder replace(File file) throws IOException
DeploymentPlanBuilder
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.
replace
in interface DeploymentPlanBuilder
file
- file containing the new contentIOException
public RemoveDeploymentPlanBuilder replace(URL url) throws IOException
DeploymentPlanBuilder
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.
replace
in interface DeploymentPlanBuilder
url
- URL pointing to the new contentIOException
public RemoveDeploymentPlanBuilder replace(String name, File file) throws IOException
DeploymentPlanBuilder
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.
replace
in interface DeploymentPlanBuilder
name
- name that should be given to the new contentfile
- file containing the new contentIOException
public RemoveDeploymentPlanBuilder replace(String name, URL url) throws IOException
DeploymentPlanBuilder
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.
replace
in interface DeploymentPlanBuilder
name
- name that should be given to the new contenturl
- URL pointing to the new contentIOException
public RemoveDeploymentPlanBuilder replace(String name, InputStream stream) throws IOException
DeploymentPlanBuilder
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.
replace
in interface DeploymentPlanBuilder
name
- name that should be given to the new contentstream
- InputStream
from which the new content should be read
This stream has to be closed by the caller.IOException
public RemoveDeploymentPlanBuilder replace(String name, String commonName, InputStream stream) throws IOException
DeploymentPlanBuilder
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.
replace
in interface DeploymentPlanBuilder
name
- name that should be given to the new contentcommonName
- 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 DeploymentPlanBuilder.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.IOException
public RemoveDeploymentPlanBuilder remove(String key)
DeploymentPlanBuilder
remove
in interface DeploymentPlanBuilder
key
- unique identifier of the deployment contentpublic DeploymentAction getLastAction()
public DeploymentPlan build()
Copyright © 2021 JBoss by Red Hat. All rights reserved.