Skip navigation links

weblogic.management.runtime
Interface DeploymentManagerMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

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:

• 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
• appdeployment.state.unknown

The userdata is the object name of the application.

Since:

10.3.6.0

APPDEPLOYMENT_CREATED

static final String APPDEPLOYMENT_CREATED

See Also:

Constant Field Values

APPDEPLOYMENT_DELETED

static final String APPDEPLOYMENT_DELETED

See Also:

Constant Field Values

APPDEPLOYMENT_NEW

static final String APPDEPLOYMENT_NEW

See Also:

Constant Field Values

APPDEPLOYMENT_PREPARED

static final String APPDEPLOYMENT_PREPARED

See Also:

Constant Field Values

APPDEPLOYMENT_ADMIN

static final String APPDEPLOYMENT_ADMIN

See Also:

Constant Field Values

APPDEPLOYMENT_ACTIVE

static final String APPDEPLOYMENT_ACTIVE

See Also:

Constant Field Values

APPDEPLOYMENT_RETIRED

static final String APPDEPLOYMENT_RETIRED

See Also:

Constant Field Values

APPDEPLOYMENT_FAILED

static final String APPDEPLOYMENT_FAILED

See Also:

Constant Field Values

APPDEPLOYMENT_UPDATE_PENDING

static final String APPDEPLOYMENT_UPDATE_PENDING

See Also:

Constant Field Values

APPDEPLOYMENT_UNKNOWN

static final String APPDEPLOYMENT_UNKNOWN

See Also:

Constant Field Values

LIBDEPLOYMENT_CREATED

static final String LIBDEPLOYMENT_CREATED

See Also:

Constant Field Values

LIBDEPLOYMENT_DELETED

static final String LIBDEPLOYMENT_DELETED

See Also:

Constant Field Values

ADMIN_MODE

static final String ADMIN_MODE

See Also:

Constant Field Values

ALT_DD

static final String ALT_DD

See Also:

Constant Field Values

ALT_WLS_DD

static final String ALT_WLS_DD

See Also:

Constant Field Values

APP_VERSION

static final String APP_VERSION

See Also:

Constant Field Values

CREATE_PLAN

static final String CREATE_PLAN

See Also:

Constant Field Values

CLUSTER_DEPLOYMENT_TIMEOUT

static final String CLUSTER_DEPLOYMENT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SUBMODULE_TARGETS

static final String DEFAULT_SUBMODULE_TARGETS

See Also:

Constant Field Values

DEPLOYMENT_PRINCIPAL_NAME

static final String DEPLOYMENT_PRINCIPAL_NAME

See Also:

Constant Field Values

DEPLOYMENT_ORDER

static final String DEPLOYMENT_ORDER

See Also:

Constant Field Values

FORCE_UNDEPLOYMENT_TIMEOUT

static final String FORCE_UNDEPLOYMENT_TIMEOUT

See Also:

Constant Field Values

GRACEFUL_IGNORE_SESSIONS

static final String GRACEFUL_IGNORE_SESSIONS

See Also:

Constant Field Values

GRACEFUL_PRODUCTION_TO_ADMIN

static final String GRACEFUL_PRODUCTION_TO_ADMIN

See Also:

Constant Field Values

NO_VERSION

static final String NO_VERSION

See Also:

Constant Field Values

PLAN_VERSION

static final String PLAN_VERSION

See Also:

Constant Field Values

LIB_SPEC_VERSION

static final String LIB_SPEC_VERSION

See Also:

Constant Field Values

LIB_IMPL_VERSION

static final String LIB_IMPL_VERSION

See Also:

Constant Field Values

LIBRARY

static final String LIBRARY

See Also:

Constant Field Values

RETIRE_GRACEFULLY

static final String RETIRE_GRACEFULLY

See Also:

Constant Field Values

RETIRE_TIMEOUT

static final String RETIRE_TIMEOUT

See Also:

Constant Field Values

RMI_GRACE_PERIOD

static final String RMI_GRACE_PERIOD

See Also:

Constant Field Values

SECURITY_MODEL

static final String SECURITY_MODEL

See Also:

Constant Field Values

SECURITY_VALIDATION_ENABLED

static final String SECURITY_VALIDATION_ENABLED

See Also:

Constant Field Values

STAGE_MODE

static final String STAGE_MODE

See Also:

Constant Field Values

SUB_MODULE_TARGETS

static final String SUB_MODULE_TARGETS

See Also:

Constant Field Values

TASK_ID

static final String TASK_ID

See Also:

Constant Field Values

TIMEOUT

static final String TIMEOUT

See Also:

Constant Field Values

USE_NONEXCLUSIVE_LOCK

static final String USE_NONEXCLUSIVE_LOCK

See Also:

Constant Field Values

VERSION_IDENTIFIER

static final String VERSION_IDENTIFIER

See Also:

Constant Field Values

STATIC_DEPLOYMENT

static final String STATIC_DEPLOYMENT

See Also:

Constant Field Values

CACHE_IN_APP_DIRECTORY

static final String CACHE_IN_APP_DIRECTORY

See Also:

Constant Field Values

SPECIFIED_TARGETS_ONLY

static final String SPECIFIED_TARGETS_ONLY

See Also:

Constant Field Values

PARTITION

static final String PARTITION

See Also:

Constant Field Values

EDIT_SESSION

static final String EDIT_SESSION

See Also:

Constant Field Values

RESOURCE_GROUP

static final String RESOURCE_GROUP

See Also:

Constant Field Values

RESOURCE_GROUP_TEMPLATE

static final String RESOURCE_GROUP_TEMPLATE

See Also:

Constant Field Values

REMOVE_PLAN_OVERRIDE

static final String REMOVE_PLAN_OVERRIDE

See Also:

Constant Field Values

START_TASK

static final String START_TASK

See Also:

Constant Field Values

deploy

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

• clusterDeploymentTimeout: 3600000 milliseconds
• gracefulIgnoreSessions: false
• gracefulProductionToAdmin: false
• retireGracefully: true
• retireTimeout: no timeout
• adminMode: false
• timeout: no timeout

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.

Parameters:

name - The name of the application

applicationPath - 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.

Returns:

DeploymentProgressObjectMBean Provides the state of the deploy.

Throws:

RuntimeException. - All other errors are reported via the returned DeploymentProgressObjectMBean.

RuntimeException

deploy

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.

Parameters:

name - The name of the application

applicationPath - 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)

Returns:

DeploymentProgressObjectMBean Provides the state of the deploy.

Throws:

RuntimeException. - All other errors are reported via the returned DeploymentProgressObjectMBean.

RuntimeException

distribute

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:

• clusterDeploymentTimeout: 3600000 milliseconds
• gracefulIgnoreSessions: false
• gracefulProductionToAdmin: false
• retireGracefully: true
• retireTimeout: no timeout
• adminMode: false,
• timeout: no timeout

Parameters:

name - The name of the application

applicationPath - 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.

Returns:

DeploymentProgressObjectMBean Provides the state of the deploy.

Throws:

RuntimeException. - All other errors are reported via the returned DeploymentProgressObjectMBean.

RuntimeException

distribute

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.

Parameters:

name - The name of the application

applicationPath - 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)

Returns:

DeploymentProgressObjectMBean Provides the state of the deploy.

Throws:

RuntimeException. - All other errors are reported via the returned DeploymentProgressObjectMBean.

RuntimeException

undeploy

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

Parameters:

name - The application name

template - The resource group template

Returns:

DeploymentProgressObjectMBean An object that provides the state of the undeploy operation.

Throws:

RuntimeExceptionm - if the operation cannot be started All other errors are reported via the returned DeploymentProgressObjectMBean.

RuntimeException

undeploy

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.

Parameters:

name - The application name

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 required

Returns:

DeploymentProgressObjectMBean An object that provides the state of the undeploy operation.

Throws:

RuntimeException - if the operation cannot be started All other errors are reported via the returned DeploymentProgressObjectMBean.

redeploy

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.

Parameters:

name - The application name

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 required

Returns:

DeploymentProgressObjectMBean An object that provides the state of the undeploy operation.

Throws:

RuntimeException - if the operation cannot be started All other errors are reported via the returned DeploymentProgressObjectMBean.

update

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.

Parameters:

name - The application name

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 required

Returns:

DeploymentProgressObjectMBean An object that provides the state of the undeploy operation.

Throws:

RuntimeException - if the operation cannot be started All other errors are reported via the returned DeploymentProgressObjectMBean.

getAppDeploymentRuntimes

AppDeploymentRuntimeMBean[] getAppDeploymentRuntimes()

Provides access to the applications that are deployed in the domain.

Returns:

The AppDeploymentRuntime MBeans for this domain.

lookupAppDeploymentRuntime

AppDeploymentRuntimeMBean lookupAppDeploymentRuntime(String appName)

Finds the application deployment runtime MBean for an application.

Parameters:

appName - The name of the application

Returns:

an application deployment runtime MBean

lookupAppDeploymentRuntime

AppDeploymentRuntimeMBean lookupAppDeploymentRuntime(String appName,
                                                     Properties deploymentOptions)

Finds the application deployment runtime MBean for an application based on the deploymentOptions parameter.

Parameters:

appName - The name of the application

deploymentOptions - Used to specify a partition.

Returns:

an application deployment runtime MBean

getLibDeploymentRuntimes

LibDeploymentRuntimeMBean[] getLibDeploymentRuntimes()

Provides access to the libraries that are deployed to the domain.

Returns:

The LibDeploymentRuntime MBeans for this domain.

lookupLibDeploymentRuntime

LibDeploymentRuntimeMBean lookupLibDeploymentRuntime(String libName)

Find the library deployment runtime MBean for a library.

Parameters:

libName - The name of the library

Returns:

a library deployment runtime MBean

getDeploymentProgressObjects

DeploymentProgressObjectMBean[] getDeploymentProgressObjects()

Provides access to the deployment operations that have been performed on this domain.

Returns:

The DeploymentProgressObject MBeans for this domain.

setMaximumDeploymentProgressObjectsCount

void setMaximumDeploymentProgressObjectsCount(int maxCount)

Sets the maximum number of progress objects allowed.

Parameters:

maxCount - The maximum number of progress objects allowed

getMaximumDeploymentProgressObjectsCount

int getMaximumDeploymentProgressObjectsCount()

The maximum number of progress objects allowed.

Returns:

The maximum number of progress objects allowed

purgeCompletedDeploymentProgressObjects

void purgeCompletedDeploymentProgressObjects()

Removes progress objects for completed operations.

removeDeploymentProgressObject

void removeDeploymentProgressObject(String appName)

Removes a progress object.

Parameters:

appName - The name of the application that the progress object is for

confirmApplicationName

String confirmApplicationName(Boolean isRedeployment,
                              String appSource,
                              String altAppDescriptor,
                              String tentativeName,
                              String tentativeApplicationId)
                              throws RuntimeException

Used by the deployment subsystem to confirm an application name.

Parameters:

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 path

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).

Returns:

An acceptable Java EE 6 application name.

Throws:

RuntimeException

confirmApplicationName

String confirmApplicationName(Boolean isRedeployment,
                              String appSource,
                              String altAppDescriptor,
                              String tentativeName,
                              String tentativeApplicationId,
                              Properties deploymentOptions)
                              throws RuntimeException

Used by the deployment subsystem to confirm an application name.

Parameters:

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 options

Returns:

An acceptable Java EE 6 application name.

Throws:

RuntimeException

Skip navigation links