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.
| Since | 9.0.0.0 | ||
| Security roles | The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
|
||
| Fully Qualified Interface Name | If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.mbeanservers.edit.ConfigurationManagerMBean
|
||
| Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
| Access Points |
You can access this MBean from the following MBean attributes:
|
||
| Access Points Inherited from Service |
Because this MBean extends or implements Service, you can also access this MBean by retrieving Services. The following attributes contain Services and its subtypes:
|
This section describes attributes that provide access to other MBeans.
Returns the list of all ActivationTaskMBean
instances that have been created.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Privileges | Read only |
| Type | ActivationTaskMBean[] |
| Relationship type: | Containment. |
Contains the ActivationTaskMBeans that provide
information about activation tasks that are in progress.
For more information, see:
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Privileges | Read only |
| Type | ActivationTaskMBean[] |
| Relationship type: | Containment. |
Contains all ActivationTaskMBeans that are stored
in memory and that describe activation tasks that have
completed.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Privileges | Read only |
| Type | ActivationTaskMBean[] |
| Relationship type: | Containment. |
This section describes the following attributes:
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.
| Privileges | Read only |
| Type | interface weblogic.management.mbeanservers.edit.Change[] |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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
MBeans could potentially use a significant amount of memory, the
default number is 10.
| Privileges | Read/Write |
| Type | long |
The name of the user who started the current edit session.
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Whether the edit session is exclusive as determined by the
exclusive parameter of the startEdit operation.
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The time at which the current edit session expires as determined
by the timeout parameter of the startEdit
operation.
| Privileges | Read only |
| Type | long |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Whether the edit session is expired as determined by the timeout
parameter of the startEdit operation.
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The time at which the current edit session started.
| Privileges | Read only |
| Type | long |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns true if the caller started the current edit session.
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns the name of the edit session.
| Available Since | Release 12.2.1.0.0 |
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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.
| Privileges | Read only |
| Type | interface weblogic.management.mbeanservers.edit.FileChange[] |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns {@code true} only if another session might have been activated since the last resolve. It means that there could be some difference which must be merged before activation.
Merge does not necessary mean that there are some conflicts.
| Available Since | Release 12.2.1.0.0 |
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
A unique key that WebLogic Server generates to identify the current instance of this MBean type.
For a singleton, such as DomainRuntimeServiceMBean,
this key is often just the bean's short class name.
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The name of the attribute of the parent that refers to this bean
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The MBean that created the current MBean instance.
In the data model for WebLogic Server MBeans, an MBean that creates another MBean is called a parent. MBeans at the top of the hierarchy have no parents.
| Privileges | Read only |
| Type | weblogic.management.provider.Service |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns the path to the bean relative to the reoot of the heirarchy of services
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Method {@code startEdit()} contains optional {@code resolve(stopOnConflict=true)} operation in case when this session is suspicions that it is stale. Method provides result information. Result can be {@code null} if resolve operation was not included.
| Available Since | Release 12.2.1.0.0 |
| Privileges | Read only |
| Type | weblogic.management.mbeanservers.edit.AutoResolveResult |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The MBean type for this instance. This is useful for MBean types
that support multiple intances, such as
ActivationTaskMBean.
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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.
| Privileges | Read only |
| Type | interface weblogic.management.mbeanservers.edit.Change[] |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
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.
| Operation Name | "activate" |
| Parameters | Object [] { timeout }
where:
|
| Signature | String [] {
"java.lang.Long" } |
| Returns | ActivationTaskMBean |
| Exceptions |
|
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.
| Operation Name | "cancelEdit" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
Force the pending changes to all system components in the next activate
| Operation Name | "enableOverwriteComponentChanges" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
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.
| Operation Name | "getChangesToDestroyBean" |
| Parameters | Object [] { configurationMBean }
where:
|
| Signature | String [] {
"weblogic.descriptor.DescriptorBean" } |
| Returns |
class |
Reports the effective values for specified properties on the indicated config bean, where effective values include any overrides that apply.
| Operation Name | "getEffectiveValues" |
| Parameters | Object [] { configBean, propertyNames }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ConfigurationMBean",
"[Ljava.lang.String;" } |
| Returns |
class |
| Exceptions |
|
Reports the effective values for specified properties on the last of the beans specified, navigated to by following the navigation attribute names starting at the config bean.
| Operation Name | "getEffectiveValues" |
| Parameters | Object [] { configBean, navigationAttributeNames, beans, propertyNames }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ConfigurationMBean",
"[Ljava.lang.String;",
"[Lweblogic.descriptor.SettableBean;",
"[Ljava.lang.String;" } |
| Returns |
class |
| Exceptions |
|
Returns the contents of the specified file on the admin server.
| Operation Name | "getFileContents" |
| Parameters | Object [] { componentType, relativePath }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns |
class |
| Exceptions |
|
Describes assignment of value to selected properties of a config bean
| Operation Name | "getPropertyValues" |
| Parameters | Object [] { bean, propertyNames }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ConfigurationMBean",
"[Ljava.lang.String;" } |
| Returns |
class |
| Exceptions |
|
Describes assignment of value to selected properties of a bean within a ConfigurationMBean's object graph.
The specified beans form a path from the ConfigurationMBean to some other object of interest, following each method specified in the getMethodNames array. Starting with the ConfigurationMBean, the system retrieves the next attribute specified in the navigationAttributeNames array, expecting that attribute to be of a type assignable from the next bean in the Object[] array. This continues with the next navigationAttributeName applied to the current object until the end of the lists. Both arrays must be of the same length. At any point, if the attribute specified by the navigationAttributeName array element actually returns an array, then the base type of the array must expose the getName() method which returns a String so the system can select the correct child from the returned array to continue the navigation.
The propertyNames apply to the last object specified in the beans array.
| Operation Name | "getPropertyValues" |
| Parameters | Object [] { configBean, navigationAttributeNames, beans, propertyNames }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ConfigurationMBean",
"[Ljava.lang.String;",
"[Lweblogic.descriptor.SettableBean;",
"[Ljava.lang.String;" } |
| Returns |
class |
| Exceptions |
|
Returns the list of changed files on the remote non-admin machine. A FileChange element is returned for each file on the non-admin machine that is different, has been deleted, or has been added.
| Operation Name | "getRemoteFileChanges" |
| Parameters | Object [] { sysComp }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SystemComponentMBean" } |
| Returns |
class |
| Exceptions |
|
Returns the contents of the specified remote file.
| Operation Name | "getRemoteFileContents" |
| Parameters | Object [] { sysComp, chg }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SystemComponentMBean",
"weblogic.management.mbeanservers.edit.FileChange" } |
| Returns |
class |
| Exceptions |
|
Reports the working values for specified properties on the indicated config bean.
| Operation Name | "getWorkingValues" |
| Parameters | Object [] { configBean, propertyNames }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ConfigurationMBean",
"[Ljava.lang.String;" } |
| Returns |
class |
| Exceptions |
|
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.
| Operation Name | "haveUnactivatedChanges" |
| Parameters | null |
| Signature | null |
| Returns |
boolean
|
Purges from memory all ActivationTaskMBeans that
represent completed activation tasks.
| Operation Name | "purgeCompletedActivationTasks" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
Explicitly releases the reference to {@code EditAccess} in order to make it eligible for garbage collection.
| Operation Name | "releaseEditAccess" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
Reloads the configuration files from the pending directory updates the configuration contained in the Edit MBeanServer.
| Operation Name | "reload" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Removes references to bean that must be removed in order to destroy the specified instance of a configuration bean.
| Operation Name | "removeReferencesToBean" |
| Parameters | Object [] { configurationMBean }
where:
|
| Signature | String [] {
"weblogic.descriptor.DescriptorBean" } |
| Returns |
void
|
| Exceptions |
|
Resolve changes with global edit configuration.
| Operation Name | "resolve" |
| Parameters | Object [] { stopOnConflict, timeout }
where:
|
| Signature | String [] {
"java.lang.Boolean",
"java.lang.Long" } |
| Returns | ActivationTaskMBean |
| Exceptions |
|
Discard the configuration on the remote system from the admin configuration. This results in the changed files on the non-admin system being replaced on the next activate, thereby discarding any local changes. An edit session is required as configuration is updated.
| Operation Name | "resync" |
| Parameters | Object [] { sysComp }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SystemComponentMBean" } |
| Returns |
class |
| Exceptions |
|
Resynchronizes the configuration for all of the system components in the domain. This will replace any locally changed configuration files on the remote non-admin machines. This will include pending changes from the current edit session. An edit session is required for this call as remote files are updated.
| Operation Name | "resyncAll" |
| Parameters | null |
| Signature | null |
| Returns |
class |
| Exceptions |
|
Validates unsaved changes and saves them to the pending configuration files on disk.
| Operation Name | "save" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
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.
| Operation Name | "startEdit" |
| Parameters | Object [] { waitTimeInMillis, timeOutInMillis }
where:
|
| Signature | String [] {
"java.lang.Integer",
"java.lang.Integer" } |
| Returns | DomainMBean |
| Exceptions |
|
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.
| Operation Name | "startEdit" |
| Parameters | Object [] { waitTimeInMillis, timeOutInMillis, exclusive }
where:
|
| Signature | String [] {
"java.lang.Integer",
"java.lang.Integer",
"java.lang.Boolean" } |
| Returns | DomainMBean |
| Exceptions |
|
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.
| Operation Name | "stopEdit" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Pushes partition config directory contents to managed servers
| Operation Name | "syncPartitionConfig" |
| Parameters | Object [] { partitionName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
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.
| Operation Name | "undo" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
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.
| Operation Name | "undoUnactivatedChanges" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Updates the admin configuration with the contents of the remote system component. This replaces the admin server configuration files with those from the remote system component. Only the changed files are updated and they are placed in the pending directory so an subsequent active is required. An edit session is required for this call as configuration files are updated by this call.
| Operation Name | "updateConfigurationFromRemoteSystem" |
| Parameters | Object [] { sysComp }
where:
|
| Signature | String [] {
"weblogic.management.configuration.SystemComponentMBean" } |
| Returns |
class |
| Exceptions |
|
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.
| Operation Name | "validate" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|