-
public interface CompositeDataView
A Java class can implement this interface to indicate how it is to be converted into a
CompositeData
by the MXBean framework.A typical way to use this class is to add extra items to the
CompositeData
in addition to the ones that are declared in theCompositeType
supplied by the MXBean framework. To do this, you must create anotherCompositeType
that has all the same items, plus your extra items.For example, suppose you have a class
Measure
that consists of a String calledunits
and avalue
that is either along
or adouble
. It might look like this:public class Measure implements CompositeDataView { private String units; private Number value; // a Long or a Double public Measure(String units, Number value) { this.units = units; this.value = value; } public static Measure from(CompositeData cd) { return new Measure((String) cd.get("units"), (Number) cd.get("value")); } public String getUnits() { return units; } // Can't be called getValue(), because Number is not a valid type // in an MXBean, so the implied "value" property would be rejected. public Number _getValue() { return value; } public CompositeData toCompositeData(CompositeType ct) { try {
List<String> itemNames = new ArrayList<String>(ct.keySet());
List<String> itemDescriptions = new ArrayList<String>();
List<OpenType<?>> itemTypes = new ArrayList<OpenType<?>>();
for (String item : itemNames) { itemDescriptions.add(ct.getDescription(item)); itemTypes.add(ct.getType(item)); } itemNames.add("value"); itemDescriptions.add("long or double value of the measure"); itemTypes.add((value instanceof Long) ? SimpleType.LONG : SimpleType.DOUBLE); CompositeType xct = new CompositeType(ct.getTypeName(), ct.getDescription(), itemNames.toArray(new String[0]), itemDescriptions.toArray(new String[0]), itemTypes.toArray(new OpenType<?>[0])); CompositeData cd = new CompositeDataSupport(xct, new String[] {"units", "value"}, new Object[] {units, value}); assert ct.isValue(cd); // check we've done it right return cd; } catch (Exception e) { throw new RuntimeException(e); } } }The
CompositeType
that will appear in theopenType
field of theDescriptor
for an attribute or operation of this type will show only theunits
item, but the actualCompositeData
that is generated will have bothunits
andvalue
.- Since:
- 1.6
- See Also:
MXBean
-
-
Method Summary
Methods Modifier and Type Method and Description CompositeData
toCompositeData(CompositeType ct)
Return aCompositeData
corresponding to the values in this object.
-
-
-
Method Detail
-
toCompositeData
CompositeData toCompositeData(CompositeType ct)
Return a
CompositeData
corresponding to the values in this object. The returned value should usually be an instance ofCompositeDataSupport
, or a class that serializes as aCompositeDataSupport
via awriteReplace
method. Otherwise, a remote client that receives the object might not be able to reconstruct it.- Parameters:
ct
- The expectedCompositeType
of the returned value. If the returned value iscd
, thencd.getCompositeType().equals(ct)
should be true. Typically this will be becausecd
is aCompositeDataSupport
constructed withct
as itsCompositeType
.- Returns:
- the
CompositeData
.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/management/openmbean/CompositeDataView.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.