|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-01 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweblogic.deploy.api.spi.DeploymentOptions
public final class DeploymentOptions
Common options for deployment operations.
Field Summary | |
---|---|
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 String |
EXTERNAL_STAGE
Manual staging of files. |
static boolean |
FULL_ACCESS
Start Web application with normal access. |
static String |
NOSTAGE
Inhibit copying of files to target servers. |
static String |
PLAN_EXTERNAL_STAGE
|
static String |
PLAN_NOSTAGE
|
static String |
PLAN_STAGE
|
static String |
PLAN_STAGE_DEFAULT
|
static String |
STAGE
Force copying of files to target servers. |
static String |
STAGE_DEFAULT
Use the default or configured staging mode. |
Constructor Summary | |
---|---|
DeploymentOptions()
Create instance with defaulted options. |
Method Summary | |
---|---|
String |
getAltDD()
A path on the file system for the application descriptor for this application. |
String |
getAltWlsDD()
A path on the file system for the WebLogic Server-specific application descriptor for this application. |
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. |
String |
getDeploymentPrincipalName()
|
long |
getForceUndeployTimeout()
Specifies the timeout value in seconds for the force undeploy operation. |
String |
getLibImplVersion()
The implementation version of a library application. |
String |
getLibSpecVersion()
The specification version of a library application. |
String |
getName()
|
String |
getPlanStageMode()
Indicates how the deployment plan will be made available to Managed Servers. |
String |
getPlanVersion()
The version identifier of the deployment plan used in this deployment. |
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. |
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. |
String |
getStageMode()
Indicates how files will be made available to Managed Servers. |
long |
getTimeout()
User provided timeout value in milliseconds. |
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 |
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)
Specify whether application should be deployed with restricted access. |
void |
setAltDD(String altDD)
Specifies an alternate path on the file system of the application descriptor for this application. |
void |
setAltWlsDD(String altWlsDD)
Specifies an alternate path on the file system of the WebLogic Server-specific application descriptor for this application. |
void |
setArchiveVersion(String version)
Specifies the application version for the application. |
void |
setClusterDeploymentTimeout(int timeInMillis)
|
void |
setDeploymentOrder(int order)
Set the DeploymentOrder. |
void |
setDeploymentPrincipalName(String principal)
|
void |
setForceUndeployTimeout(long timeInSecs)
|
void |
setGracefulIgnoreSessions(boolean b)
|
void |
setGracefulProductionToAdmin(boolean b)
|
void |
setLibImplVersion(String version)
Specifies the implementation version of a library application if it is not present in the manifest. |
void |
setLibrary(boolean isLibrary)
Specify if application is a library. |
void |
setLibSpecVersion(String version)
Specifies the specification version of a library application if it is not present in the manifest. |
void |
setName(String name)
Sets the name of the application. |
void |
setNameFromLibrary(boolean nameFromLibrary)
Specify 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 |
setPlanStageMode(String s)
Sets the value of the PlanStagingMode attribute. |
void |
setPlanVersion(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 |
setRetireGracefully(boolean b)
Sets the value for RetireGracefully attribute. |
void |
setRetireTime(int i)
Sets the value for RetireTime attribute. |
void |
setRMIGracePeriodSecs(int secs)
Sets RMI grame period for the graceful production to administration mode operation. |
void |
setSecurityModel(String model)
Specifies a security deployment model to use for this application. |
void |
setSecurityValidationEnabled(boolean enable)
Specify 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(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 UndeployAllVersions attribute. |
void |
setVersionIdentifier(String version)
Specifies the full version identifier for this deployment. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String STAGE_DEFAULT
public static final String PLAN_STAGE_DEFAULT
public static final String STAGE
public static final String PLAN_STAGE
public static final String NOSTAGE
public static final String PLAN_NOSTAGE
public static final String EXTERNAL_STAGE
public static final String PLAN_EXTERNAL_STAGE
public static final boolean FULL_ACCESS
public static final boolean ADMIN_ACCESS
public static final int CLUSTER_DEPLOYMENT_TIMEOUT
Constructor Detail |
---|
public DeploymentOptions()
Method Detail |
---|
public String getAltDD()
public void setAltDD(String altDD)
public String getAltWlsDD()
public void setAltWlsDD(String altWlsDD)
public String getSecurityModel()
public void setSecurityModel(String model) throws IllegalArgumentException
IllegalArgumentException
public boolean isSecurityValidationEnabled()
public void setSecurityValidationEnabled(boolean enable)
public String getArchiveVersion()
public void setArchiveVersion(String version)
public String getPlanVersion()
public void setPlanVersion(String planVersion)
public String getVersionIdentifier()
public void setVersionIdentifier(String version)
public boolean isLibrary()
public void setLibrary(boolean isLibrary)
public String getLibSpecVersion()
public void setLibSpecVersion(String version)
public String getLibImplVersion()
public void setLibImplVersion(String version)
public boolean isNameFromLibrary()
public void setNameFromLibrary(boolean nameFromLibrary)
public boolean isAdminMode()
public void setAdminMode(boolean b)
DeploymentOptions.FULL_ACCESS
,
DeploymentOptions.ADMIN_ACCESS
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 String getStageMode()
public void setStageMode(String s)
public String getPlanStageMode()
public void setPlanStageMode(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 cancelled.
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 getSpecifiedTargetsOnly()
public void setSpecifiedTargetsOnly(boolean specifiedTargetsOnly)
public String toString()
toString
in class Object
public String getName()
public void setName(String name)
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 void setDeploymentPrincipalName(String principal)
public String getDeploymentPrincipalName()
public void setSucceedIfNameUsed(boolean val)
public boolean isSucceedIfNameUsed()
|
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |