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.
ConfigurationManagerMBean.activate(long)
Modifier and Type | Field | Description |
---|---|---|
static int |
STATE_CANCELING |
Indicates that the changes are canceling in the distribution phase.
|
static int |
STATE_COMMIT_FAILING |
Indicates that the changes are failing in the commit phase.
|
static int |
STATE_COMMITTED |
Indicates that the changes have been distributed to all servers and made permanent.
|
static int |
STATE_DEFERRED |
Indicates that the changes are deferred until the server is available.
|
static int |
STATE_DISTRIBUTED |
Indicates that the changes have been distributed to all servers.
|
static int |
STATE_DISTRIBUTING |
Indicates that the changes have been validated and are being distributed to
the various servers.
|
static int |
STATE_FAILED |
Indicates that the changes failed in the distribution phase.
|
static int |
STATE_NEW |
Indicates that the task has been created but distribution has not started.
|
static int |
STATE_PENDING |
Indicates that the configuration changes require that the server be restarted
for the changes to become available.
|
Modifier and Type | Method | Description |
---|---|---|
Change[] |
getChanges() |
Contains the
Change objects that describe the changes that are
being activated. |
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.
|
java.lang.String |
getDetails() |
Contains all available information about the current activation task in
a single
String object. |
java.lang.String |
getEditSessionName() |
Returns name of edit session which is activated.
|
java.lang.Exception |
getError() |
Returns the exception that describes why the activation has failed.
|
java.lang.String |
getPartitionName() |
Returns partition name of edit session which is activated.
|
long |
getStartTime() |
The time at which the
ConfigurationManagerMBean activate
operation was invoked. |
int |
getState() |
The state of the activation task, which is initiated by invoking
the
ConfigurationManagerMBean activate operation. |
ServerStatus[] |
getStatusByServer() |
The state of the activation task on each server in the domain.
|
java.lang.String[] |
getSystemComponentsToRestart() |
Get list of names of system component, which need to be restarted.
|
java.lang.String |
getUser() |
The name of the user who invoked the
ConfigurationManagerMBean activate
operation. |
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.
|
void |
waitForTaskCompletion(long timeout) |
Allows the caller to wait until any of the following occurs:
|
getName, getParentAttribute, getParentService, getPath, getType
static final int STATE_NEW
static final int STATE_DISTRIBUTING
static final int STATE_DISTRIBUTED
static final int STATE_PENDING
static final int STATE_COMMITTED
static final int STATE_FAILED
static final int STATE_CANCELING
static final int STATE_COMMIT_FAILING
static final int STATE_DEFERRED
int getState()
The state of the activation task, which is initiated by invoking
the ConfigurationManagerMBean activate
operation.
States are:
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.
java.lang.String[] getSystemComponentsToRestart()
java.lang.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.
long getStartTime()
The time at which the ConfigurationManagerMBean activate
operation was invoked.
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.
java.lang.String getUser()
The name of the user who invoked the ConfigurationManagerMBean activate
operation.
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.
java.lang.String getDetails()
Contains all available information about the current activation task in
a single String
object.
java.lang.String getEditSessionName()
Returns name of edit session which is activated.
java.lang.String getPartitionName()
Returns partition name of edit session which is activated.
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.
void waitForTaskCompletion(long timeout)
Allows the caller to wait until any of the following occurs:
timeout
- long that specifies the time (milliseconds) to wait for the
activate deployment request to complete.