|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigurationMBean
The tagging interface for configuration MBeans.
Field Summary | |
---|---|
static byte[] |
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
abstract void |
freezeCurrentValue(String attributeName) Deprecated. 9.0.0.0 |
abstract long |
getId() Return the unique id of this MBean instance |
abstract String[] |
getInheritedProperties(String[] propertyNames) Return all properties' names whose value is inherited from template mbean. |
abstract String |
getName() The user-specified name of this MBean instance. |
abstract String |
getNotes() Optional information that you can include to describe this configuration. |
abstract boolean |
isDynamicallyCreated() Return whether the MBean was created dynamically or is persisted to config.xml |
abstract boolean |
isInherited(String propertyName) Check if the value of a property is inherited from template mbean or not. |
abstract boolean |
isSet(String propertyName) Returns true if the specified attribute has been set explicitly in this MBean instance. |
abstract void |
restoreDefaultValue(String attributeName) Deprecated. 9.0.0.0 |
abstract void |
setComments(String comments) Sets the comments attribute of the ConfigurationMBean object |
abstract void |
setDefaultedMBean(boolean defaulted) Deprecated. 9.0.0.0 |
abstract void |
setName(String name) Sets the value of the Name attribute. |
abstract void |
setNotes(String notes) Sets the Notes attribute of the ConfigurationMBean object |
abstract void |
setPersistenceEnabled(boolean persist) Deprecated. 9.0.0.0 |
abstract void |
unSet(String propertyName) Restore the given property to its default value. |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Methods inherited from interface weblogic.descriptor.DescriptorBean |
---|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener |
Field Detail |
---|
static final byte[] DEFAULT_EMPTY_BYTE_ARRAY
Method Detail |
---|
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
|
Copyright 1996, 2015, 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.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |