| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ModelMBeanInfo info = …;
String name = …;
ModelMBeanAttributeInfo attrInfo = info.getAttribute(name);
Based on 13 examples
public class ModelMBeanAttributeInfo extends MBeanAttributeInfo implements DescriptorAccess
The ModelMBeanAttributeInfo object describes an attribute of the ModelMBean. It is a subclass of MBeanAttributeInfo with the addition of an associated Descriptor and an implementation of the DescriptorAccess interface.
The fields in the descriptor are defined, but not limited to, the following:
name : attribute name descriptorType : must be "attribute" value : current value for attribute default : default value for attribute displayName : name of attribute to be used in displays getMethod : name of operation descriptor for get method setMethod : name of operation descriptor for set method protocolMap : object which implements the Descriptor interface: mappings must be appropriate for the attribute and entries can be updated or augmented at runtime. persistPolicy : OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never persistPeriod : seconds - frequency of persist cycle. Used when persistPolicy is"OnTimer" or "NoMoreOftenThan". currencyTimeLimit : how long value is valid, <0 never, =0 always, >0 seconds lastUpdatedTimeStamp : when value was set visibility : 1-4 where 1: always visible 4: rarely visible presentationString : xml formatted string to allow presentation of dataThe default descriptor contains the name, descriptorType and displayName fields.
Note: because of inconsistencies in previous versions of
this specification, it is recommended not to use negative or zero
values for currencyTimeLimit
. To indicate that a
cached value is never valid, omit the
currencyTimeLimit
field. To indicate that it is
always valid, use a very large number for this field.
The serialVersionUID of this class is 6181543027787327345L
.
Field Summary |
---|
Fields inherited from class javax.management.MBeanFeatureInfo |
---|
description, name |
Constructor Summary | |
---|---|
Constructs a new ModelMBeanAttributeInfo object from this ModelMBeanAttributeInfo Object. |
|
ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter) Constructs a ModelMBeanAttributeInfo object with a default descriptor. |
|
ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor) Constructs a ModelMBeanAttributeInfo object. |
|
ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs) Constructs a ModelMBeanAttributeInfo object with a default descriptor. |
|
ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor) Constructs a ModelMBeanAttributeInfo object with a default descriptor. |
Method Summary | |
---|---|
Object |
clone() Creates and returns a new ModelMBeanAttributeInfo which is a duplicate of this ModelMBeanAttributeInfo. |
Descriptor |
Gets a copy of the associated Descriptor for the ModelMBeanAttributeInfo. |
void |
setDescriptor(Descriptor inDescriptor) Sets associated Descriptor (full replace) for the ModelMBeanAttributeDescriptor. |
String |
toString() Returns a human-readable version of the ModelMBeanAttributeInfo instance. |
Methods inherited from class javax.management.MBeanAttributeInfo |
---|
clone, equals, getType, hashCode, isIs, isReadable, isWritable, toString |
Methods inherited from class javax.management.MBeanFeatureInfo |
---|
equals, getDescription, getDescriptor, getName, hashCode |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)
inInfo
- the ModelMBeanAttributeInfo to be duplicatedpublic ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter) throws IntrospectionException
name
- The name of the attribute.description
- A human readable description of the attribute. Optional.getter
- The method used for reading the attribute value.
May be null if the property is write-only.setter
- The method used for writing the attribute value.
May be null if the attribute is read-only.IntrospectionException
- There is a consistency problem in the definition of this attribute.public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor) throws IntrospectionException
name
- The name of the attribute.description
- A human readable description of the attribute. Optional.getter
- The method used for reading the attribute value.
May be null if the property is write-only.setter
- The method used for writing the attribute value.
May be null if the attribute is read-only.descriptor
- An instance of Descriptor containing the appropriate metadata
for this instance of the Attribute. If it is null, then a default descriptor will be created.
If the descriptor does not contain the field "displayName" this field is added in the descriptor with its default value.IntrospectionException
- There is a consistency problem in the definition of this attribute.public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)
name
- The name of the attributetype
- The type or class name of the attributedescription
- A human readable description of the attribute.isReadable
- True if the attribute has a getter method, false otherwise.isWritable
- True if the attribute has a setter method, false otherwise.isIs
- True if the attribute has an "is" getter, false otherwise.public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
name
- The name of the attributetype
- The type or class name of the attributedescription
- A human readable description of the attribute.isReadable
- True if the attribute has a getter method, false otherwise.isWritable
- True if the attribute has a setter method, false otherwise.isIs
- True if the attribute has an "is" getter, false otherwise.descriptor
- An instance of Descriptor containing the appropriate metadata
for this instance of the Attribute. If it is null then a default descriptor will be created.
If the descriptor does not contain the field "displayName" this field is added in the descriptor with its default value.Method Detail |
---|
public Object clone()
clone
in class MBeanAttributeInfo
public Descriptor getDescriptor()
getDescriptor
in class MBeanFeatureInfo
public void setDescriptor(Descriptor inDescriptor)
inDescriptor
- replaces the Descriptor associated with the
ModelMBeanAttributeInfopublic String toString()
toString
in class MBeanAttributeInfo
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |