weblogic.management.mbeanservers.edit
Interface ActivationTaskMBean

All Superinterfaces:

Service

public interface ActivationTaskMBean
extends Service

Provides information about an activation task, which is initiated by invoking the ConfigurationManagerMBean activate operation.

To describe the changes that are being activated in the domain, this MBean contains one Configuration object for each change that was saved to the domain's pending configuration files.

This MBean also contains attributes that describe the status of the activation operation as it attempts to distribute changes to all servers in the domain.

See Also:

ConfigurationManagerMBean.activate(long)

Access limited to the following security roles:

Deployer

STATE_NEW

static final int STATE_NEW

Indicates that the task has been created but distribution has not started.

See Also:

Constant Field Values

STATE_DISTRIBUTING

static final int STATE_DISTRIBUTING

Indicates that the changes have been validated and are being distributed to the various servers.

See Also:

Constant Field Values

STATE_DISTRIBUTED

static final int STATE_DISTRIBUTED

Indicates that the changes have been distributed to all servers.

See Also:

Constant Field Values

STATE_PENDING

static final int STATE_PENDING

Indicates that the configuration changes require that the server be restarted for the changes to become available.

See Also:

Constant Field Values

STATE_COMMITTED

static final int STATE_COMMITTED

Indicates that the changes have been distributed to all servers and made permanent.

See Also:

Constant Field Values

STATE_FAILED

static final int STATE_FAILED

Indicates that the changes failed in the distribution phase.

See Also:

Constant Field Values

STATE_CANCELING

static final int STATE_CANCELING

Indicates that the changes are canceling in the distribution phase.

See Also:

Constant Field Values

STATE_COMMIT_FAILING

static final int STATE_COMMIT_FAILING

Indicates that the changes are failing in the commit phase.

See Also:

Constant Field Values

STATE_DEFERRED

static final int STATE_DEFERRED

Indicates that the changes are deferred until the server is available.

See Also:

Constant Field Values

getState

int getState()

The state of the activation task, which is initiated by invoking the ConfigurationManagerMBean activate operation.

States are:

• STATE_NEW - Indicates that the task has been created but distribution has not started.
• STATE_DISTRIBUTING - Indicates that the changes have been validated and are being distributed to the various servers.
• STATE_DISTRIBUTED - Indicates that the changes have been distributed to all servers.
• STATE_PENDING - Indicates that the configuration changes require that the server be restarted for the changes to become available.
• STATE_COMMITTED - Indicates that the changes have been distributed to all servers and made permanent.
• STATE_FAILED - Indicates that the changes failed in the distribution phase.
• STATE_CANCELING - Indicates that the changes are canceling in the distribution phase.
• STATE_COMMIT_FAILING - Indicates that the changes are failing in the commit phase.

Returns:

int the state of the activate.

getStatusByServer

ServerStatus[] getStatusByServer()

The state of the activation task on each server in the domain.

If any server fails to activate the changes, the activation task is rolled back for all servers in the domain.

Returns:

ServerStatus[] an array containing the status for each server.

getError

Exception getError()

Returns the exception that describes why the activation has failed.

To see how each server responded to the activation request, get the value of this MBean's StatusByServer attribute.

Returns:

Exception - a failure exception for the activate method.

getStartTime

long getStartTime()

The time at which the ConfigurationManagerMBean activate operation was invoked.

Returns:

long the time the activate started.

getCompletionTime

long getCompletionTime()

The time at which the activation task completes, either by successfully activating changes on all servers, rolling back all changes (because a server was unable to consume the changes), or by timing out.

Returns:

long the time the activate completed or zero if still active.

getUser

String getUser()

The name of the user who invoked the ConfigurationManagerMBean activate operation.

Returns:

String containing the user that started the activate task.

getChanges

Change[] getChanges()

Contains the Change objects that describe the changes that are being activated.

Each Change object describes a change to a single MBean attribute.

Returns:

Change[] containing the changes.

getDetails

String getDetails()

Contains all available information about the current activation task in a single String object.

waitForTaskCompletion

void waitForTaskCompletion()

Allows the caller to wait until the activation task completes (either by successfully distributing changes or by rolling back the task) or times out.

waitForTaskCompletion

void waitForTaskCompletion(long timeout)

Allows the caller to wait until any of the following occurs:

• The activation task completes (either by successfully distributing changes or by rolling back the task)
• The activation task times out
• The number of specified milliseconds elapses

Parameters:

timeout - long that specifies the time (milliseconds) to wait for the activate deployment request to complete.