Modifier and Type	Class and Description
private static class	Introspector.SimpleIntrospector A simple introspector that uses reflection to analyze a class and identify its "getter" methods.

Modifier and Type	Field and Description
public static final boolean	ALLOW_NONPUBLIC_MBEAN

Access	Constructor and Description
private	Introspector()

Method Summary

Modifier and Type	Method and Description
private static Object	annotationToField(Object x)
public static void	checkCompliance(Class<?> mbeanClass)
public static Descriptor	descriptorForAnnotations(Annotation[] annots)
public static Descriptor	descriptorForElement(final AnnotatedElement elmt)
public static Object	elementFromComplex(Object complex, String element)
private static boolean	equals(Object x, Object y)
private static <T> Class<? super T>	findMBeanInterface(Class<T> aClass, String aName) Try to find the MBean interface corresponding to the class aName - i.e. aNameMBean, from within aClass and its superclasses.
private static <M> MBeanInfo	getClassMBeanInfo(MBeanIntrospector<M> introspector, Class<?> baseClass, Class<?> mbeanInterface)
public static Class<?>	Returns: The MBean interface implemented by the MBean. Return `null` if the MBean is a DynamicMBean, or if no MBean interface is found. getMBeanInterface(Class<?> The class to be tested. baseClass) Get the MBean interface implemented by a JMX Standard MBean class.
public static <T> Class<? super T>	Returns: The MXBean interface implemented by the MXBean. getMXBeanInterface(Class<T> The class to be tested. baseClass) Get the MXBean interface implemented by a JMX MXBean class.
public static <T> Class<? super T>	Returns: The MBean interface implemented by the Standard MBean. getStandardMBeanInterface(Class<T> The class to be tested. baseClass) Get the MBean interface implemented by a JMX Standard MBean class.
private static <T> Class<? super T>	implementsMBean(Class<T> The interface to be tested c, String The name of the class implementing this interface clName) Returns the XXMBean interface or null if no such interface exists
public static final boolean	Returns: `true` if instances of `c` are Dynamic MBeans, `false` otherwise. isDynamic(final Class<?> The class of the MBean under examination. c) Tell whether a MBean of the given class is a Dynamic MBean.
public static <T> DynamicMBean	makeDynamicMBean(T mbean)
public static MBeanInfo	Returns: `null` if the MBean is a DynamicMBean, the computed `javax.management.MBeanInfo` otherwise. testCompliance(Class<?> The class to be tested baseClass) Basic method for testing if a given class is a JMX compliant MBean.
public static synchronized MBeanInfo	Returns: the computed `javax.management.MBeanInfo`. testCompliance(final Class<?> The class to be tested. baseClass, Class<?> the MBean interface that the class implements, or null if the interface must be determined by introspection. mbeanInterface) Basic method for testing if a given class is a JMX compliant Standard MBean.
public static void	testComplianceMBeanInterface(Class<?> An interface class to test for the MBean compliance interfaceClass) Tests the given interface class for being a compliant MBean interface.
public static void	testComplianceMXBeanInterface(Class<?> An interface class to test for the MXBean compliance interfaceClass) Tests the given interface class for being a compliant MXBean interface.
public static void	testCreation(Class<?> The class of the MBean we want to create. c) Basic method for testing that a MBean of a given class can be instantiated by the MBean server.
pack-priv static NotCompliantMBeanException	Returns: nothing - this method always throw an exception. The return type makes it possible to write throw throwException(clazz,cause); throwException(Class<?> the class which was under examination notCompliant, Throwable the reason why NotCompliantMBeanException should be thrown. cause) Throws a NotCompliantMBeanException or a SecurityException.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALLOW_NONPUBLIC_MBEAN	back to summary
public static final boolean ALLOW_NONPUBLIC_MBEAN

Constructor Detail

Introspector	back to summary
private Introspector()

Method Detail

annotationToField	back to summary
private static Object annotationToField(Object x)

checkCompliance	back to summary
public static void checkCompliance(Class<?> mbeanClass) throws NotCompliantMBeanException

descriptorForAnnotations	back to summary
public static Descriptor descriptorForAnnotations(Annotation[] annots)

descriptorForElement	back to summary
public static Descriptor descriptorForElement(final AnnotatedElement elmt)

elementFromComplex	back to summary
public static Object elementFromComplex(Object complex, String element) throws AttributeNotFoundException

equals	back to summary
private static boolean equals(Object x, Object y)

findMBeanInterface	back to summary
private static <T> Class<? super T> findMBeanInterface(Class<T> aClass, String aName) Try to find the MBean interface corresponding to the class aName - i.e. aNameMBean, from within aClass and its superclasses.

getClassMBeanInfo	back to summary
private static <M> MBeanInfo getClassMBeanInfo(MBeanIntrospector<M> introspector, Class<?> baseClass, Class<?> mbeanInterface) throws NotCompliantMBeanException

getMBeanInterface back to summary

getMBeanInterface	back to summary
public static Class<?> getMBeanInterface(Class<?> baseClass) Get the MBean interface implemented by a JMX Standard MBean class. This method is only called by the legacy code in "com.sun.management.jmx". Parameters baseClass:Class<?> The class to be tested. Returns:Class<?> The MBean interface implemented by the MBean. Return `null` if the MBean is a DynamicMBean, or if no MBean interface is found.

public static Class<?> getMBeanInterface(Class<?> baseClass)

Get the MBean interface implemented by a JMX Standard MBean class. This method is only called by the legacy code in "com.sun.management.jmx".

Parameters

baseClass:Class<?>: The class to be tested.

Returns:Class<?>

The MBean interface implemented by the MBean. Return null if the MBean is a DynamicMBean, or if no MBean interface is found.

getMXBeanInterface	back to summary
public static <T> Class<? super T> getMXBeanInterface(Class<T> baseClass) throws NotCompliantMBeanException Get the MXBean interface implemented by a JMX MXBean class. Parameters baseClass:Class<T> The class to be tested. Returns:Class<? super T> The MXBean interface implemented by the MXBean. Exceptions NotCompliantMBeanException: The specified class is not a JMX compliant MXBean.

getMXBeanInterface

back to summary

public static <T> Class<? super T> getMXBeanInterface(Class<T> baseClass) throws NotCompliantMBeanException

Get the MXBean interface implemented by a JMX MXBean class.

Parameters

baseClass:Class<T>: The class to be tested.

Returns:Class<? super T>

The MXBean interface implemented by the MXBean.

Exceptions

NotCompliantMBeanException:: The specified class is not a JMX compliant MXBean.

getStandardMBeanInterface	back to summary
public static <T> Class<? super T> getStandardMBeanInterface(Class<T> baseClass) throws NotCompliantMBeanException Get the MBean interface implemented by a JMX Standard MBean class. Parameters baseClass:Class<T> The class to be tested. Returns:Class<? super T> The MBean interface implemented by the Standard MBean. Exceptions NotCompliantMBeanException: The specified class is not a JMX compliant Standard MBean.

getStandardMBeanInterface

back to summary

public static <T> Class<? super T> getStandardMBeanInterface(Class<T> baseClass) throws NotCompliantMBeanException

Get the MBean interface implemented by a JMX Standard MBean class.

Parameters

baseClass:Class<T>: The class to be tested.

Returns:Class<? super T>

The MBean interface implemented by the Standard MBean.

Exceptions

NotCompliantMBeanException:: The specified class is not a JMX compliant Standard MBean.

implementsMBean	back to summary
private static <T> Class<? super T> implementsMBean(Class<T> c, String clName) Returns the XXMBean interface or null if no such interface exists Parameters c:Class<T> The interface to be tested clName:String The name of the class implementing this interface

implementsMBean

back to summary

private static <T> Class<? super T> implementsMBean(Class<T> c, String clName)

Returns the XXMBean interface or null if no such interface exists

Parameters

c:Class<T>: The interface to be tested
clName:String: The name of the class implementing this interface

isDynamic back to summary

isDynamic	back to summary
public static final boolean isDynamic(final Class<?> c) Tell whether a MBean of the given class is a Dynamic MBean. This method does nothing more than returning javax.management.DynamicMBean.class.isAssignableFrom(c) This method does not check for any JMX MBean compliance: If `true` is returned, then instances of `c` are DynamicMBean. If `false` is returned, then no further assumption can be made on instances of `c`. In particular, instances of `c` may, or may not be JMX standard MBeans. Parameters c:Class<?> The class of the MBean under examination. Returns:boolean `true` if instances of `c` are Dynamic MBeans, `false` otherwise.

public static final boolean isDynamic(final Class<?> c)

Tell whether a MBean of the given class is a Dynamic MBean. This method does nothing more than returning

javax.management.DynamicMBean.class.isAssignableFrom(c)

This method does not check for any JMX MBean compliance:

If true is returned, then instances of c are DynamicMBean.
If false is returned, then no further assumption can be made on instances of c. In particular, instances of c may, or may not be JMX standard MBeans.

Parameters

c:Class<?>: The class of the MBean under examination.

Returns:boolean

true if instances of c are Dynamic MBeans, false otherwise.

makeDynamicMBean	back to summary
public static <T> DynamicMBean makeDynamicMBean(T mbean) throws NotCompliantMBeanException

testCompliance back to summary

testCompliance	back to summary
public static MBeanInfo testCompliance(Class<?> baseClass) throws NotCompliantMBeanException Basic method for testing if a given class is a JMX compliant MBean. Parameters baseClass:Class<?> The class to be tested Returns:MBeanInfo `null` if the MBean is a DynamicMBean, the computed `javax.management.MBeanInfo` otherwise. Exceptions NotCompliantMBeanException: The specified class is not a JMX compliant MBean

public static MBeanInfo testCompliance(Class<?> baseClass) throws NotCompliantMBeanException

Basic method for testing if a given class is a JMX compliant MBean.

Parameters

baseClass:Class<?>: The class to be tested

Returns:MBeanInfo

null if the MBean is a DynamicMBean, the computed javax.management.MBeanInfo otherwise.

Exceptions

NotCompliantMBeanException:: The specified class is not a JMX compliant MBean

testCompliance back to summary

testCompliance	back to summary
public static synchronized MBeanInfo testCompliance(final Class<?> baseClass, Class<?> mbeanInterface) throws NotCompliantMBeanException Basic method for testing if a given class is a JMX compliant Standard MBean. This method is only called by the legacy code in com.sun.management.jmx. Parameters baseClass:Class<?> The class to be tested. mbeanInterface:Class<?> the MBean interface that the class implements, or null if the interface must be determined by introspection. Returns:MBeanInfo the computed `javax.management.MBeanInfo`. Exceptions NotCompliantMBeanException: The specified class is not a JMX compliant Standard MBean

public static synchronized MBeanInfo testCompliance(final Class<?> baseClass, Class<?> mbeanInterface) throws NotCompliantMBeanException

Basic method for testing if a given class is a JMX compliant Standard MBean. This method is only called by the legacy code in com.sun.management.jmx.

Parameters

baseClass:Class<?>: The class to be tested.
mbeanInterface:Class<?>: the MBean interface that the class implements, or null if the interface must be determined by introspection.

Returns:MBeanInfo

the computed javax.management.MBeanInfo.

Exceptions

NotCompliantMBeanException:: The specified class is not a JMX compliant Standard MBean

testComplianceMBeanInterface back to summary

testComplianceMBeanInterface	back to summary
public static void testComplianceMBeanInterface(Class<?> interfaceClass) throws NotCompliantMBeanException Tests the given interface class for being a compliant MBean interface. A compliant MBean interface is any publicly accessible interface following the `MBean` conventions. Parameters interfaceClass:Class<?> An interface class to test for the MBean compliance Exceptions NotCompliantMBeanException: Thrown when the tested interface is not public or contradicts the `MBean` conventions.

public static void testComplianceMBeanInterface(Class<?> interfaceClass) throws NotCompliantMBeanException

Tests the given interface class for being a compliant MBean interface. A compliant MBean interface is any publicly accessible interface following the MBean conventions.

Parameters

interfaceClass:Class<?>: An interface class to test for the MBean compliance

Exceptions

NotCompliantMBeanException:: Thrown when the tested interface is not public or contradicts the MBean conventions.

testComplianceMXBeanInterface back to summary

testComplianceMXBeanInterface	back to summary
public static void testComplianceMXBeanInterface(Class<?> interfaceClass) throws NotCompliantMBeanException Tests the given interface class for being a compliant MXBean interface. A compliant MXBean interface is any publicly accessible interface following the `MXBean` conventions. Parameters interfaceClass:Class<?> An interface class to test for the MXBean compliance Exceptions NotCompliantMBeanException: Thrown when the tested interface is not public or contradicts the `MXBean` conventions.

public static void testComplianceMXBeanInterface(Class<?> interfaceClass) throws NotCompliantMBeanException

Tests the given interface class for being a compliant MXBean interface. A compliant MXBean interface is any publicly accessible interface following the MXBean conventions.

Parameters

interfaceClass:Class<?>: An interface class to test for the MXBean compliance

Exceptions

NotCompliantMBeanException:: Thrown when the tested interface is not public or contradicts the MXBean conventions.

testCreation	back to summary
public static void testCreation(Class<?> c) throws NotCompliantMBeanException Basic method for testing that a MBean of a given class can be instantiated by the MBean server. This method checks that: The given class is a concrete class. The given class exposes at least one public constructor. If these conditions are not met, throws a NotCompliantMBeanException. Parameters c:Class<?> The class of the MBean we want to create. Exceptions NotCompliantMBeanException: if the MBean class makes it impossible to instantiate the MBean from within the MBeanServer.

testCreation

back to summary

public static void testCreation(Class<?> c) throws NotCompliantMBeanException

Basic method for testing that a MBean of a given class can be instantiated by the MBean server.

This method checks that:

The given class is a concrete class.
The given class exposes at least one public constructor.

If these conditions are not met, throws a NotCompliantMBeanException.

Parameters

c:Class<?>: The class of the MBean we want to create.

Exceptions

NotCompliantMBeanException:: if the MBean class makes it impossible to instantiate the MBean from within the MBeanServer.

throwException	back to summary
pack-priv static NotCompliantMBeanException throwException(Class<?> notCompliant, Throwable cause) throws NotCompliantMBeanException, SecurityException Throws a NotCompliantMBeanException or a SecurityException. Parameters notCompliant:Class<?> the class which was under examination cause:Throwable the reason why NotCompliantMBeanException should be thrown. Returns:NotCompliantMBeanException nothing - this method always throw an exception. The return type makes it possible to write throw throwException(clazz,cause); Exceptions NotCompliantMBeanException: otherwise. SecurityException: if cause is a SecurityException

throwException

back to summary

pack-priv static NotCompliantMBeanException throwException(Class<?> notCompliant, Throwable cause) throws NotCompliantMBeanException, SecurityException

Throws a NotCompliantMBeanException or a SecurityException.

Parameters

notCompliant:Class<?>: the class which was under examination
cause:Throwable: the reason why NotCompliantMBeanException should be thrown.

Returns:NotCompliantMBeanException

nothing - this method always throw an exception. The return type makes it possible to write

 throw throwException(clazz,cause);

Exceptions

NotCompliantMBeanException:: otherwise.
SecurityException:: if cause is a SecurityException

com.sun.jmx.mbeanserver back to summary

private Class Introspector.SimpleIntrospector

Class Inheritance

extends Object

java.lang.Object
com.sun.jmx.mbeanserver.Introspector.SimpleIntrospector

A simple introspector that uses reflection to analyze a class and identify its "getter" methods. This class is intended for use only when Java Beans is not present (which implies that there isn't explicit information about the bean available).

Field Summary

Modifier and Type	Field and Description
private static final Map<Class<?>, SoftReference<List<Method>>>	cache
private static final String	GET_METHOD_PREFIX
private static final String	IS_METHOD_PREFIX

Constructor Summary

Access	Constructor and Description
private	SimpleIntrospector()

Method Summary

Modifier and Type	Method and Description
private static List<Method>	getCachedMethods(Class<?> clazz) Returns the list of methods cached for the given class, or `null` if not cached.
pack-priv static Method	getReadMethod(Class<?> clazz, String property) Returns the "getter" to read the given property from the given class or `null` if no method is found.
pack-priv static List<Method>	getReadMethods(Class<?> clazz) Returns the list of "getter" methods for the given class.
pack-priv static boolean	isReadMethod(Method method) Returns `true` if the given method is a "getter" method (where "getter" method is a public method of the form getXXX or "boolean isXXX")

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cache	back to summary
private static final Map<Class<?>, SoftReference<List<Method>>> cache

GET_METHOD_PREFIX	back to summary
private static final String GET_METHOD_PREFIX

IS_METHOD_PREFIX	back to summary
private static final String IS_METHOD_PREFIX

Constructor Detail

SimpleIntrospector	back to summary
private SimpleIntrospector()

Method Detail

getCachedMethods	back to summary
private static List<Method> getCachedMethods(Class<?> clazz) Returns the list of methods cached for the given class, or `null` if not cached.

getReadMethod	back to summary
pack-priv static Method getReadMethod(Class<?> clazz, String property) Returns the "getter" to read the given property from the given class or `null` if no method is found.

getReadMethods	back to summary
pack-priv static List<Method> getReadMethods(Class<?> clazz) Returns the list of "getter" methods for the given class. The list is ordered so that isXXX methods appear before getXXX methods - this is for compatibility with the JavaBeans Introspector.

isReadMethod	back to summary
pack-priv static boolean isReadMethod(Method method) Returns `true` if the given method is a "getter" method (where "getter" method is a public method of the form getXXX or "boolean isXXX")

public Class Introspector

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Introspector.SimpleIntrospector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail