|
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 |
public interface ConfigurationManagerMBean
Manages changes to the configuration of the current WebLogic Server domain. The operations in this MBean start and stop edit sessions, save, undo, and activate configuration changes.
The general process for changing the configuration of a domain is as follows:
Use this MBean's startEdit()
operation to start an
edit session.
When you start an edit session, WebLogic Server locks other users from editing the pending configuration MBean hierarchy. If two users start an edit session under the same user identity, changes from both users are collected into a single set of changes.
The operation returns the pending DomainMBean
,
which is the root of the configuration MBean hierarchy.
Navigate to an MBean and change the value of its attributes or add or remove a child MBean.
Save your changes.
Your saved changes are written to the domain's pending configuration files.
(Optional) Make additional changes or undo the changes.
Use this MBean's activate()
operation to activate
the saved changes.
When you activate, the changes are propagated to all the servers in the domain and applied to the running configuration.
Field Summary | |
---|---|
static String |
OBJECT_NAME
This is the ObjectName under which this service is registered in the MBeanServer |
Method Summary | |
---|---|
ActivationTaskMBean |
activate(long timeout)
Activates the changes that have been saved to the pending configuration files. |
void |
cancelEdit()
Cancels the current edit session, releases the edit lock, and enables other users to start an edit session. |
ActivationTaskMBean[] |
getActivationTasks()
Returns the list of all ActivationTaskMBean instances
that have been created. |
ActivationTaskMBean[] |
getActiveActivationTasks()
Contains the ActivationTaskMBeans that provide information about
activation tasks that are in progress. |
Change[] |
getChanges()
Contains Change objects for all of the unsaved changes in the current
edit session. |
Change[] |
getChangesToDestroyBean(DescriptorBean configurationMBean)
Contains Change objects for the changes required to destroy
the specified instance of a configuration bean. |
ActivationTaskMBean[] |
getCompletedActivationTasks()
Contains all ActivationTaskMBeans that are stored
in memory and that describe activation tasks that have
completed. |
long |
getCompletedActivationTasksCount()
The maximum number of ActivationTaskMBeans that
WebLogic Server keeps in memory. |
String |
getCurrentEditor()
The name of the user who started the current edit session. |
long |
getCurrentEditorExpirationTime()
The time at which the current edit session expires as determined by the timeout parameter of the startEdit
operation. |
long |
getCurrentEditorStartTime()
The time at which the current edit session started. |
FileChange[] |
getFileChanges()
Returns a FileChange object for each affected files in the current
edit session. |
Change[] |
getUnactivatedChanges()
Contains Change objects for all changes (saved or unsaved)
that have been made since
the activate operation completed successfully. |
boolean |
haveUnactivatedChanges()
Returns true if any changes (saved or unsaved) have been made since the activate operation completed successfully. |
boolean |
isCurrentEditorExclusive()
Whether the edit session is exclusive as determined by the exclusive parameter of the startEdit
operation. |
boolean |
isCurrentEditorExpired()
Whether the edit session is expired as determined by the timeout parameter of the startEdit
operation. |
boolean |
isEditor()
Returns true if the caller started the current edit session. |
void |
purgeCompletedActivationTasks()
Purges from memory all ActivationTaskMBeans that
represent completed activation tasks. |
void |
reload()
Reloads the configuration files from the pending directory updates the configuration contained in the Edit MBeanServer. |
void |
removeReferencesToBean(DescriptorBean configurationMBean)
Removes references to bean that must be removed in order to destroy the specified instance of a configuration bean. |
void |
save()
Validates unsaved changes and saves them to the pending configuration files on disk. |
void |
setCompletedActivationTasksCount(long maxCount)
Sets the maximum number of ActivationTaskMBeans
that WebLogic Server keeps in memory. |
DomainMBean |
startEdit(int waitTimeInMillis,
int timeOutInMillis)
Starts an edit session on behalf of the currently authenticated user and prevents other users from editing the configuration for the duration of the session. |
DomainMBean |
startEdit(int waitTimeInMillis,
int timeOutInMillis,
boolean exclusive)
Starts an edit session on behalf of the currently authenticated user and prevents other users from editing the configuration for the duration of the session. |
void |
stopEdit()
Stops the current edit session, releases the edit lock, and enables other users to start an edit session. |
void |
undo()
Undoes all unsaved changes. |
void |
undoUnactivatedChanges()
Undoes all of the changes (saved or unsaved) that have been made since the activate operation completed successfully. |
void |
validate()
Verifies that all unsaved changes satisfy dependencies between MBean attributes and makes other checks that cannot be made at the time that you set the value of a single attribute. |
Methods inherited from interface weblogic.management.mbeanservers.Service |
---|
getName, getParentAttribute, getParentService, getPath, getType |
Field Detail |
---|
static final String OBJECT_NAME
Method Detail |
---|
DomainMBean startEdit(int waitTimeInMillis, int timeOutInMillis) throws EditTimedOutException
Starts an edit session on behalf of the currently authenticated user and prevents other users from editing the configuration for the duration of the session. A user must call this operation before modifying the configuration of the domain.
If two users or processes start an edit session under the same user identity, changes from both users are collected into a single set of changes.
waitTimeInMillis
- Prevents other uses from starting an edit session until waitTimeInMillis expires, edits are activated, or the edit session is stopped. If the value of waitTimeInMillis is 0 and an edit session is active, this operation returns immediately. To block indefinitely, specify a value of -1.timeOutInMillis
- Specifies the number of milliseconds after which the lock on the configuration is no longer guaranteed. This time out is enforced lazily. If no other user starts an edit session after the timeout expires, the unsaved changes are left intact and may be saved. If another user starts an edit session after the timeout expires, unsaved changes are automatically reverted and the lock is given to that new user. Specify a value of -1 to indicate that you do not want the edit to time out. In this case, if you do not stop your edit session, only an administrator can stop the edit session by invokeing the cancelEdit operation.
EditTimedOutException
- thrown when the start edit request times out because the wait time has elasped and another user still has the edit session.DomainMBean startEdit(int waitTimeInMillis, int timeOutInMillis, boolean exclusive) throws EditTimedOutException
Starts an edit session on behalf of the currently authenticated user and prevents other users from editing the configuration for the duration of the session. A user must call this operation before modifying the configuration of the domain.
Prevents multiple users or processes from starting an edit session under the same user identity.
waitTimeInMillis
- Prevents other uses from starting an edit session until waitTimeInMillis expires, edits are activated, or the edit session is stopped. If the value of waitTimeInMillis is 0 and an edit session is active, this operation returns immediately. To block indefinitely, specify a value of -1.timeOutInMillis
- Specifies the number of milliseconds after which the lock on the configuration is no longer guaranteed. This time out is enforced lazily. If no other user starts an edit session after the timeout expires, the unsaved changes are left intact and may be saved. If another user starts an edit session after the timeout expires, unsaved changes are automatically reverted and the lock is given to that new user. Specify a value of -1 to indicate that you do not want the edit to time out. In this case, if you do not stop your edit session, only an administrator can stop the edit session by invokeing the cancelEdit operation.exclusive
- Specifies whether the edit session should be exclusive. An
edit session will cause a subsequent call to startEdit by the same owner to wait
until the edit session lock is released.
EditTimedOutException
- thrown when the start edit request times out because the wait time has elasped and another user still has the edit session.void stopEdit() throws NotEditorException
Stops the current edit session, releases the edit lock, and enables other users to start an edit session. Any unsaved changes are discarded.
This operation can be invoked only by the user who started the edit session.
NotEditorException
- thrown if the caller did not start the current edit session.void cancelEdit()
Cancels the current edit session, releases the edit lock, and enables other users to start an edit session. Any unsaved changes are discarded; saved changes remain pending.
This operation can be called by any user with administrator privileges, even if the user is not the one who started the edit session. Use this operation to cancel an edit session when the current editor can not be contacted to stop an edit session and release the lock. To instead discard all changes, saved and unsaved, see the undoUnactivatedChanges operation.
String getCurrentEditor()
The name of the user who started the current edit session.
boolean isEditor()
Returns true if the caller started the current edit session.
long getCurrentEditorStartTime()
The time at which the current edit session started.
long getCurrentEditorExpirationTime()
The time at which the current edit session expires as determined
by the timeout parameter of the startEdit
operation.
boolean isCurrentEditorExclusive()
Whether the edit session is exclusive as determined
by the exclusive parameter of the startEdit
operation.
boolean isCurrentEditorExpired()
Whether the edit session is expired as determined
by the timeout parameter of the startEdit
operation.
Change[] getChanges() throws NotEditorException
Contains Change
objects for all of the unsaved changes in the current
edit session. Each change to an MBean attribute is represented in its own
Change
object.
NotEditorException
- thrown if the caller did not start the current edit session.FileChange[] getFileChanges()
Returns a FileChange
object for each affected files in the current
edit session. Each FileChange
object represents a File that was either:
edited, added or removed.
void validate() throws NotEditorException, ValidationException
Verifies that all unsaved changes satisfy dependencies between MBean attributes and makes other checks that cannot be made at the time that you set the value of a single attribute.
The save
operation also validates changes, but you
can use this (validate
) operation to check that
changes are valid before saving them.
NotEditorException
- thrown if the caller did not start the current edit session.
ValidationException
- thrown if an validation error occurs while validating changes.void reload() throws NotEditorException, ValidationException
Reloads the configuration files from the pending directory updates the configuration contained in the Edit MBeanServer.
NotEditorException
- thrown if the caller did not start the current edit session.
ValidationException
- thrown if an validation error occurs while reloading files.void save() throws NotEditorException, ValidationException
Validates unsaved changes and saves them to the pending configuration files on disk.
NotEditorException
- thrown if the caller did not start the current edit session.
ValidationException
- thrown if an validation error occurs while saving changes.void undo() throws NotEditorException
Undoes all unsaved changes. This reverts the hierarchy of pending configuration MBeans to the last saved state of the pending configuration files, discarding in-memory changes.
NotEditorException
- thrown if the caller did not start the current edit session.boolean haveUnactivatedChanges()
Returns true if any changes (saved or unsaved) have been made
since the activate
operation completed successfully.
This includes any changes that have been saved but not activated in
the current and previous edit sessions.
Change[] getUnactivatedChanges() throws NotEditorException
Contains Change
objects for all changes (saved or unsaved)
that have been made since
the activate
operation completed successfully. This
includes any changes that have been saved but not activated in the
current and previous edit sessions.
Each change to an MBean attribute is
described in its own Change
object.
NotEditorException
- thrown if the caller did not start the current edit session.void undoUnactivatedChanges() throws NotEditorException
Undoes all of the changes (saved or unsaved) that have been made
since the activate
operation completed successfully.
This includes any changes that have been saved but not activated in
the current and previous edit sessions.
This reverts the hierarchy of pending configuration MBeans to the last successful activate state of the domain, discarding any changes made but not activated.
NotEditorException
- thrown if the caller did not start the current edit session.ActivationTaskMBean activate(long timeout) throws NotEditorException
Activates the changes that have been saved to the pending configuration files.
To activate changes, WebLogic Server copies the pending configuration files to a pending directory within each server instance's root directory. Each server instance determines whether it can consume the changes. If all servers can, then the pending configuration files become the active configuration files and the in-memory hierarchy of active configuration MBeans is updated for each server.
If any server is unable to consume the change, then the activation fails for all servers. All saved changes remain in the pending configuration files and can be activated later.
timeout
- long that contains the time (milliseconds) for the operation to complete. If the elasped time exceeds that value, then the activation of the configuration changes will be canceled. If -1, then the activation will not timeout. If a non-zero timeout is specified, then the activate will wait until the activate operation has completed or until the timeout period has elasped. If a zero timeout is specified, then the activate will return immediately and the caller can wait for completion using the ActivationTaskMBean.
NotEditorException
- thrown if the caller did not start the current edit session.ActivationTaskMBean[] getCompletedActivationTasks()
Contains all ActivationTaskMBeans
that are stored
in memory and that describe activation tasks that have
completed.
long getCompletedActivationTasksCount()
The maximum number of ActivationTaskMBeans
that
WebLogic Server keeps in memory.
Each ActivationTaskMBean
contains one
Change
object for each change that was activated. The
MBean and its Change
objects describe which user
activated the changes, when the changes were activated, and which
MBean attributes were modified.
WebLogic Server does not save this data to disk, and therefore it is not available across sessions of the Administration Server.
Because a large collection of ActivationTaskMBean
s
could potentially use a significant amount of memory, the default
number is 10.
void setCompletedActivationTasksCount(long maxCount)
Sets the maximum number of ActivationTaskMBeans
that WebLogic Server keeps in memory.
maxCount
- - the maximum number of completed ActivationTaskMBeans that are kept in memory.ActivationTaskMBean[] getActiveActivationTasks()
Contains the ActivationTaskMBeans
that provide information about
activation tasks that are in progress.
ActivationTaskMBean
void purgeCompletedActivationTasks()
Purges from memory all ActivationTaskMBeans
that
represent completed activation tasks.
ActivationTaskMBean[] getActivationTasks()
Returns the list of all ActivationTaskMBean
instances
that have been created.
Change[] getChangesToDestroyBean(DescriptorBean configurationMBean)
Contains Change
objects for the changes required to destroy
the specified instance of a configuration bean. Each change to an MBean attribute
is represented in its own Change
object.
configurationMBean
-
void removeReferencesToBean(DescriptorBean configurationMBean) throws NotEditorException
Removes references to bean that must be removed in order to destroy the specified instance of a configuration bean.
configurationMBean
-
NotEditorException
- thrown if the caller did not start the current edit session.
|
Copyright 1996, 2014, 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 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 |