public interface DeploymentManagerMBean extends RuntimeMBean
This MBean provides deployment operations.
A DeploymentManager object is a stateless interface into the WebLogic Server deployment framework. It currently provides access to the AppDeploymentRuntimeMBeans 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 WebLogic Server 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:
The userdata is the object name of the application.
Modifier and Type | Method and Description |
---|---|
DeploymentProgressObjectMBean |
appendToExtensionLoader(String codeSourcePath)
Appends a code source to the search path of the WebLogic Extension Loader,
which is also referred to as the WebLogic Domain Loader.
|
DeploymentProgressObjectMBean |
appendToExtensionLoader(String codeSourcePath,
String[] targets,
Properties deploymentOptions)
Appends a code source to the search path of the WebLogic Extension Loader,
which is also referred to as the WebLogic Domain Loader.
|
String |
confirmApplicationName(Boolean isRedeployment,
String appSource,
String altAppDescriptor,
String tentativeName,
String tentativeApplicationId)
Used by the deployment subsystem to confirm an application name.
|
String |
confirmApplicationName(Boolean isRedeployment,
String appSource,
String altAppDescriptor,
String tentativeName,
String tentativeApplicationId,
Properties deploymentOptions)
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.
|
AppDeploymentRuntimeMBean |
lookupAppDeploymentRuntime(String appName,
Properties deploymentOptions)
Finds the application deployment runtime MBean for an application based on the deploymentOptions parameter.
|
LibDeploymentRuntimeMBean |
lookupLibDeploymentRuntime(String libName)
Find the library deployment runtime MBean for a library.
|
void |
purgeCompletedDeploymentProgressObjects()
Removes progress objects for completed operations.
|
DeploymentProgressObjectMBean |
redeploy(String name,
String plan,
Properties deploymentOptions)
Redeploy the application that is deployed to a resource group template
in the background for the targets specified
with the options specified.
|
DeploymentProgressObjectMBean |
redeploy(String name,
String applicationPath,
String plan,
Properties deploymentOptions)
Redeploy the application that is deployed to a resource group template
in the background for the targets specified
with the options specified.
|
void |
removeDeploymentProgressObject(String appName)
Removes a progress object.
|
void |
setMaximumDeploymentProgressObjectsCount(int maxCount)
Sets the maximum number of progress objects allowed.
|
DeploymentProgressObjectMBean |
undeploy(String name,
Properties deploymentOptions)
Undeploy the application that is deployed to a resource group template in the background
with the options specified.
|
DeploymentProgressObjectMBean |
undeploy(String name,
String template)
Undeploy the application that is deployed to a resource group
template using the default options.
|
DeploymentProgressObjectMBean |
update(String name,
String plan,
Properties deploymentOptions)
Allows for updating an application configuration using an changed
deployment plan for applications deployed to a resource group template.
|
addPropertyChangeListener, removePropertyChangeListener
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preDeregister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
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
static final String PARTITION
static final String EDIT_SESSION
static final String RESOURCE_GROUP
static final String RESOURCE_GROUP_TEMPLATE
static final String REMOVE_PLAN_OVERRIDE
static final String START_TASK
DeploymentProgressObjectMBean deploy(String name, String applicationPath, String plan) throws RuntimeException
A convenience method for distributing and starting an application.
The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the deploy operation has completed. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.
The default options are
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 directory 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
A convenience method for distributing and starting an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately. If distribution is successful, the application is then started on each of the targets. Successful deployment requires that all targets receive both the archive and deployment plan.
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 directory 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
Distribute an application.
The application source files and deployment plan are distributed to the deployment targets using the default options. This is a synchronous operation that returns when the distribute operation has completed.
The default options are:
name
- The name of the applicationapplicationPath
- A supported Java EE application or module archive,
or a root directory 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
Distribute an application. The application source files and deployment plan are distributed to the deployment targets using the options specified. This is an asynchronous operation that returns immediately.
name
- The name of the applicationapplicationPath
- A supported Java EE application or module archive,
or a root directory 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
DeploymentProgressObjectMBean appendToExtensionLoader(String codeSourcePath) throws RuntimeException
Appends a code source to the search path of the WebLogic Extension Loader, which is also referred to as the WebLogic Domain Loader. The code source file is distributed to all targets using default options. When the operation is complete, classes and resources in the jar file will be visible for class loading at the extension loader. Since the jar is now in place on targeted servers, the classes and resources will continue to be available even after a targeted server restarts. This is an asynchronous operation that returns immediately.
codeSourcePath
- A jar file to add to the extension loaderRuntimeException.
- All other errors are reported via the returned
DeploymentProgressObjectMBean.RuntimeException
DeploymentProgressObjectMBean appendToExtensionLoader(String codeSourcePath, String[] targets, Properties deploymentOptions) throws RuntimeException
Appends a code source to the search path of the WebLogic Extension Loader, which is also referred to as the WebLogic Domain Loader. The code source file is distributed to the targets using the options specified. When the operation is complete, classes and resources in the jar file will be visible for class loading at the extension loader. Since the jar is now in place on targeted servers, the classes and resources will continue to be available even after a targeted server restarts. This is an asynchronous operation that returns immediately.
codeSourcePath
- A jar file to add to the extension loadertargets
- The targets on which to distribute the
code source. This would be server names or
cluster names. If null, the code source
will be distributed on all configured targets.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,
retireTimeout seconds -1 (no timeout),
timeout milliseconds 0 (no timeout)RuntimeException.
- All other errors are reported via the returned
DeploymentProgressObjectMBean.RuntimeException
DeploymentProgressObjectMBean undeploy(String name, String template) throws RuntimeException
Undeploy the application that is deployed to a resource group template using the default options. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
name
- The application nametemplate
- The resource group templateDeploymentProgressObjectMBean
An object that provides the
state of the undeploy operation.RuntimeExceptionm
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.RuntimeException
DeploymentProgressObjectMBean undeploy(String name, Properties deploymentOptions) throws RuntimeException
Undeploy the application that is deployed to a resource group template in the background
with the options specified. This is an asynchronous operation that
returns immediately. The returned DeploymentProgressObjectMBean
can be used to determine when the operation is completed.
Note that this API is only for undeploying applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for undeploying applications that are not deployed to a resource group template.
name
- The application namedeploymentOptions
- Allows for overriding the deployment options.
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)
resourceGroupTemplate this value is requiredRuntimeException
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.DeploymentProgressObjectMBean redeploy(String name, String plan, Properties deploymentOptions) throws RuntimeException
Redeploy the application that is deployed to a resource group template
in the background for the targets specified
with the options specified. This is an asynchronous operation that
returns immediately. The returned DeploymentProgressObjectMBean
can be used to determine when the operation is completed.
Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.
name
- The application nameplan
- The deployment plan for this application. May be null.deploymentOptions
- Allows for overriding the deployment options.
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)
resourceGroupTemplate this value is requiredRuntimeException
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.DeploymentProgressObjectMBean redeploy(String name, String applicationPath, String plan, Properties deploymentOptions) throws RuntimeException
Redeploy the application that is deployed to a resource group template
in the background for the targets specified
with the options specified. This is an asynchronous operation that
returns immediately. The returned DeploymentProgressObjectMBean
can be used to determine when the operation is completed.
Note that this API is only for redeploying applications or libraries that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for redeploying applications that are not deployed to a resource group template, and LibDeploymentRuntimeMBean should be used for redeploying libraries that are not deployed to a resource group template.
name
- The application nameapplicationPath
- A supported Java EE application or module archive,
or a root diectory for the application or module. May be null.plan
- The deployment plan for this application. May be null.deploymentOptions
- Allows for overriding the deployment options.
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)
resourceGroupTemplate this value is requiredRuntimeException
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.DeploymentProgressObjectMBean update(String name, String plan, Properties deploymentOptions) throws RuntimeException
Allows for updating an application configuration using an changed deployment plan for applications deployed to a resource group template.
A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.
The update succeeds only if changes to the deployment plan do not
require the application to be restarted. Configuration changes in
the new deployment plan must be limited to
tuning the application. Changes to resource bindings causes
the update to fail. Use DeploymentManagerMBean.redeploy(String, String, Properties)
to apply resource binding changes to a production application.
This method targets only root modules. Module level targeting is not supported.
Note that this API is only for updating applications that are deployed to a resource group template, and a resourceGroupTemplate property value must be provided in deploymentOptions. AppDeploymentRuntimeMBean should be used for updating applications that are not deployed to a resource group template.
name
- The application nameplan
- The deployment plan for this application. May be null.deploymentOptions
- Allows for overriding the deployment options.
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)
resourceGroupTemplate this value is requiredRuntimeException
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.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 applicationAppDeploymentRuntimeMBean lookupAppDeploymentRuntime(String appName, Properties deploymentOptions)
Finds the application deployment runtime MBean for an application based on the deploymentOptions parameter.
appName
- The name of the applicationdeploymentOptions
- Used to specify a partition.LibDeploymentRuntimeMBean[] getLibDeploymentRuntimes()
LibDeploymentRuntimeMBean lookupLibDeploymentRuntime(String libName)
libName
- The name of the libraryDeploymentProgressObjectMBean[] 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)
Removes a progress object.
appName
- The name of the application that the progress object is forString confirmApplicationName(Boolean isRedeployment, String appSource, String altAppDescriptor, 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.optional
- alternate application descriptor pathtentativeName
- 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
String confirmApplicationName(Boolean isRedeployment, String appSource, String altAppDescriptor, String tentativeName, String tentativeApplicationId, Properties deploymentOptions) 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.optional
- alternate app descriptor.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).deploymentOptions
- deployment optionsRuntimeException