DeploymentOptions (Java API Reference for Oracle WebLogic Server)

java.lang.Object
- weblogic.deploy.api.spi.DeploymentOptions

All Implemented Interfaces:

java.io.Serializable
```
public final class DeploymentOptions
extends java.lang.Object
implements java.io.Serializable
```
Common options for deployment operations.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`ADMIN_ACCESS`	Start Web application with restricted access (test mode).
`static int`	`CLUSTER_DEPLOYMENT_TIMEOUT`	Default deployment timeout value for deployment operations.
`static java.lang.String`	`EXTERNAL_STAGE`	Manual staging of files.
`static boolean`	`FULL_ACCESS`	Start Web application with normal access.
`static java.lang.String`	`NOSTAGE`	Inhibit copying of files to target servers.
`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`
`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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAltDD()`	A path on the file system for the application descriptor for this application.
`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()`
`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.
`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`	`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`	`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`	`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`	`isSecurityValidationEnabled()`	Specifies whether security deployment data should be validated.
`boolean`	`isSucceedIfNameUsed()`
`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`	`setArchiveVersion(java.lang.String version)`	Specifies the application version for the application.
`void`	`setClusterDeploymentTimeout(int timeInMillis)`
`void`	`setDeploymentOrder(int order)`	Sets the DeploymentOrder.
`void`	`setDeploymentPrincipalName(java.lang.String principal)`
`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`	`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`	`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`	`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`	`setSucceedIfNameUsed(boolean val)`
`void`	`setTimeout(long timeout)`	The maximum time in milliseconds for the deployment to complete before it it is considered to have failed.
`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`	`setVersionIdentifier(java.lang.String version)`	Specifies the full version identifier for this deployment.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STAGE_DEFAULT
```
public static final java.lang.String STAGE_DEFAULT
```
    Use the default or configured staging mode.
  - PLAN_STAGE_DEFAULT
```
public static final java.lang.String PLAN_STAGE_DEFAULT
```
  - STAGE
```
public static final java.lang.String STAGE
```
    Force copying of files to target servers.
    
    See Also:
    
    Constant Field Values
  - PLAN_STAGE
```
public static final java.lang.String PLAN_STAGE
```
    See Also:
    
    Constant Field Values
  - NOSTAGE
```
public static final java.lang.String NOSTAGE
```
    Inhibit copying of files to target servers.
    
    See Also:
    
    Constant Field Values
  - PLAN_NOSTAGE
```
public static final java.lang.String PLAN_NOSTAGE
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_STAGE
```
public static final java.lang.String EXTERNAL_STAGE
```
    Manual staging of files.
    
    See Also:
    
    Constant Field Values
  - PLAN_EXTERNAL_STAGE
```
public static final java.lang.String PLAN_EXTERNAL_STAGE
```
    See Also:
    
    Constant Field Values
  - FULL_ACCESS
```
public static final boolean FULL_ACCESS
```
    Start Web application with normal access.
    
    See Also:
    
    Constant Field Values
  - ADMIN_ACCESS
```
public static final boolean ADMIN_ACCESS
```
    Start Web application with restricted access (test mode).
    
    See Also:
    
    Constant Field Values
  - CLUSTER_DEPLOYMENT_TIMEOUT
```
public static final int CLUSTER_DEPLOYMENT_TIMEOUT
```
    Default deployment timeout value for deployment operations. Time is in milliseconds.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAltDD
```
public java.lang.String getAltDD()
```
    A path on the file system for the application descriptor for this application. If null, the usual location within the EAR file is used (META-INF/application.xml).
  - setAltDD
```
public void setAltDD(java.lang.String altDD)
```
    Specifies an alternate path on the file system of the application descriptor for this application.
  - getAltWlsDD
```
public java.lang.String getAltWlsDD()
```
    A path on the file system for the WebLogic Server-specific application descriptor for this application. If null, the usual location within the EAR file is used (META-INF/weblogic-application.xml).
  - setAltWlsDD
```
public void setAltWlsDD(java.lang.String altWlsDD)
```
    Specifies an alternate path on the file system of the WebLogic Server-specific application descriptor for this application.
  - getSecurityModel
```
public java.lang.String getSecurityModel()
```
    The security deployment model to use for this application. If null, the security model used is derived from the security realm or the application's deployment security setting.
    
    Returns:
    
    the name of the deployment model
  - setSecurityModel
```
public void setSecurityModel(java.lang.String model)
                      throws java.lang.IllegalArgumentException
```
    Specifies a security deployment model to use for this application. Legal values are defined by weblogic.management.security.DeploymentModel.DD_ONLY, weblogic.management.security.DeploymentModel.CUSTOM_ROLES, weblogic.management.security.DeploymentModel.CUSTOM_ROLES_POLICIES, and weblogic.management.security.DeploymentModel.ADVANCED
    
    Throws:
    
    java.lang.IllegalArgumentException
  - isSecurityValidationEnabled
```
public boolean isSecurityValidationEnabled()
```
    Specifies whether security deployment data should be validated. The default is false.
  - setSecurityValidationEnabled
```
public void setSecurityValidationEnabled(boolean enable)
```
    Specifies whether to validate security deployment data.
  - getArchiveVersion
```
public java.lang.String getArchiveVersion()
```
    The version identifier of the application. If not specified, the currently active version of the application is assumed. For new applications, the default is the version specified in the archive's manifest.
    
    Returns:
    
    version of application archive being deployed.
  - setArchiveVersion
```
public void setArchiveVersion(java.lang.String version)
```
    Specifies the application version for the application.
  - getPlanVersion
```
public java.lang.String getPlanVersion()
```
    The version identifier of the deployment plan used in this deployment. If not specified, the currently active version of the application's plan is assumed. If a deployment plan is specified in the deployment operation, the version number in that plan is the default version used.
    
    Returns:
    
    version of application archive being deployed.
  - setPlanVersion
```
public void setPlanVersion(java.lang.String planVersion)
```
    Specifies a deployment plan version for this deployment.
  - getVersionIdentifier
```
public java.lang.String getVersionIdentifier()
```
    The full version identifier of the application for this deployment, including the archive and plan versions.
  - setVersionIdentifier
```
public void setVersionIdentifier(java.lang.String version)
```
    Specifies the full version identifier for this deployment. Implicitly sets the archive and plan version properties.
  - isLibrary
```
public boolean isLibrary()
```
    Indicates whether the application is to be deployed as a library. The default is false.
  - setLibrary
```
public void setLibrary(boolean isLibrary)
```
    Specifies if the application is a library.
  - getLibSpecVersion
```
public java.lang.String getLibSpecVersion()
```
    The specification version of a library application. The default is the value specified in the library's manifest. Library version identifiers are made up from the specification and implementation versions.
  - setLibSpecVersion
```
public void setLibSpecVersion(java.lang.String version)
```
    Specifies the specification version of a library application if it is not present in the manifest.
  - getLibImplVersion
```
public java.lang.String getLibImplVersion()
```
    The implementation version of a library application. The default is the value specified in the library's manifest. Library version identifiers are made up from the specification and implementation versions.
  - setLibImplVersion
```
public void setLibImplVersion(java.lang.String version)
```
    Specifies the implementation version of a library application if it is not present in the manifest.
  - isNameFromLibrary
```
public boolean isNameFromLibrary()
```
    Indicates that the application name should be derived from the library manifest. The default is false.
  - setNameFromLibrary
```
public void setNameFromLibrary(boolean nameFromLibrary)
```
    Specifies that the application name should be derived from the library manifest. If this deployment is for a library that specifies its name in its manifest, this property should be set to true.
  - isAdminMode
```
public boolean isAdminMode()
```
    Indicates whether a Web application should be started with restricted access. Restricted access implies the application will only receive requests over an administrative port. This option is only meaningful for operations that start or stop an application. The default is false.
  - setAdminMode
```
public void setAdminMode(boolean b)
```
    Specifies whether an application should be deployed with restricted access.
    
    See Also:
    
    FULL_ACCESS, ADMIN_ACCESS
  - getRetireTime
```
public int getRetireTime()
```
    Specifies how long to wait in seconds before retiring an application that has been replaced with a newer version. This policy is only meaningful for redeploy operations and is mutually exclusive to the graceful retirement policy.
  - setRetireTime
```
public void setRetireTime(int i)
```
    Sets the value for RetireTime attribute.
  - isRetireGracefully
```
public boolean isRetireGracefully()
```
    Specifies the retirement policy to gracefully retire an application only after it has completed all in-flight work. This policy is only meaningful for redeploy operations and is mutually exclusive to the retire timeout policy.
  - setRetireGracefully
```
public void setRetireGracefully(boolean b)
```
    Sets the value for RetireGracefully attribute.
  - isGracefulProductionToAdmin
```
public boolean isGracefulProductionToAdmin()
```
    Specifies whether the production to administration mode operation should be graceful. The default is false, indicating the application is forced into administration mode.
  - setGracefulProductionToAdmin
```
public void setGracefulProductionToAdmin(boolean b)
```
  - isGracefulIgnoreSessions
```
public boolean isGracefulIgnoreSessions()
```
    Specifies whether the graceful production to administration mode operation should ignore pending HTTP sessions. The default is false.
  - setGracefulIgnoreSessions
```
public void setGracefulIgnoreSessions(boolean b)
```
  - getRMIGracePeriodSecs
```
public int getRMIGracePeriodSecs()
```
    Specifies the RMI grace period for the graceful production to administration mode operation.
  - setRMIGracePeriodSecs
```
public void setRMIGracePeriodSecs(int secs)
```
    Sets the RMI grace period for the graceful production to administration mode operation.
  - isUndeployAllVersions
```
public boolean isUndeployAllVersions()
```
    Specifies whether the undeploy operation should undeploy all application versions irrespective of in-flight work.
  - setUndeployAllVersions
```
public void setUndeployAllVersions(boolean b)
```
    Sets the value for the UndeployAllVersions attribute.
  - getStageMode
```
public java.lang.String getStageMode()
```
    Indicates how files will be made available to Managed Servers. This option is only meaningful for operations that involve initial application file distribution. Attempts to change the staging mode of an existing application will fail.
  - setStageMode
```
public void setStageMode(java.lang.String s)
```
    Sets the value of the StagingMode attribute.
  - getPlanStageMode
```
public java.lang.String getPlanStageMode()
```
    Indicates how the deployment plan will be made available to Managed Servers. This option is only meaningful for operations that involve initial application file distribution. Attempts to change the plan staging mode of an existing application will fail.
  - setPlanStageMode
```
public void setPlanStageMode(java.lang.String s)
```
    Sets the value of the PlanStagingMode attribute.
  - getClusterDeploymentTimeout
```
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.
    
    Returns:
    
    The deploymentTimeout value
    
    Default Value:
    
    ApplicationMBean.DEPLOYMENT_TIMEOUT
  - setClusterDeploymentTimeout
```
public void setClusterDeploymentTimeout(int timeInMillis)
```
  - getForceUndeployTimeout
```
public long getForceUndeployTimeout()
```
  - setForceUndeployTimeout
```
public void setForceUndeployTimeout(long timeInSecs)
```
  - getSpecifiedTargetsOnly
```
public boolean getSpecifiedTargetsOnly()
```
    Returns whether the operation should be done only to the specified targets when the targets are in a cluster.
  - setSpecifiedTargetsOnly
```
public void setSpecifiedTargetsOnly(boolean specifiedTargetsOnly)
```
    Specifies that the operation should be done only to the specified targets when the targets are in a cluster.
  - isRemovePlanOverride
```
public boolean isRemovePlanOverride()
```
    Returns whether the operation should remove the deployment plan.
  - setRemovePlanOverride
```
public void setRemovePlanOverride(boolean removePlanOverride)
```
    Specifies that the operation should remove the deployment plan.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    override of the application name. Used only on the client side.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the application.
  - isNoVersion
```
public 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.
  - setNoVersion
```
public 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.
  - getTimeout
```
public long getTimeout()
```
    User provided timeout value in milliseconds. The maximum time for the deployment to complete before it it is considered to have failed.
    
    Returns:
    
    timeout value or 0 if none.
  - setTimeout
```
public void setTimeout(long timeout)
```
    The maximum time in milliseconds for the deployment to complete before it it is considered to have failed. The default value is 0, indicating no timeout value.
  - getDeploymentOrder
```
public int getDeploymentOrder()
```
    DeploymentOrder is a priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.
  - setDeploymentOrder
```
public void setDeploymentOrder(int order)
```
    Sets the DeploymentOrder.
  - isRemote
```
public boolean isRemote()
```
    Indicates that the operation will be remote from the file system that contains the source. This means the source for the operation is expected to be at the specified location on the machine where the server is located.
  - setRemote
```
public void setRemote(boolean setRemote)
```
    Indicates that the operation will be remote from the file system that contains the source. This means the source for the operation is expected to be at the specified location on the machine where the server is located.
  - setDeploymentPrincipalName
```
public void setDeploymentPrincipalName(java.lang.String principal)
```
  - getDeploymentPrincipalName
```
public java.lang.String getDeploymentPrincipalName()
```
  - setPartition
```
public void setPartition(java.lang.String par)
```
    Specifies the partition which the deployment operations will be scoped to.
  - getPartition
```
public java.lang.String getPartition()
```
    Returns the partition which the deployment operations will be scoped to.
  - setResourceGroup
```
public void setResourceGroup(java.lang.String rgp)
```
    Specifies the resource group which the deployment operations will be scoped to.
  - getResourceGroup
```
public java.lang.String getResourceGroup()
```
    Returns the resource group which the deployment operations will be scoped to.
  - setResourceGroupTemplate
```
public void setResourceGroupTemplate(java.lang.String rgt)
```
    Specifies the resource group template which the deployment operations will be scoped to.
  - getResourceGroupTemplate
```
public java.lang.String getResourceGroupTemplate()
```
    Returns the resource group template which the deployment operations will be scoped to.
  - setUploadPath
```
public void setUploadPath(java.lang.String path)
```
    Specifies the relative upload path used for partition use file system file upload.
  - getUploadPath
```
public java.lang.String getUploadPath()
```
    Returns the relative upload path used for partition use file system file upload.
  - setOverwriteFile
```
public void setOverwriteFile(boolean overwrite)
```
    Specifies the overwrite flag used for partition use file system file upload.
  - getOverwriteFile
```
public boolean getOverwriteFile()
```
    Returns the overwrite flag used for partition use file system file upload.
  - setSucceedIfNameUsed
```
public void setSucceedIfNameUsed(boolean val)
```
  - isSucceedIfNameUsed
```
public boolean isSucceedIfNameUsed()
```

Class DeploymentOptions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STAGE_DEFAULT

PLAN_STAGE_DEFAULT

STAGE

PLAN_STAGE

NOSTAGE

PLAN_NOSTAGE

EXTERNAL_STAGE

PLAN_EXTERNAL_STAGE

FULL_ACCESS

ADMIN_ACCESS

CLUSTER_DEPLOYMENT_TIMEOUT

Method Detail

getAltDD

setAltDD

getAltWlsDD

setAltWlsDD

getSecurityModel

setSecurityModel

isSecurityValidationEnabled

setSecurityValidationEnabled

getArchiveVersion

setArchiveVersion

getPlanVersion

setPlanVersion

getVersionIdentifier

setVersionIdentifier

isLibrary

setLibrary

getLibSpecVersion

setLibSpecVersion

getLibImplVersion

setLibImplVersion

isNameFromLibrary

setNameFromLibrary

isAdminMode

setAdminMode

getRetireTime

setRetireTime

isRetireGracefully

setRetireGracefully

isGracefulProductionToAdmin

setGracefulProductionToAdmin

isGracefulIgnoreSessions

setGracefulIgnoreSessions

getRMIGracePeriodSecs

setRMIGracePeriodSecs

isUndeployAllVersions

setUndeployAllVersions

getStageMode

setStageMode

getPlanStageMode

setPlanStageMode

getClusterDeploymentTimeout

setClusterDeploymentTimeout

getForceUndeployTimeout

setForceUndeployTimeout

getSpecifiedTargetsOnly

setSpecifiedTargetsOnly

isRemovePlanOverride

setRemovePlanOverride

toString

getName

setName

isNoVersion

setNoVersion

getTimeout

setTimeout

getDeploymentOrder

setDeploymentOrder

isRemote

setRemote

setDeploymentPrincipalName

getDeploymentPrincipalName

setPartition

getPartition