weblogic.management.runtime
Interface AppDeploymentRuntimeMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface AppDeploymentRuntimeMBean
extends RuntimeMBean

This MBean provides deployment operations for an application. Currently only start and stop are supported. 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.

Access limited to the following security roles:

Deployer, Operator

getApplicationName

String getApplicationName()

The application's name.

Returns:

the application's name.

getApplicationVersion

String getApplicationVersion()

The application's version identifier.

Returns:

The application's version identifier.

start

DeploymentProgressObjectMBean start()
                                    throws RuntimeException

Start the application using the default options and configured targets. This is a synchronous operation that returns when the start operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

Returns:

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

Throws:

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

RuntimeException

start

DeploymentProgressObjectMBean start(String[] targets,
                                    Properties deploymentOptions)
                                    throws RuntimeException

Start the application 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.

Parameters:

targets - The targets on which to start 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 started 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, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Returns:

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

Throws:

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

stop

DeploymentProgressObjectMBean stop()
                                   throws RuntimeException

Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

Returns:

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

Throws:

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

RuntimeException

stop

DeploymentProgressObjectMBean stop(String[] targets,
                                   Properties deploymentOptions)
                                   throws RuntimeException

Stop the application 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.

Parameters:

targets - The targets on which to stop 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 stoped 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, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

Returns:

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

Throws:

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

undeploy

DeploymentProgressObjectMBean undeploy()
                                       throws RuntimeException

Undeploy the application using the default options and configured targets. 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

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[] targets,
                                       Properties deploymentOptions)
                                       throws RuntimeException

Undeploy the application 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.

Parameters:

targets - The targets on which to undeploy 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 undeployed 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, gracefulIgnoreSessions boolean false, gracefulProductionToAdmin boolean false, retireGracefully boolean true, retireTimeout seconds -1 (no timeout), adminMode boolean false, timeout milliseconds 0 (no timeout)

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()
                                       throws RuntimeException

Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout

Returns:

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

Throws:

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

RuntimeException

redeploy

DeploymentProgressObjectMBean redeploy(String[] targets,
                                       String plan,
                                       Properties deploymentOptions)
                                       throws RuntimeException

Redeploy the application 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.

Parameters:

targets - The targets on which to redeploy 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 An object that provides the state of the redeploy operation.

Throws:

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

getModules

String[] getModules()

The list of modules for the application. These modules can be used in module level targeting.

Returns:

String[] An array of modules names for the application.

getState

String getState(String target)

The state of the application for a target. Notifications will be generated for this attribute on state changes. Valid states are those supported by the AppRuntimeStateRuntimeMBean 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 a Map where the keys are target names and the values are the application state for that target.

Parameters:

target - the target for the application state

Returns:

current state of the application for the target specified

update

DeploymentProgressObjectMBean update(String[] targets,
                                     String plan,
                                     Properties deploymentOptions)
                                     throws RuntimeException

Allows for updating an application configuration using an changed deployment plan.

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 AppDeploymentRuntimeMBean.redeploy() to apply resource binding changes to a production application.

This method targets only root modules. Module level targeting is not supported.

Parameters:

targets - represent the targets on which to update the application.

plan - The deployment plan containing the new deployment configuration information.

deploymentOptions - Allows for overriding the deployment options. May be null.

Returns:

DeploymentProgressObjectMBean An object that tracks and reports the status of the deployment process.

Throws:

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

RuntimeException

See Also:

AppDeploymentRuntimeMBean.redeploy()