public final class DeploymentOptions
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static boolean |
ADMIN_ACCESS
Start Web application with restricted access (test mode).
|
private java.lang.String |
altDD |
private java.lang.String |
altWlsDD |
private boolean |
appShutdownOnStop |
private java.lang.String |
archiveVersion |
private boolean |
cacheInAppDirectory |
static int |
CLUSTER_DEPLOYMENT_TIMEOUT
Default deployment timeout value for deployment operations.
|
private int |
clusterTimeout |
private boolean |
defaultSubmoduleTargets |
private int |
deploymentOrder |
private java.lang.String |
deploymentPrincipalName |
private boolean |
disableModuleLevelStartStop |
private java.lang.String |
editSessionName
Indicates which named edit session is associated with this deployment.
|
static java.lang.String |
EXTERNAL_STAGE
Manual staging of files.
|
private long |
forceUndeployTimeoutSecs |
static boolean |
FULL_ACCESS
Start Web application with normal access.
|
private boolean |
gracefulIgnoreSessions |
private boolean |
gracefulProductionToAdmin |
private int |
gracefulRMIGracePeriodSecs |
private boolean |
isLibrary |
private boolean |
isSecurityValidationEnabled |
private java.lang.String |
libImplVersion |
private java.lang.String |
libSpecVersion |
private java.lang.String |
name |
private boolean |
nameFromLibrary |
private boolean |
nameFromSource
Indicates that the application name should be derived in the proper precedence
from other factors than the tmids because the tmid name was derived
from the source in the absence of a given name.
|
static java.lang.String |
NOSTAGE
Inhibit copying of files to target servers.
|
private boolean |
noVersion
Indicates that the operation will skip version checks on the application source
so that we can relax the restriction on the existence of the application source
on the Administration Server for very large applications.
|
private boolean |
operationInitiatedByAutoDeployPoller |
private boolean |
overwriteFile
File overwrite flag used for generic partition user file system file
upload.
|
private java.lang.String |
partition
Indicates that the operation will be scoped to a resource group
of a partition.
|
static java.lang.String |
PLAN_EXTERNAL_STAGE |
static java.lang.String |
PLAN_NOSTAGE |
static java.lang.String |
PLAN_STAGE |
static java.lang.String |
PLAN_STAGE_DEFAULT |
private java.lang.String |
planStageOption |
private java.lang.String |
planVersion |
private boolean |
remote
Indicates that the operation will be remote from the file system
that contains the source.
|
private boolean |
removePlanOverride |
private java.lang.String |
resourceGroup |
private java.lang.String |
resourceGroupTemplate
Indicates that the operation will be scoped to a resource group
template.
|
private boolean |
retireGracefulPolicy |
private int |
retireTimeOption |
private java.lang.String |
securityModel |
private static long |
serialVersionUID |
private java.lang.String[] |
specifiedModules
Used with a resource group template or a resource group to indicate
the modules to which the deployment operation is relevant.
|
private boolean |
specifiedTargetsOnly |
static java.lang.String |
STAGE
Force copying of files to target servers.
|
static java.lang.String |
STAGE_DEFAULT
Use the default or configured staging mode.
|
private java.lang.String |
stageOption |
private boolean |
startTask |
private boolean |
succeedIfNameUsed |
private boolean |
testOption |
private long |
timeout |
private boolean |
tmidsFromConfig |
private boolean |
undeployAllVersions |
private java.lang.String |
uploadPath
Relative upload path used for generic partition user file system file
upload.
|
private boolean |
useExpiredLock
Indicates that the operation should use a lock even if it is expired.
|
private boolean |
useNonexclusiveLock |
Constructor and Description |
---|
DeploymentOptions()
Create instance with defaulted options.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAltDD()
A path on the file system for the application descriptor for
this application.
|
java.io.File |
getAltDDFile() |
java.lang.String |
getAltWlsDD()
A path on the file system for the WebLogic Server-specific application
descriptor for this application.
|
java.lang.String |
getArchiveVersion()
The version identifier of the application.
|
int |
getClusterDeploymentTimeout()
Milliseconds granted for a cluster deployment task on this
application.
|
int |
getDeploymentOrder()
DeploymentOrder is a priority that the server uses to determine when it
deploys an item.
|
java.lang.String |
getDeploymentPrincipalName() |
java.lang.String |
getEditSessionName()
Name of the edit session that was active during this deployment.
|
long |
getForceUndeployTimeout() |
java.lang.String |
getLibImplVersion()
The implementation version of a library application.
|
java.lang.String |
getLibSpecVersion()
The specification version of a library application.
|
java.lang.String |
getName() |
boolean |
getOverwriteFile()
Returns the overwrite flag used for partition use file system file
upload.
|
java.lang.String |
getPartition()
Returns the partition which the deployment operations will be scoped to.
|
java.lang.String |
getPlanStageMode()
Indicates how the deployment plan will be made available to Managed Servers.
|
java.lang.String |
getPlanVersion()
The version identifier of the deployment plan used in this deployment.
|
java.lang.String |
getResourceGroup()
Returns the resource group which the deployment operations will be
scoped to.
|
java.lang.String |
getResourceGroupTemplate()
Returns the resource group template which the deployment operations will
be scoped to.
|
int |
getRetireTime()
Specifies how long to wait in seconds before retiring an application that has
been replaced with a newer version.
|
int |
getRMIGracePeriodSecs()
Specifies the RMI grace period for the graceful production to administration
mode operation.
|
java.lang.String |
getSecurityModel()
The security deployment model to use for this application.
|
java.lang.String[] |
getSpecifiedModules() |
boolean |
getSpecifiedTargetsOnly()
Returns whether the operation should be done only to the specified
targets when the targets are in a cluster.
|
java.lang.String |
getStageMode()
Indicates how files will be made available to Managed Servers.
|
long |
getTimeout()
User provided timeout value in milliseconds.
|
java.lang.String |
getUploadPath()
Returns the relative upload path used for partition use file system file
upload.
|
java.lang.String |
getVersionIdentifier()
The full version identifier of the application for this deployment, including the archive and plan versions.
|
boolean |
isAdminMode()
Indicates whether a Web application should be started with restricted
access.
|
boolean |
isAppShutdownOnStop() |
boolean |
isCacheInAppDirectory()
Gets whether the temporary application files should be cached
where the staging files are put.
|
boolean |
isDefaultSubmoduleTargets()
Indicates whether the deployer tool will derive good default targets for any JMS submodules being deployed.
|
boolean |
isDisableModuleLevelStartStop()
CR309943.
|
boolean |
isGracefulIgnoreSessions()
Specifies whether the graceful production to administration mode operation
should ignore pending HTTP sessions.
|
boolean |
isGracefulProductionToAdmin()
Specifies whether the production to administration mode operation should
be graceful.
|
boolean |
isLibrary()
Indicates whether the application is to be deployed as a library.
|
boolean |
isNameFromLibrary()
Indicates that the application name should be derived from the library manifest.
|
boolean |
isNameFromSource()
Indicates that the application name should be derived from the application files.
|
boolean |
isNoVersion()
Indicates that the operation will skip version checks on the application source
so that we can relax the restriction on the existence of the application source
on the Administration Server for very large applications.
|
boolean |
isOperationInitiatedByAutoDeployPoller() |
boolean |
isRemote()
Indicates that the operation will be remote from the file system
that contains the source.
|
boolean |
isRemovePlanOverride()
Returns whether the operation should remove the deployment plan.
|
boolean |
isRetireGracefully()
Specifies the retirement policy to gracefully retire an application only after it
has completed all in-flight work.
|
boolean |
isRGOrRGTOperation() |
boolean |
isSecurityValidationEnabled()
Specifies whether security deployment data should be validated.
|
boolean |
isStartTask() |
boolean |
isSucceedIfNameUsed() |
boolean |
isTestMode()
Deprecated.
replaced with isAdminMode
|
boolean |
isTmidsFromConfig() |
boolean |
isUndeployAllVersions()
Specifies whether the undeploy operation should undeploy all
application versions irrespective of in-flight work.
|
void |
setAdminMode(boolean b)
Specifies whether an application should be deployed with restricted access.
|
void |
setAltDD(java.lang.String altDD)
Specifies an alternate path on the file system of the application descriptor for
this application.
|
void |
setAltWlsDD(java.lang.String altWlsDD)
Specifies an alternate path on the file system of the WebLogic Server-specific application descriptor for
this application.
|
void |
setAppShutdownOnStop(boolean val) |
void |
setArchiveVersion(java.lang.String version)
Specifies the application version for the application.
|
void |
setCacheInAppDirectory(boolean val)
Sets whether the temporary application files should be cached
where the staging files are put.
|
void |
setClusterDeploymentTimeout(int timeInMillis) |
void |
setDefaultSubmoduleTargets(boolean defaultSubmoduleTargets) |
void |
setDeploymentOrder(int order)
Sets the DeploymentOrder.
|
void |
setDeploymentPrincipalName(java.lang.String principal) |
void |
setDisableModuleLevelStartStop(boolean disableModuleLevelStartStop) |
void |
setEditSessionName(java.lang.String editSessionName)
Name of the edit session that was active during this deployment.
|
void |
setForceUndeployTimeout(long timeInSecs) |
void |
setGracefulIgnoreSessions(boolean b) |
void |
setGracefulProductionToAdmin(boolean b) |
void |
setLibImplVersion(java.lang.String version)
Specifies the implementation version of a library application if it is not present in the manifest.
|
void |
setLibrary(boolean isLibrary)
Specifies if the application is a library.
|
void |
setLibSpecVersion(java.lang.String version)
Specifies the specification version of a library application if it is not present in the manifest.
|
void |
setName(java.lang.String name)
Sets the name of the application.
|
void |
setNameFromLibrary(boolean nameFromLibrary)
Specifies that the application name should be derived from the library manifest.
|
void |
setNameFromSource(boolean nuNameFromSource)
Indicates that the application name should be derived from the application files.
|
void |
setNoVersion(boolean ignoreVersion)
Indicates that the operation will skip version checks on the application source
so that we can relax the restriction on the existence of the application source
on the Administration Server for very large applications.
|
void |
setOperationInitiatedByAutoDeployPoller(boolean val) |
void |
setOverwriteFile(boolean overwrite)
Specifies the overwrite flag used for partition use file system file
upload.
|
void |
setPartition(java.lang.String par)
Specifies the partition which the deployment operations will be scoped to.
|
void |
setPlanStageMode(java.lang.String s)
Sets the value of the PlanStagingMode attribute.
|
void |
setPlanVersion(java.lang.String planVersion)
Specifies a deployment plan version for this deployment.
|
void |
setRemote(boolean setRemote)
Indicates that the operation will be remote from the file system
that contains the source.
|
void |
setRemovePlanOverride(boolean removePlanOverride)
Specifies that the operation should remove the deployment plan.
|
void |
setResourceGroup(java.lang.String rgp)
Specifies the resource group which the deployment operations will
be scoped to.
|
void |
setResourceGroupTemplate(java.lang.String rgt)
Specifies the resource group template which the deployment operations
will be scoped to.
|
void |
setRetireGracefully(boolean b)
Sets the value for RetireGracefully attribute.
|
void |
setRetireTime(int i)
Sets the value for RetireTime attribute.
|
void |
setRMIGracePeriodSecs(int secs)
Sets the RMI grace period for the graceful production to administration mode operation.
|
void |
setSecurityModel(java.lang.String model)
Specifies a security deployment model to use for this application.
|
void |
setSecurityValidationEnabled(boolean enable)
Specifies whether to validate security deployment data.
|
void |
setSpecifiedModules(java.lang.String specifiedModules) |
void |
setSpecifiedModules(java.lang.String[] specifiedModules) |
void |
setSpecifiedTargetsOnly(boolean specifiedTargetsOnly)
Specifies that the operation should be done only to the specified
targets when the targets are in a cluster.
|
void |
setStageMode(java.lang.String s)
Sets the value of the StagingMode attribute.
|
void |
setStartTask(boolean val) |
void |
setSucceedIfNameUsed(boolean val) |
void |
setTestMode(boolean b)
Deprecated.
replaced with setAdminMode
|
void |
setTimeout(long timeout)
The maximum time in milliseconds for the deployment to complete before it
it is considered to have failed.
|
void |
setTmidsFromConfig(boolean tmidsFromConfig) |
void |
setUndeployAllVersions(boolean b)
Sets the value for the UndeployAllVersions attribute.
|
void |
setUploadPath(java.lang.String path)
Specifies the relative upload path used for partition use file system file
upload.
|
void |
setUseExpiredLock(boolean useExpiredLock)
Specifies that the operation should use a lock even if it is expired.
|
void |
setUseNonexclusiveLock(boolean useNonexclusiveLock)
Used by deployment tools to indicate they will utilize an existing lock on the domain already
acquired by the same user.
|
void |
setVersionIdentifier(java.lang.String version)
Specifies the full version identifier for this deployment.
|
java.lang.String |
toString() |
boolean |
usesExpiredLock()
Returns whether the operation should use a lock even if it is expired.
|
boolean |
usesNonExclusiveLock()
Indicates whether this operation requires sharing of an existing lock on the domain configuration.
|
private static final long serialVersionUID
private boolean useNonexclusiveLock
private boolean operationInitiatedByAutoDeployPoller
private boolean testOption
private int retireTimeOption
private boolean retireGracefulPolicy
private boolean gracefulProductionToAdmin
private boolean gracefulIgnoreSessions
private int gracefulRMIGracePeriodSecs
private boolean undeployAllVersions
private java.lang.String stageOption
private java.lang.String planStageOption
private java.lang.String name
private boolean nameFromLibrary
private long forceUndeployTimeoutSecs
private boolean disableModuleLevelStartStop
private long timeout
private int deploymentOrder
private java.lang.String deploymentPrincipalName
private boolean succeedIfNameUsed
private boolean cacheInAppDirectory
private boolean specifiedTargetsOnly
private boolean removePlanOverride
private boolean startTask
private boolean appShutdownOnStop
private boolean nameFromSource
private boolean defaultSubmoduleTargets
private java.lang.String altDD
private java.lang.String altWlsDD
private boolean noVersion
private boolean remote
private boolean useExpiredLock
private java.lang.String partition
private java.lang.String resourceGroup
private java.lang.String resourceGroupTemplate
private java.lang.String[] specifiedModules
private java.lang.String editSessionName
private java.lang.String uploadPath
private boolean overwriteFile
private boolean tmidsFromConfig
public static final java.lang.String STAGE_DEFAULT
public static final java.lang.String PLAN_STAGE_DEFAULT
public static final java.lang.String STAGE
public static final java.lang.String PLAN_STAGE
public static final java.lang.String NOSTAGE
public static final java.lang.String PLAN_NOSTAGE
public static final java.lang.String EXTERNAL_STAGE
public static final java.lang.String PLAN_EXTERNAL_STAGE
public static final boolean FULL_ACCESS
public static final boolean ADMIN_ACCESS
private java.lang.String securityModel
private boolean isSecurityValidationEnabled
private java.lang.String archiveVersion
private java.lang.String planVersion
private boolean isLibrary
private java.lang.String libSpecVersion
private java.lang.String libImplVersion
public static final int CLUSTER_DEPLOYMENT_TIMEOUT
private int clusterTimeout
public DeploymentOptions()
public boolean usesNonExclusiveLock()
public boolean isOperationInitiatedByAutoDeployPoller()
public void setOperationInitiatedByAutoDeployPoller(boolean val)
val
- public void setUseNonexclusiveLock(boolean useNonexclusiveLock)
useNonexclusiveLock
- public java.lang.String getAltDD()
public void setAltDD(java.lang.String altDD)
public java.lang.String getAltWlsDD()
public void setAltWlsDD(java.lang.String altWlsDD)
public java.lang.String getSecurityModel()
public void setSecurityModel(java.lang.String model) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public boolean isSecurityValidationEnabled()
public void setSecurityValidationEnabled(boolean enable)
public java.lang.String getArchiveVersion()
public void setArchiveVersion(java.lang.String version)
public java.lang.String getPlanVersion()
public void setPlanVersion(java.lang.String planVersion)
public java.lang.String getVersionIdentifier()
public void setVersionIdentifier(java.lang.String version)
public boolean isLibrary()
public void setLibrary(boolean isLibrary)
public java.lang.String getLibSpecVersion()
public void setLibSpecVersion(java.lang.String version)
public java.lang.String getLibImplVersion()
public void setLibImplVersion(java.lang.String version)
public boolean isNameFromLibrary()
public void setNameFromLibrary(boolean nameFromLibrary)
public boolean isNameFromSource()
public void setNameFromSource(boolean nuNameFromSource)
@Deprecated public boolean isTestMode()
DeploymentOptions.FULL_ACCESS
,
DeploymentOptions.ADMIN_ACCESS
@Deprecated public void setTestMode(boolean b)
public boolean isAdminMode()
public void setAdminMode(boolean b)
public int getRetireTime()
public void setRetireTime(int i)
public boolean isRetireGracefully()
public void setRetireGracefully(boolean b)
public boolean isGracefulProductionToAdmin()
public void setGracefulProductionToAdmin(boolean b)
public boolean isGracefulIgnoreSessions()
public void setGracefulIgnoreSessions(boolean b)
public int getRMIGracePeriodSecs()
public void setRMIGracePeriodSecs(int secs)
public boolean isUndeployAllVersions()
public void setUndeployAllVersions(boolean b)
public java.lang.String getStageMode()
public void setStageMode(java.lang.String s)
public java.lang.String getPlanStageMode()
public void setPlanStageMode(java.lang.String s)
public int getClusterDeploymentTimeout()
Milliseconds granted for a cluster deployment task on this application. If any deployment tasks remain active for longer, the task will be canceled.
The larger the application, the larger the value for timeout should be, as the gating factor is associated with download time and processing time required to load the application files.
A server instance checks for timed-out deployments about once a minute.
Only cluster deployments can be timed out.
public void setClusterDeploymentTimeout(int timeInMillis)
public long getForceUndeployTimeout()
public void setForceUndeployTimeout(long timeInSecs)
public boolean usesExpiredLock()
public void setUseExpiredLock(boolean useExpiredLock)
public boolean getSpecifiedTargetsOnly()
public void setSpecifiedTargetsOnly(boolean specifiedTargetsOnly)
public boolean isRemovePlanOverride()
public void setRemovePlanOverride(boolean removePlanOverride)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getName()
public void setName(java.lang.String name)
public boolean isDefaultSubmoduleTargets()
public void setDefaultSubmoduleTargets(boolean defaultSubmoduleTargets)
public boolean isNoVersion()
public void setNoVersion(boolean ignoreVersion)
public long getTimeout()
public void setTimeout(long timeout)
public int getDeploymentOrder()
public void setDeploymentOrder(int order)
public boolean isRemote()
public void setRemote(boolean setRemote)
public boolean isDisableModuleLevelStartStop()
public void setDisableModuleLevelStartStop(boolean disableModuleLevelStartStop)
public void setDeploymentPrincipalName(java.lang.String principal)
public java.lang.String getDeploymentPrincipalName()
public void setPartition(java.lang.String par)
public java.lang.String getPartition()
public void setResourceGroup(java.lang.String rgp)
public java.lang.String getResourceGroup()
public void setResourceGroupTemplate(java.lang.String rgt)
public java.lang.String getResourceGroupTemplate()
public void setUploadPath(java.lang.String path)
public java.lang.String getUploadPath()
public void setOverwriteFile(boolean overwrite)
public boolean getOverwriteFile()
public boolean isRGOrRGTOperation()
public void setSpecifiedModules(java.lang.String specifiedModules)
specifiedModules
- A comma delimited list of modules within an EAR
to which a deployment operation is relevant.
This option is only valid for operations that use
resource group, resource group template, or
partition options.public void setSpecifiedModules(java.lang.String[] specifiedModules)
specifiedModules
- An array of module names within an EAR
to which a deployment operation is relevant.
This option is only valid for operations that use
resource group, resource group template, or
partition options.public java.lang.String[] getSpecifiedModules()
public void setSucceedIfNameUsed(boolean val)
public boolean isSucceedIfNameUsed()
public void setCacheInAppDirectory(boolean val)
val
- whether the temporary application files should be cached
where the staging files are put.public boolean isCacheInAppDirectory()
public void setStartTask(boolean val)
public boolean isStartTask()
public void setAppShutdownOnStop(boolean val)
public boolean isAppShutdownOnStop()
public java.lang.String getEditSessionName()
public void setEditSessionName(java.lang.String editSessionName)
public java.io.File getAltDDFile()
public boolean isTmidsFromConfig()
public void setTmidsFromConfig(boolean tmidsFromConfig)