Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02

weblogic.management.runtime
Interface DeploymentTaskRuntimeMBean


Deprecated. 9.0.0.0 Replaced by WebLogicDeploymentManager

public interface DeploymentTaskRuntimeMBean

Base interface for deployment task MBeans. These MBeans track the progress of a deployment task.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/products/weblogic/index.html.

Access limited to the following security roles:
Deployer

Field Summary
static int APP_NOTIFICATION_LEVEL
          Deprecated. Indicates only application level deployment notifications are propogated to the admin server.
static int DEFAULT_NOTIFICATION_LEVEL
          Deprecated. The default notification level for deployments.
static int DEPLOY_TASK_ACTIVATE
          Deprecated. Activation task.
static int DEPLOY_TASK_DEACTIVATE
          Deprecated. Deactivate application.
static int DEPLOY_TASK_DEPLOY
          Deprecated.  
static int DEPLOY_TASK_DISTRIBUTE
          Deprecated. Distributes application files to the target's staging area
static int DEPLOY_TASK_PREPARE
          Deprecated. Prepare task.
static int DEPLOY_TASK_REDEPLOY
          Deprecated. Redeploy unprepares, distribute and start an application on a target
static int DEPLOY_TASK_REMOVE
          Deprecated. Remove application from target.
static int DEPLOY_TASK_START
          Deprecated. Starts an already distributed application.
static int DEPLOY_TASK_STOP
          Deprecated. Stop unprepares a deployed application on a target
static int DEPLOY_TASK_UNDEPLOY
          Deprecated.  
static int DEPLOY_TASK_UNPREPARE
          Deprecated. Deactivate and unload classes for application from target.
static int DEPLOY_TASK_UPDATE
          Deprecated. Updates a deployed application on a target.
static int MODULE_NOTIFICATION_LEVEL
          Deprecated. Indicates application and module level deployment notifications are propogated to the admin server.
static int NONE_NOTIFICATION_LEVEL
          Deprecated. Indicates no deployment notifications are propogated to the admin server.
static int STATE_COMPLETED
          Deprecated. Indicates the task completed successfully
static int STATE_DEFERRED
          Deprecated.  
static int STATE_FAILED
          Deprecated. Indicates the task failed
static int STATE_INITIALIZED
          Deprecated. Indicates the task has been created but not started.
static int STATE_RUNNING
          Deprecated. Indicate the task is in progress
 
Method Summary
 void cancel()
          Deprecated. Attempts to cancel the task.
 TargetStatus findTarget(String target)
          Deprecated. Lists the status for a specific target of this deployment.
 String getApplicationName()
          Deprecated. The name for the application that was specified to DeployerRuntime.activate
 DeploymentData getDeploymentData()
          Deprecated. Provides the data associated with this task
 BasicDeploymentMBean getDeploymentMBean()
          Deprecated.  
 ApplicationMBean getDeploymentObject()
          Deprecated. Lists the Application MBean involved in this task.
 String getId()
          Deprecated. Provides a reference id assigned to a task.
 int getNotificationLevel()
          Deprecated. Provides the notification level applied to this task.
 String getSource()
          Deprecated. Provides the name of the source file that was specified to DeployerRuntime.activate.
 int getState()
          Deprecated. Provides notice of the overall state of this task.
 TargetStatus[] getTargets()
          Deprecated. Provides target based deployment status information for this deployment.
 int getTask()
          Deprecated. Indicates a specific task associated with this MBean
 List getTaskMessages()
          Deprecated. Provides an ordered list of messages generated for the task.
 boolean isInUse()
          Deprecated. Indicates whether the MBean is free for deletion or timeout.
 boolean isNewSource()
          Deprecated. Indicates whether a new source for the application was specified in an deployment request.
 void setNotificationLevel(int level)
          Deprecated. Establishes a notification level for this task.
 void start()
          Deprecated. Initiates the request.
 

Field Detail

DEPLOY_TASK_ACTIVATE

static final int DEPLOY_TASK_ACTIVATE
Deprecated. 
Activation task. Deliver staged application to containers. After successful activation, the modules in the application are in an active state. An activate may be requested from any state: none, unprepared, prepared, active.

See Also:
Constant Field Values

DEPLOY_TASK_PREPARE

static final int DEPLOY_TASK_PREPARE
Deprecated. 
Prepare task. Stage application to servers and configured for containers. After successful prepare, the modules in the application are in a prepared state. A prepare may be requested from the following states: none, unprepared or prepared.

See Also:
Constant Field Values

DEPLOY_TASK_DEACTIVATE

static final int DEPLOY_TASK_DEACTIVATE
Deprecated. 
Deactivate application. Suspend application from containers. A deactivate may be requested from the following states: active

See Also:
Constant Field Values

DEPLOY_TASK_REMOVE

static final int DEPLOY_TASK_REMOVE
Deprecated. 
Remove application from target. Deactivates if necessary. Deletes staged files. A remove may be requested from the following states: unprepared, prepared, and active

See Also:
Constant Field Values

DEPLOY_TASK_UNPREPARE

static final int DEPLOY_TASK_UNPREPARE
Deprecated. 
Deactivate and unload classes for application from target. After successful unprepare, the modules in the application are in a staged(unprepared) state. An unprepare may be requested from the following states: prepared, and active

See Also:
Constant Field Values

DEPLOY_TASK_DISTRIBUTE

static final int DEPLOY_TASK_DISTRIBUTE
Deprecated. 
Distributes application files to the target's staging area

See Also:
Constant Field Values

DEPLOY_TASK_START

static final int DEPLOY_TASK_START
Deprecated. 
Starts an already distributed application. Prepares and activates an already distributed application on a target

See Also:
Constant Field Values

DEPLOY_TASK_STOP

static final int DEPLOY_TASK_STOP
Deprecated. 
Stop unprepares a deployed application on a target

See Also:
Constant Field Values

DEPLOY_TASK_REDEPLOY

static final int DEPLOY_TASK_REDEPLOY
Deprecated. 
Redeploy unprepares, distribute and start an application on a target

See Also:
Constant Field Values

DEPLOY_TASK_UPDATE

static final int DEPLOY_TASK_UPDATE
Deprecated. 
Updates a deployed application on a target.

See Also:
Constant Field Values

DEPLOY_TASK_DEPLOY

static final int DEPLOY_TASK_DEPLOY
Deprecated. 
See Also:
Constant Field Values

DEPLOY_TASK_UNDEPLOY

static final int DEPLOY_TASK_UNDEPLOY
Deprecated. 
See Also:
Constant Field Values

NONE_NOTIFICATION_LEVEL

static final int NONE_NOTIFICATION_LEVEL
Deprecated. 
Indicates no deployment notifications are propogated to the admin server.

See Also:
DeploymentTaskRuntimeMBean.setNotificationLevel(int), Constant Field Values

APP_NOTIFICATION_LEVEL

static final int APP_NOTIFICATION_LEVEL
Deprecated. 
Indicates only application level deployment notifications are propogated to the admin server. This is the default notification level.

See Also:
DeploymentTaskRuntimeMBean.setNotificationLevel(int), Constant Field Values

MODULE_NOTIFICATION_LEVEL

static final int MODULE_NOTIFICATION_LEVEL
Deprecated. 
Indicates application and module level deployment notifications are propogated to the admin server.

See Also:
DeploymentTaskRuntimeMBean.setNotificationLevel(int), Constant Field Values

DEFAULT_NOTIFICATION_LEVEL

static final int DEFAULT_NOTIFICATION_LEVEL
Deprecated. 
The default notification level for deployments.

See Also:
DeploymentTaskRuntimeMBean.setNotificationLevel(int), Constant Field Values

STATE_INITIALIZED

static final int STATE_INITIALIZED
Deprecated. 
Indicates the task has been created but not started.

See Also:
Constant Field Values

STATE_RUNNING

static final int STATE_RUNNING
Deprecated. 
Indicate the task is in progress

See Also:
Constant Field Values

STATE_COMPLETED

static final int STATE_COMPLETED
Deprecated. 
Indicates the task completed successfully

See Also:
Constant Field Values

STATE_FAILED

static final int STATE_FAILED
Deprecated. 
Indicates the task failed

See Also:
Constant Field Values

STATE_DEFERRED

static final int STATE_DEFERRED
Deprecated. 
Indicates the task is deferred

See Also:
Constant Field Values
Method Detail

getTask

int getTask()
Deprecated. 

Indicates a specific task associated with this MBean

Returns:
value of task. e.g. DEPLOY_TASK_ACTIVATE

getTargets

TargetStatus[] getTargets()
Deprecated. 

Provides target based deployment status information for this deployment. For distributed deployment, there is one TargetStatus for each target

Returns:
The targets value

findTarget

TargetStatus findTarget(String target)
Deprecated. 

Lists the status for a specific target of this deployment.

Parameters:
target - is the name of a target (server or cluster name)
Returns:

getDeploymentObject

ApplicationMBean getDeploymentObject()
Deprecated. 

Lists the Application MBean involved in this task. This returns the Admin MBean, the one based on config.xml, that applies to all servers this application is associated with.

Returns:
The deploymentObject value

getDeploymentData

DeploymentData getDeploymentData()
Deprecated. 

Provides the data associated with this task

Returns:
The deploymentData value

getId

String getId()
Deprecated. 

Provides a reference id assigned to a task.

Returns:
The id value

cancel

void cancel()
            throws Exception
Deprecated. 

Attempts to cancel the task. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.

Throws:
Exception

start

void start()
           throws ManagementException
Deprecated. 

Initiates the request. When invoking DeployerRuntimeMBean.activate(String, String, String, DeploymentData, String, boolean), DeployerRuntimeMBean.deactivate(String, DeploymentData, String, boolean), DeployerRuntimeMBean.unprepare(String, DeploymentData, String, boolean), or DeployerRuntimeMBean.remove(String, DeploymentData, String, boolean) with the startTask option set to false, this method is used to initiate the task. throws ManagementException if task is already started or any failures occur during task processing.

Throws:
ManagementException
Access limited to the following security roles:
Operator

isNewSource

boolean isNewSource()
Deprecated. 
Indicates whether a new source for the application was specified in an deployment request.


isInUse

boolean isInUse()
Deprecated. 

Indicates whether the MBean is free for deletion or timeout.

Returns:
The inUse value

getSource

String getSource()
Deprecated. 

Provides the name of the source file that was specified to DeployerRuntime.activate.

Returns:
The source value

getApplicationName

String getApplicationName()
Deprecated. 

The name for the application that was specified to DeployerRuntime.activate

Returns:
The applicationName value

getState

int getState()
Deprecated. 

Provides notice of the overall state of this task.

Returns:
The state value

getNotificationLevel

int getNotificationLevel()
Deprecated. 

Provides the notification level applied to this task.

Returns:
The notificationLevel value

setNotificationLevel

void setNotificationLevel(int level)
Deprecated. 

Establishes a notification level for this task. Deployment notifications are always sent to the local application MBean associated with this task, and are logged in the managed server log. The NotificationLevel attribute affects whether the notifications are also sent to the admin server. The valid levels are:

none: no deployment notifications are sent to the admin server

application: only application level notifications are sent to the admin server

module: application and module level notifications are sent to the admin server

Parameters:
level - The new notificationLevel value
See Also:
DeploymentNotification, DeploymentTaskRuntimeMBean.NONE_NOTIFICATION_LEVEL, DeploymentTaskRuntimeMBean.APP_NOTIFICATION_LEVEL, DeploymentTaskRuntimeMBean.MODULE_NOTIFICATION_LEVEL
Access limited to the following security roles:
Operator

getTaskMessages

List getTaskMessages()
Deprecated. 

Provides an ordered list of messages generated for the task. Each member in the list is a String object.


getDeploymentMBean

BasicDeploymentMBean getDeploymentMBean()
Deprecated. 
Returns:
Since:
9.0.0.0

Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111/wls.htm
Copyright 1996, 2009, 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
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02