|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DeploymentManagerMBean
This MBean provides deployment operations. A DeploymentManager object is a stateless interface into the Weblogic Server deployment framework. It currently provides access to the App Deployment Runtime MBeans that allow the user to start and stop deployments. In the future, this MBean may be enhanced with operations to support deployment applications to the domain as well as extended WLS deployment features such as production redeployment and partial deployment of modules in an enterprise application. This MBean emits notifications when an application is created or removed and when the application state changes. The notification types are appdeployment.created, appdeployment.deleted, appdeployment.state.new, appdeployment.state.prepared, appdeployment.state.admin, appdeployment.state.active, appdeployment.state.retired, appdeployment.state.failed, appdeployment.state.update.pending, and appdeployment.state.unknown. The userdata is the object name of the application.
Method Summary | |
---|---|
String |
confirmApplicationName(Boolean isRedeployment,
String appSource,
String tentativeName,
String tentativeApplicationId)
Used by the deployment subsystem to confirm an application name. |
DeploymentProgressObjectMBean |
deploy(String name,
String applicationPath,
String plan)
A convenience method for distributing and starting an application. |
DeploymentProgressObjectMBean |
deploy(String name,
String applicationPath,
String[] targets,
String plan,
Properties deploymentOptions)
A convenience method for distributing and starting an application. |
DeploymentProgressObjectMBean |
distribute(String name,
String applicationPath,
String plan)
Distribute an application. |
DeploymentProgressObjectMBean |
distribute(String name,
String applicationPath,
String[] targets,
String plan,
Properties deploymentOptions)
Distribute an application. |
AppDeploymentRuntimeMBean[] |
getAppDeploymentRuntimes()
Provides access to the applications that are deployed in the domain. |
DeploymentProgressObjectMBean[] |
getDeploymentProgressObjects()
Provides access to the deployment operations that have been performed on this domain. |
LibDeploymentRuntimeMBean[] |
getLibDeploymentRuntimes()
Provides access to the libraries that are deployed to the domain. |
int |
getMaximumDeploymentProgressObjectsCount()
The maximum number of progress objects allowed. |
AppDeploymentRuntimeMBean |
lookupAppDeploymentRuntime(String appName)
Finds the application deployment runtime MBean for an application. |
LibDeploymentRuntimeMBean |
lookupLibDeploymentRuntime(String libName)
Find the library deployment runtime MBean for a library |
void |
purgeCompletedDeploymentProgressObjects()
Removes progress objects for completed operations. |
void |
removeDeploymentProgressObject(String appName)
Remove a progress object. |
void |
setMaximumDeploymentProgressObjectsCount(int maxCount)
Sets the maximum number of progress objects allowed. |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Field Detail |
---|
static final String APPDEPLOYMENT_CREATED
static final String APPDEPLOYMENT_DELETED
static final String APPDEPLOYMENT_NEW
static final String APPDEPLOYMENT_PREPARED
static final String APPDEPLOYMENT_ADMIN
static final String APPDEPLOYMENT_ACTIVE
static final String APPDEPLOYMENT_RETIRED
static final String APPDEPLOYMENT_FAILED
static final String APPDEPLOYMENT_UPDATE_PENDING
static final String APPDEPLOYMENT_UNKNOWN
static final String LIBDEPLOYMENT_CREATED
static final String LIBDEPLOYMENT_DELETED
static final String ADMIN_MODE
static final String ALT_DD
static final String ALT_WLS_DD
static final String APP_VERSION
static final String CREATE_PLAN
static final String CLUSTER_DEPLOYMENT_TIMEOUT
static final String DEFAULT_SUBMODULE_TARGETS
static final String DEPLOYMENT_PRINCIPAL_NAME
static final String DEPLOYMENT_ORDER
static final String FORCE_UNDEPLOYMENT_TIMEOUT
static final String GRACEFUL_IGNORE_SESSIONS
static final String GRACEFUL_PRODUCTION_TO_ADMIN
static final String NO_VERSION
static final String PLAN_VERSION
static final String LIB_SPEC_VERSION
static final String LIB_IMPL_VERSION
static final String LIBRARY
static final String RETIRE_GRACEFULLY
static final String RETIRE_TIMEOUT
static final String RMI_GRACE_PERIOD
static final String SECURITY_MODEL
static final String SECURITY_VALIDATION_ENABLED
static final String STAGE_MODE
static final String SUB_MODULE_TARGETS
static final String TASK_ID
static final String TIMEOUT
static final String USE_NONEXCLUSIVE_LOCK
static final String VERSION_IDENTIFIER
static final String STATIC_DEPLOYMENT
static final String CACHE_IN_APP_DIRECTORY
static final String SPECIFIED_TARGETS_ONLY
Method Detail |
---|
DeploymentProgressObjectMBean deploy(String name, String applicationPath, String plan) throws RuntimeException
If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.
name
- The name of the applicationapplicationPath
- A supported Java EE application or module archive,
or a root diectory for the application or module.plan
- The deployment plan for this application. May be null.
RuntimeException.
- All other errors are reported via the returned
DeploymentProgressObjectMBean.
RuntimeException
DeploymentProgressObjectMBean deploy(String name, String applicationPath, String[] targets, String plan, Properties deploymentOptions) throws RuntimeException
If any modules are currently running, this method immediately restarts those modules using the newer files. Restarting modules in this manner is not the same as redeployment, because session state is not preserved for the active modules.
name
- The name of the applicationapplicationPath
- A supported Java EE application or module archive,
or a root diectory for the application or module.targets
- The targets on which to deploy the
application. This would be server names,
cluster names, or module names in a similar format to
weblogic.Deployer (i.e. module1@server1). If null, the application
will be redeployed on all configured targets.plan
- The deployment plan for this application. May be null.deploymentOptions
- Allows for overriding the deployment options.
If null, default options will be used.
The values should all be of type
The keys,units and default values for options are
clusterDeploymentTimeout milliseconds 3600000,
gracefulIgnoreSessions boolean false,
gracefulProductionToAdmin boolean false,
retireGracefully boolean true,
retireTimeout seconds -1 (no timeout),
adminMode boolean false,
timeout milliseconds 0 (no timeout)
RuntimeException.
- All other errors are reported via the returned
DeploymentProgressObjectMBean.
RuntimeException
DeploymentProgressObjectMBean distribute(String name, String applicationPath, String plan) throws RuntimeException
name
- The name of the applicationapplicationPath
- A supported Java EE application or module archive,
or a root diectory for the application or module.plan
- The deployment plan for this application. May be null.
RuntimeException.
- All other errors are reported via the returned
DeploymentProgressObjectMBean.
RuntimeException
DeploymentProgressObjectMBean distribute(String name, String applicationPath, String[] targets, String plan, Properties deploymentOptions) throws RuntimeException
name
- The name of the applicationapplicationPath
- A supported Java EE application or module archive,
or a root diectory for the application or module.targets
- The targets on which to deploy the
application. This would be server names,
cluster names, or module names in a similar format to
weblogic.Deployer (i.e. module1@server1). If null, the application
will be distributed on all configured targets.plan
- The deployment plan for this application. May be null.deploymentOptions
- Allows for overriding the deployment options.
If null, default options will be used.
The values should all be of type
The keys,units and default values for options are
clusterDeploymentTimeout milliseconds 3600000,
gracefulIgnoreSessions boolean false,
gracefulProductionToAdmin boolean false,
retireGracefully boolean true,
retireTimeout seconds -1 (no timeout),
adminMode boolean false,
timeout milliseconds 0 (no timeout)
RuntimeException.
- All other errors are reported via the returned
DeploymentProgressObjectMBean.
RuntimeException
AppDeploymentRuntimeMBean[] getAppDeploymentRuntimes()
Provides access to the applications that are deployed in the domain.
AppDeploymentRuntimeMBean lookupAppDeploymentRuntime(String appName)
Finds the application deployment runtime MBean for an application.
appName
- The name of the application
LibDeploymentRuntimeMBean[] getLibDeploymentRuntimes()
LibDeploymentRuntimeMBean lookupLibDeploymentRuntime(String libName)
libName
- The name of the library
DeploymentProgressObjectMBean[] getDeploymentProgressObjects()
Provides access to the deployment operations that have been performed on this domain.
void setMaximumDeploymentProgressObjectsCount(int maxCount)
Sets the maximum number of progress objects allowed.
maxCount
- The maximum number of progress objects allowedint getMaximumDeploymentProgressObjectsCount()
The maximum number of progress objects allowed.
void purgeCompletedDeploymentProgressObjects()
Removes progress objects for completed operations.
void removeDeploymentProgressObject(String appName)
Remove a progress object.
appName
- The name of the application that the progress object is forString confirmApplicationName(Boolean isRedeployment, String appSource, String tentativeName, String tentativeApplicationId) throws RuntimeException
isRedeployment
- should be true in the case where this function
is called for a redeployment.appSource
- is a the path to the application.tentativeName
- The name proposed for the application
(provided by the user, or through the manifest).
Null if no name was specified by the user or through the manifest.tentativeApplicationId
- The tentative application id. May only be null if the
application is not versioned. If tentativeName is null and
the application is versioned, this should be just the version
string (which includes both the implementation and
specification versions).
RuntimeException
|
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-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |