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 |
---|---|
boolean |
addTag(java.lang.String tag)
Add a tag to this Configuration MBean.
|
void |
freezeCurrentValue(java.lang.String attributeName)
Deprecated.
9.0.0.0
|
java.lang.String |
getComments()
Indicates if any comments were added in config.xml
|
long |
getId()
Return the unique id of this MBean instance
|
java.lang.String[] |
getInheritedProperties(java.lang.String[] propertyNames)
Return all properties' names whose value is inherited from template mbean.
|
java.lang.String |
getName()
The user-specified name of this MBean instance.
|
java.lang.String |
getNotes()
Optional information that you can include to describe this
configuration.
|
java.lang.String[] |
getTags()
Return all tags on this Configuration MBean
|
boolean |
isDefaultedMBean()
Indicates whether this MBean was created as DefaultMBean as part
of server boot.
|
boolean |
isDynamicallyCreated()
Return whether the MBean was created dynamically or is persisted to config.xml
|
boolean |
isInherited(java.lang.String propertyName)
Check if the value of a property is inherited from template mbean or not.
|
boolean |
isPersistenceEnabled()
Indicates whether this bean should ever written to the
repository.
|
boolean |
isSet(java.lang.String propertyName)
Returns true if the specified attribute has been set explicitly
in this MBean instance.
|
boolean |
removeTag(java.lang.String tag)
Remove a tag from this Configuration MBean
|
void |
restoreDefaultValue(java.lang.String attributeName)
Deprecated.
9.0.0.0
|
void |
setComments(java.lang.String comments)
Sets the comments attribute of the ConfigurationMBean object
|
void |
setDefaultedMBean(boolean defaulted)
Deprecated.
9.0.0.0
|
void |
setName(java.lang.String name)
Sets the value of the Name attribute.
|
void |
setNotes(java.lang.String notes)
Sets the Notes attribute of the ConfigurationMBean object
|
void |
setPersistenceEnabled(boolean persist)
Deprecated.
9.0.0.0
|
void |
setTags(java.lang.String[] tagArray)
Sets the tags on the Configuration MBean, replacing the old set of tags
with a new set of tags.
|
void |
touch()
Mark the attribute as modified so that it can be persisted.
|
void |
unSet(java.lang.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
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener
java.lang.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(java.lang.String name) throws javax.management.InvalidAttributeValueException, ManagementException
Sets the value of the Name attribute.
setName
in interface WebLogicMBean
javax.management.InvalidAttributeValueException
ManagementException
java.lang.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(java.lang.String notes) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Sets the Notes attribute of the ConfigurationMBean object
notes
- The new notes valuejavax.management.InvalidAttributeValueException
DistributedManagementException
boolean isPersistenceEnabled()
Indicates whether this bean should ever written to the repository. This is a dynamic version of the nonPersistent tag, which specifies that the class of bean shouldn't be persisted. This attribute just states whether a particular instance should be persisted. Care should be taken that if an MBean has this set to false, then any MBeans that reference it should also not be persisted.
@Deprecated void setPersistenceEnabled(boolean persist)
Sets the persistenceEnabled attribute of the ConfigurationMBean object
persist
- The new persistenceEnabled valueboolean isDefaultedMBean()
Indicates whether this MBean was created as DefaultMBean as part of server boot. If it is then it will not get persisted to config.xml
@Deprecated void setDefaultedMBean(boolean defaulted)
Sets the defaultedMBean attribute of the ConfigurationMBean object
defaulted
- The new defaultedMBean valuejava.lang.String getComments()
Indicates if any comments were added in config.xml
void setComments(java.lang.String comments)
Sets the comments attribute of the ConfigurationMBean object
comments
- The new comments valuevoid touch() throws ConfigurationException
Mark the attribute as modified so that it can be persisted. This is generally because one of its children was modified and is flag the parent for persistence.
ConfigurationException
- if it cannot be added to the persistent store@Deprecated void freezeCurrentValue(java.lang.String attributeName) throws javax.management.AttributeNotFoundException, javax.management.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
- javax.management.AttributeNotFoundException
javax.management.MBeanException
@Deprecated void restoreDefaultValue(java.lang.String attributeName) throws javax.management.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
- javax.management.AttributeNotFoundException
boolean isSet(java.lang.String propertyName)
Returns true if the specified attribute has been set explicitly in this MBean instance.
isSet
in interface SettableBean
propertyName
- property to checkvoid unSet(java.lang.String propertyName)
Restore the given property to its default value.
unSet
in interface SettableBean
propertyName
- property to restorejava.lang.UnsupportedOperationException
- if called on a runtime
implementation.boolean isInherited(java.lang.String propertyName)
Check if the value of a property is inherited from template mbean or not.
propertyName
- the name of the propertyjava.lang.IllegalArgumentException
- if property is invalidjava.lang.String[] getInheritedProperties(java.lang.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
java.lang.String[] getTags()
Return all tags on this Configuration MBean
void setTags(java.lang.String[] tagArray) throws java.lang.IllegalArgumentException
Sets the tags on the Configuration MBean, replacing the old set of tags with a new set of tags. All tags are removed from the Configuration MBean if the tagArray param is an empty String array. Tags may contain white spaces.
tagArray
- tags to be added to the MBeanjava.lang.IllegalArgumentException
- if the tag contains illegal punctuationboolean addTag(java.lang.String tag) throws java.lang.IllegalArgumentException
Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.
tag
- tag to be added to the MBeanjava.lang.IllegalArgumentException
- if the tag contains illegal punctuationboolean removeTag(java.lang.String tag) throws java.lang.IllegalArgumentException
Remove a tag from this Configuration MBean
tag
- tag to be removed from the MBeanjava.lang.IllegalArgumentException
- if the tag contains illegal punctuation