| javax.management.MBeanAttributeInfo
 javax.management.modelmbean.ModelMBeanAttributeInfo
| ModelMBeanAttributeInfo | | public class ModelMBeanAttributeInfo extends MBeanAttributeInfo implements DescriptorAccess(Code) | | 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 data
The default descriptor contains the name, descriptorType and displayName fields.
The default value of the name and displayName fields is the name of the attribute.
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.
since:
1.5 |
| Constructor Summary | |
| public | ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter)
Constructs a ModelMBeanAttributeInfo object with a default
descriptor. | | public | ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor)
Constructs a ModelMBeanAttributeInfo object. | | public | ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)
Constructs a ModelMBeanAttributeInfo object with a default descriptor. | | public | ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)
Constructs a ModelMBeanAttributeInfo object with a default descriptor.
Parameters:
name - The name of the attribute
Parameters:
type - The type or class name of the attribute
Parameters:
description - A human readable description of the attribute.
Parameters:
isReadable - True if the attribute has a getter method, false otherwise.
Parameters:
isWritable - True if the attribute has a setter method, false otherwise.
Parameters:
isIs - True if the attribute has an "is" getter, false otherwise.
Parameters:
descriptor - An instance of Descriptor containing theappropriate metadata for this instance of the Attribute. | | public | ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)
Constructs a new ModelMBeanAttributeInfo object from this
ModelMBeanAttributeInfo Object. |
| Method Summary | |
| public Object | clone()
Creates and returns a new ModelMBeanAttributeInfo which is a duplicate of this ModelMBeanAttributeInfo.
exception:
RuntimeOperationsException - for illegal value forfield Names or field Values. | | public Descriptor | getDescriptor()
Gets a copy of the associated Descriptor for the
ModelMBeanAttributeInfo. | | public void | setDescriptor(Descriptor inDescriptor)
Sets associated Descriptor (full replace) for the
ModelMBeanAttributeDescriptor. | | public String | toString()
Returns a human-readable version of the
ModelMBeanAttributeInfo instance. |
| ModelMBeanAttributeInfo | | public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter) throws javax.management.IntrospectionException(Code) | | Constructs a ModelMBeanAttributeInfo object with a default
descriptor. The
Descriptor of the constructed
object will include fields contributed by any annotations
on the
Method objects that contain the
DescriptorKey meta-annotation.
Parameters:
name - The name of the attribute.
Parameters:
description - A human readable description of the attribute. Optional.
Parameters:
getter - The method used for reading the attribute value.May be null if the property is write-only.
Parameters:
setter - The method used for writing the attribute value.May be null if the attribute is read-only.
exception:
IntrospectionException - There is a consistencyproblem in the definition of this attribute. |
| ModelMBeanAttributeInfo | | public ModelMBeanAttributeInfo(String name, String description, Method getter, Method setter, Descriptor descriptor) throws javax.management.IntrospectionException(Code) | | Constructs a ModelMBeanAttributeInfo object. The
Descriptor of the constructed object will include fields
contributed by any annotations on the
Method objects that contain the
DescriptorKey meta-annotation.
Parameters:
name - The name of the attribute.
Parameters:
description - A human readable description of the attribute. Optional.
Parameters:
getter - The method used for reading the attribute value.May be null if the property is write-only.
Parameters:
setter - The method used for writing the attribute value.May be null if the attribute is read-only.
Parameters:
descriptor - An instance of Descriptor containing theappropriate metadata for this instance of the Attribute. Ifit is null, then a default descriptor will be created. Ifthe descriptor does not contain all the following fields,the missing ones are added with their default values:displayName, name, descriptorType.
exception:
IntrospectionException - There is a consistencyproblem in the definition of this attribute.
exception:
RuntimeOperationsException - Wraps anIllegalArgumentException. The descriptor is invalid, ordescriptor field "name" is present but not equal to nameparameter, or descriptor field "descriptorType" is presentbut not equal to "attribute". |
| ModelMBeanAttributeInfo | | public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs)(Code) | | Constructs a ModelMBeanAttributeInfo object with a default descriptor.
Parameters:
name - The name of the attribute
Parameters:
type - The type or class name of the attribute
Parameters:
description - A human readable description of the attribute.
Parameters:
isReadable - True if the attribute has a getter method, false otherwise.
Parameters:
isWritable - True if the attribute has a setter method, false otherwise.
Parameters:
isIs - True if the attribute has an "is" getter, false otherwise. |
| ModelMBeanAttributeInfo | | public ModelMBeanAttributeInfo(String name, String type, String description, boolean isReadable, boolean isWritable, boolean isIs, Descriptor descriptor)(Code) | | Constructs a ModelMBeanAttributeInfo object with a default descriptor.
Parameters:
name - The name of the attribute
Parameters:
type - The type or class name of the attribute
Parameters:
description - A human readable description of the attribute.
Parameters:
isReadable - True if the attribute has a getter method, false otherwise.
Parameters:
isWritable - True if the attribute has a setter method, false otherwise.
Parameters:
isIs - True if the attribute has an "is" getter, false otherwise.
Parameters:
descriptor - An instance of Descriptor containing theappropriate metadata for this instance of the Attribute. Ifit is null then a default descriptor will be created. Ifthe descriptor does not contain all the following fields,the missing ones are added with their default values:displayName, name, descriptorType.
exception:
RuntimeOperationsException - Wraps anIllegalArgumentException. The descriptor is invalid, ordescriptor field "name" is present but not equal to nameparameter, or descriptor field "descriptorType" is presentbut not equal to "attribute". |
| ModelMBeanAttributeInfo | | public ModelMBeanAttributeInfo(ModelMBeanAttributeInfo inInfo)(Code) | | Constructs a new ModelMBeanAttributeInfo object from this
ModelMBeanAttributeInfo Object. A default descriptor will
be created.
Parameters:
inInfo - the ModelMBeanAttributeInfo to be duplicated |
| clone | | public Object clone()(Code) | | Creates and returns a new ModelMBeanAttributeInfo which is a duplicate of this ModelMBeanAttributeInfo.
exception:
RuntimeOperationsException - for illegal value forfield Names or field Values. If the descriptor constructionfails for any reason, this exception will be thrown. |
| setDescriptor | | public void setDescriptor(Descriptor inDescriptor)(Code) | | Sets associated Descriptor (full replace) for the
ModelMBeanAttributeDescriptor. If the new Descriptor is
null, then the associated Descriptor reverts to a default
descriptor. The Descriptor is validated before it is
assigned. If the new Descriptor is invalid, then a
RuntimeOperationsException wrapping an
IllegalArgumentException is thrown.
If the descriptor does not contain all the following fields, the
missing ones are added with
their default values: displayName, name, descriptorType.
Parameters:
inDescriptor - replaces the Descriptor associated with theModelMBeanAttributeInfo
exception:
RuntimeOperationsException - Wraps anIllegalArgumentException for an invalid Descriptor
See Also: ModelMBeanAttributeInfo.getDescriptor |
| toString | | public String toString()(Code) | | Returns a human-readable version of the
ModelMBeanAttributeInfo instance.
|
|
|