DeploymentProgressObjectMBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.runtime
Interface DeploymentProgressObjectMBean

All Superinterfaces:: DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface DeploymentProgressObjectMBean
extends RuntimeMBean
extends RuntimeMBean

This MBean is the user API for monitoring deployment operations and exists only on an Administration Server. Currently only start and stop operations initiated by AppDeploymentRuntimeMBean are supported.

Access limited to the following security roles:: Deployer

Field Summary
`static int`	`OPERATION_DEPLOY`
`static int`	`OPERATION_REDEPLOY`
`static int`	`OPERATION_START`
`static int`	`OPERATION_STOP`
`static int`	`OPERATION_UNDEPLOY`
`static int`	`OPERATION_UNIMPLEMENTED`
`static String`	`STATE_COMPLETED`
`static String`	`STATE_DEFERRED`
`static String`	`STATE_FAILED`
`static String`	`STATE_INITIALIZED`
`static String`	`STATE_RUNNING`

Method Summary
`void`	`addMessages(List msgs)` add messages for current deployment operation.
`void`	`cancel()` Attempt to cancel the deployment operation.
`AppDeploymentMBean`	`getAppDeploymentMBean()` The AppDeploymentMBean for the current deployment operation.
`String`	`getApplicationName()` The name of the application for the current deployment operation.
`long`	`getBeginTime()` The time that the current deployment operation began.
`long`	`getEndTime()` The time that the current deployment operation ended.
`RuntimeException[]`	`getExceptions(String target)` If the current deployment operation has failed, this method may return zero or more exception(s) which represent the errors for this target.
`String[]`	`getFailedTargets()` The targets on which the current deployment operation failed.
`String`	`getId()` The unique ID for the current deployment operation.
`LibraryMBean`	`getLibraryMBean()` Return the LibraryMBean for the current deployment operation.
`String[]`	`getMessages()` Provides an ordered array of status messages generated for the current deployment operation.
`int`	`getOperationType()` The deployment operation type for the current deployment operation.
`RuntimeException[]`	`getRootExceptions()` If the current deployment operation has failed, this method may return zero or more exception(s) which represent the root cause of the failure.
`String`	`getState()` The state of the current deployment operation.
`String[]`	`getTargets()` The targets specified for the current deployment operation.

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

OPERATION_UNIMPLEMENTED

static final int OPERATION_UNIMPLEMENTED

See Also:: Constant Field Values

OPERATION_START

static final int OPERATION_START

See Also:: Constant Field Values

OPERATION_STOP

static final int OPERATION_STOP

See Also:: Constant Field Values

OPERATION_DEPLOY

static final int OPERATION_DEPLOY

See Also:: Constant Field Values

OPERATION_REDEPLOY

static final int OPERATION_REDEPLOY

See Also:: Constant Field Values

OPERATION_UNDEPLOY

static final int OPERATION_UNDEPLOY

See Also:: Constant Field Values

STATE_INITIALIZED

static final String STATE_INITIALIZED

See Also:: Constant Field Values

STATE_RUNNING

static final String STATE_RUNNING

See Also:: Constant Field Values

STATE_COMPLETED

static final String STATE_COMPLETED

See Also:: Constant Field Values

STATE_FAILED

static final String STATE_FAILED

See Also:: Constant Field Values

STATE_DEFERRED

static final String STATE_DEFERRED

See Also:: Constant Field Values

Method Detail

getId

String getId()

The unique ID for the current deployment operation.

Returns:: unique id for the deployment operation.

getOperationType

int getOperationType()

The deployment operation type for the current deployment operation. Possible values are 1 (start) and 2 (stop).

Returns:: the current deployment operation type

getApplicationName

String getApplicationName()

The name of the application for the current deployment operation.

Returns:: the application name for the current deployment operation

getAppDeploymentMBean

AppDeploymentMBean getAppDeploymentMBean()

The AppDeploymentMBean for the current deployment operation.

Returns:: the AppDeploymentMBean for the current deployment operation

getLibraryMBean

LibraryMBean getLibraryMBean()

Return the LibraryMBean for the current deployment operation.

Returns:: the LibraryMBean for the current deployment operation

getState

String getState()

The state of the current deployment operation. Possible values are STATE_INITIALIZED, STATE_RUNNING, STATE_COMPLETED, STATE_FAILED and STATE_DEFERRED.

Returns:: the state of the current deployment operation.

getTargets

String[] getTargets()

The targets specified for the current deployment operation.

Returns:: the targets specified for the current deployment operation.

getFailedTargets

String[] getFailedTargets()

The targets on which the current deployment operation failed.

Returns:: the targets on which the current deployment operation failed.

addMessages

void addMessages(List msgs)

add messages for current deployment operation.

getMessages

String[] getMessages()

Provides an ordered array of status messages generated for the current deployment operation.

Returns:: the status messages for the current deployment operation

getExceptions

RuntimeException[] getExceptions(String target)

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the errors for this target. The array will not contain WLS exception classes; instead they will be new RuntimeExceptions containing the stack traces and messages from the original WLS Exceptions.

Parameters:: target - the target where exceptions might have occurred.
Returns:: the exceptions for a target for the current deployment operation

getRootExceptions

RuntimeException[] getRootExceptions()

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the root cause of the failure. The array will not contain WLS exception classes; instead they will be new Exceptions containing the stack traces and messages from the original WLS Exceptions.

Returns:: the root exceptions for the current deployment operation.

cancel

void cancel()
            throws RuntimeException

Attempt to cancel the deployment operation. Any actions which have yet to start will be inhibited. Any completed actions will remain in place.

Throws:: RuntimeException

getBeginTime

long getBeginTime()

The time that the current deployment operation began. The value is in milliseconds consistent with the system time.

Returns:: the operation begin time

getEndTime

long getEndTime()

The time that the current deployment operation ended. The value is in milliseconds consistent with the system time. If the operation has not ended, the value will be zero.

Returns:: the current deployment operation end time