public interface ConfigurationMBean extends WebLogicMBean, DescriptorBean, SettableBean
The tagging interface for configuration MBeans.
Modifier and Type | Field and Description |
---|---|
static byte[] |
DEFAULT_EMPTY_BYTE_ARRAY |
Modifier and Type | Method and Description |
---|---|
void |
freezeCurrentValue(String attributeName)
Deprecated.
9.0.0.0
|
long |
getId()
Return the unique id of this MBean instance
|
String[] |
getInheritedProperties(String[] propertyNames)
Return all properties' names whose value is inherited from template mbean.
|
String |
getName()
The user-specified name of this MBean instance.
|
String |
getNotes()
Optional information that you can include to describe this
configuration.
|
boolean |
isDynamicallyCreated()
Return whether the MBean was created dynamically or is persisted to config.xml
|
boolean |
isInherited(String propertyName)
Check if the value of a property is inherited from template mbean or not.
|
boolean |
isSet(String propertyName)
Returns true if the specified attribute has been set explicitly
in this MBean instance.
|
void |
restoreDefaultValue(String attributeName)
Deprecated.
9.0.0.0
|
void |
setComments(String comments)
Sets the comments attribute of the ConfigurationMBean object
|
void |
setDefaultedMBean(boolean defaulted)
Deprecated.
9.0.0.0
|
void |
setName(String name)
Sets the value of the Name attribute.
|
void |
setNotes(String notes)
Sets the Notes attribute of the ConfigurationMBean object
|
void |
setPersistenceEnabled(boolean persist)
Deprecated.
9.0.0.0
|
void |
unSet(String propertyName)
Restore the given property to its default value.
|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preDeregister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
String getName()
The user-specified name of this MBean instance.
This name is included as one of the key properties in the
MBean's javax.management.ObjectName
:
Name=user-specified-name
getName
in interface WebLogicMBean
void setName(String name) throws InvalidAttributeValueException, ManagementException
Sets the value of the Name attribute.
setName
in interface WebLogicMBean
InvalidAttributeValueException
ManagementException
String getNotes()
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration
file (config.xml
) as XML PCDATA. All left angle
brackets (<) are converted to the XML entity
<
. Carriage returns/line feeds are
preserved.
Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
void setNotes(String notes) throws InvalidAttributeValueException, DistributedManagementException
Sets the Notes attribute of the ConfigurationMBean object
notes
- The new notes valueInvalidAttributeValueException
DistributedManagementException
void setPersistenceEnabled(boolean persist)
Sets the persistenceEnabled attribute of the ConfigurationMBean object
persist
- The new persistenceEnabled valuevoid setDefaultedMBean(boolean defaulted)
Sets the defaultedMBean attribute of the ConfigurationMBean object
defaulted
- The new defaultedMBean valuevoid setComments(String comments)
Sets the comments attribute of the ConfigurationMBean object
comments
- The new comments valuevoid freezeCurrentValue(String attributeName) throws AttributeNotFoundException, MBeanException
If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.
Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.
Note: To insure that you are freezing the default value, invoke the
restoreDefaultValue
operation before you invoke
this.
This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.
attributeName
- AttributeNotFoundException
MBeanException
void restoreDefaultValue(String attributeName) throws AttributeNotFoundException
If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.
Default values are subject to change if you update to a newer
release of WebLogic Server. To prevent the value from changing if
you update to a newer release, invoke the
freezeCurrentValue
operation.
This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.
attributeName
- AttributeNotFoundException
boolean isSet(String propertyName)
Returns true if the specified attribute has been set explicitly in this MBean instance.
propertyName
- property to checkvoid unSet(String propertyName)
Restore the given property to its default value.
propertyName
- property to restoreUnsupportedOperationException
- if called on a runtime
implementation.boolean isInherited(String propertyName)
Check if the value of a property is inherited from template mbean or not.
propertyName
- the name of the propertyIllegalArgumentException
- if property is invalidString[] getInheritedProperties(String[] propertyNames)
Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.
propertyNames
- properties to checkboolean isDynamicallyCreated()
Return whether the MBean was created dynamically or is persisted to config.xml
long getId()
Return the unique id of this MBean instance