Spring Framework 6.1.4 · org.springframework.jmx.support.JmxUtils

Modifier and Type	Field and Description
public static final String	IDENTITY_OBJECT_NAME_KEY The key used when extending an existing `ObjectName` with the identity hash code of its corresponding managed resource.
private static final Log	logger
private static final String	MBEAN_SUFFIX Suffix used to identify an MBean interface.

Access	Constructor and Description
public	JmxUtils()

Method Summary

Modifier and Type	Method and Description
public static ObjectName	Returns: an ObjectName with the MBean identity added appendIdentityToObjectName(ObjectName the original JMX ObjectName objectName, Object the MBean instance managedResource) Append an additional key/value pair to an existing `ObjectName` with the key being the static value `identity` and the value being the identity hash code of the managed resource being exposed on the supplied `ObjectName`.
public static String	Returns: the JMX attribute name to use getAttributeName(PropertyDescriptor the JavaBeans property descriptor property, boolean whether to use strict casing useStrictCasing) Return the JMX attribute name to use for the given JavaBeans property.
public static Class<?>	Returns: the bean class to expose getClassToExpose(Object the bean instance (might be an AOP proxy) managedBean) Return the class or interface to expose for the given bean.
public static Class<?>	Returns: the bean class to expose getClassToExpose(Class<?> the bean class (might be an AOP proxy class) clazz) Return the class or interface to expose for the given bean class.
public static Class<?>	Returns: the Standard MBean interface for the given class getMBeanInterface(Class<?> the class to check clazz) Return the Standard MBean interface for the given class, if any (that is, an interface whose name matches the class name of the given class but with suffix "MBean").
public static String[]	Returns: the signature as array of argument types getMethodSignature(Method the method to build an argument signature for method) Create a `String[]` representing the argument signature of a method.
public static Class<?>	Returns: whether there is an MXBean interface for the given class getMXBeanInterface(Class<?> the class to check clazz) Return the Java MXBean interface for the given class, if any (that is, an interface whose name ends with "MXBean" and/or carries an appropriate MXBean annotation).
public static boolean	Returns: whether the class qualifies as an MBean isMBean(Class<?> the bean class to analyze clazz) Determine whether the given bean class qualifies as an MBean as-is.
public static MBeanServer	Returns: the `MBeanServer` if found locateMBeanServer() Attempt to find a locally running `MBeanServer`.
public static MBeanServer	Returns: the `MBeanServer` if found locateMBeanServer(String the agent identifier of the MBeanServer to retrieve. If this parameter is `null`, all registered MBeanServers are considered. If the empty String is given, the platform MBeanServer will be returned. agentId) Attempt to find a locally running `MBeanServer`.
public static Class<?>[]	Returns: the parameter types as classes parameterInfoToTypes(MBeanParameterInfo[] the JMX parameter info paramInfo) Convert an array of `MBeanParameterInfo` into an array of `Class` instances corresponding to the parameters.
public static Class<?>[]	Returns: the parameter types as classes parameterInfoToTypes(MBeanParameterInfo[] the JMX parameter info paramInfo, ClassLoader the ClassLoader to use for loading parameter types classLoader) Convert an array of `MBeanParameterInfo` into an array of `Class` instances corresponding to the parameters.

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

IDENTITY_OBJECT_NAME_KEY	back to summary
public static final String IDENTITY_OBJECT_NAME_KEY The key used when extending an existing `ObjectName` with the identity hash code of its corresponding managed resource.

logger	back to summary
private static final Log logger

MBEAN_SUFFIX	back to summary
private static final String MBEAN_SUFFIX Suffix used to identify an MBean interface.

JmxUtils	back to summary
public JmxUtils()

Method Detail

appendIdentityToObjectName back to summary

appendIdentityToObjectName	back to summary
public static ObjectName appendIdentityToObjectName(ObjectName objectName, Object managedResource) throws MalformedObjectNameException Append an additional key/value pair to an existing `ObjectName` with the key being the static value `identity` and the value being the identity hash code of the managed resource being exposed on the supplied `ObjectName`. This can be used to provide a unique `ObjectName` for each distinct instance of a particular bean or class. Useful when generating `ObjectNames` at runtime for a set of managed resources based on the template value supplied by a `org.springframework.jmx.export.naming.ObjectNamingStrategy`. Parameters objectName:ObjectName the original JMX ObjectName managedResource:Object the MBean instance Returns:ObjectName an ObjectName with the MBean identity added Exceptions MalformedObjectNameException: in case of an invalid object name specification See Also `org.springframework.util.ObjectUtils#getIdentityHexString(Object)`

public static ObjectName appendIdentityToObjectName(ObjectName objectName, Object managedResource) throws MalformedObjectNameException

Append an additional key/value pair to an existing ObjectName with the key being the static value identity and the value being the identity hash code of the managed resource being exposed on the supplied ObjectName. This can be used to provide a unique ObjectName for each distinct instance of a particular bean or class. Useful when generating ObjectNames at runtime for a set of managed resources based on the template value supplied by a org.springframework.jmx.export.naming.ObjectNamingStrategy.

Parameters

objectName:ObjectName: the original JMX ObjectName
managedResource:Object: the MBean instance

Returns:ObjectName

an ObjectName with the MBean identity added

Exceptions

MalformedObjectNameException:: in case of an invalid object name specification

getAttributeName back to summary

getAttributeName	back to summary
public static String getAttributeName(PropertyDescriptor property, boolean useStrictCasing) Return the JMX attribute name to use for the given JavaBeans property. When using strict casing, a JavaBean property with a getter method such as `getFoo()` translates to an attribute called `Foo`. With strict casing disabled, `getFoo()` would translate to just `foo`. Parameters property:PropertyDescriptor the JavaBeans property descriptor useStrictCasing:boolean whether to use strict casing Returns:String the JMX attribute name to use

public static String getAttributeName(PropertyDescriptor property, boolean useStrictCasing)

Return the JMX attribute name to use for the given JavaBeans property.

When using strict casing, a JavaBean property with a getter method such as getFoo() translates to an attribute called Foo. With strict casing disabled, getFoo() would translate to just foo.

Parameters

property:PropertyDescriptor: the JavaBeans property descriptor
useStrictCasing:boolean: whether to use strict casing

Returns:String

the JMX attribute name to use

getClassToExpose back to summary

getClassToExpose	back to summary
public static Class<?> getClassToExpose(Object managedBean) Return the class or interface to expose for the given bean. This is the class that will be searched for attributes and operations (for example, checked for annotations). This implementation returns the superclass for a CGLIB proxy and the class of the given bean else (for a JDK proxy or a plain bean class). Parameters managedBean:Object the bean instance (might be an AOP proxy) Returns:Class<?> the bean class to expose See Also `org.springframework.util.ClassUtils#getUserClass(Object)`

public static Class<?> getClassToExpose(Object managedBean)

Return the class or interface to expose for the given bean. This is the class that will be searched for attributes and operations (for example, checked for annotations).

This implementation returns the superclass for a CGLIB proxy and the class of the given bean else (for a JDK proxy or a plain bean class).

Parameters

managedBean:Object: the bean instance (might be an AOP proxy)

Returns:Class<?>

the bean class to expose

getClassToExpose back to summary

getClassToExpose	back to summary
public static Class<?> getClassToExpose(Class<?> clazz) Return the class or interface to expose for the given bean class. This is the class that will be searched for attributes and operations (for example, checked for annotations). This implementation returns the superclass for a CGLIB proxy and the class of the given bean else (for a JDK proxy or a plain bean class). Parameters clazz:Class<?> the bean class (might be an AOP proxy class) Returns:Class<?> the bean class to expose See Also `org.springframework.util.ClassUtils#getUserClass(Class)`

public static Class<?> getClassToExpose(Class<?> clazz)

Return the class or interface to expose for the given bean class. This is the class that will be searched for attributes and operations (for example, checked for annotations).

This implementation returns the superclass for a CGLIB proxy and the class of the given bean else (for a JDK proxy or a plain bean class).

Parameters

clazz:Class<?>: the bean class (might be an AOP proxy class)

Returns:Class<?>

the bean class to expose

getMBeanInterface	back to summary
public static Class<?> getMBeanInterface(Class<?> clazz) Return the Standard MBean interface for the given class, if any (that is, an interface whose name matches the class name of the given class but with suffix "MBean"). Parameters clazz:Class<?> the class to check Returns:Class<?> the Standard MBean interface for the given class Annotations @Nullable

getMBeanInterface

back to summary

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

Return the Standard MBean interface for the given class, if any (that is, an interface whose name matches the class name of the given class but with suffix "MBean").

Parameters

clazz:Class<?>: the class to check

Returns:Class<?>

the Standard MBean interface for the given class

Annotations

@Nullable

getMethodSignature back to summary

getMethodSignature	back to summary
public static String[] getMethodSignature(Method method) Create a `String[]` representing the argument signature of a method. Each element in the array is the fully qualified class name of the corresponding argument in the method's signature. Parameters method:Method the method to build an argument signature for Returns:String[] the signature as array of argument types

public static String[] getMethodSignature(Method method)

Create a String[] representing the argument signature of a method. Each element in the array is the fully qualified class name of the corresponding argument in the method's signature.

Parameters

method:Method: the method to build an argument signature for

Returns:String[]

the signature as array of argument types

getMXBeanInterface	back to summary
public static Class<?> getMXBeanInterface(Class<?> clazz) Return the Java MXBean interface for the given class, if any (that is, an interface whose name ends with "MXBean" and/or carries an appropriate MXBean annotation). Parameters clazz:Class<?> the class to check Returns:Class<?> whether there is an MXBean interface for the given class Annotations @Nullable

getMXBeanInterface

back to summary

public static Class<?> getMXBeanInterface(Class<?> clazz)

Return the Java MXBean interface for the given class, if any (that is, an interface whose name ends with "MXBean" and/or carries an appropriate MXBean annotation).

Parameters

clazz:Class<?>: the class to check

Returns:Class<?>

whether there is an MXBean interface for the given class

Annotations

@Nullable

isMBean back to summary

isMBean	back to summary
public static boolean isMBean(Class<?> clazz) Determine whether the given bean class qualifies as an MBean as-is. This implementation checks for `javax.management.DynamicMBean` classes as well as classes with corresponding "MBean" interface (Standard MBeans) or corresponding "MXBean" interface (Java MXBeans). Parameters clazz:Class<?> the bean class to analyze Returns:boolean whether the class qualifies as an MBean See Also `org.springframework.jmx.export.MBeanExporter#isMBean(Class)`

public static boolean isMBean(Class<?> clazz)

Determine whether the given bean class qualifies as an MBean as-is.

This implementation checks for javax.management.DynamicMBean classes as well as classes with corresponding "*MBean" interface (Standard MBeans) or corresponding "*MXBean" interface (Java MXBeans).

Parameters

clazz:Class<?>: the bean class to analyze

Returns:boolean

whether the class qualifies as an MBean

locateMBeanServer back to summary

locateMBeanServer	back to summary
public static MBeanServer locateMBeanServer() throws MBeanServerNotFoundException Attempt to find a locally running `MBeanServer`. Fails if no `MBeanServer` can be found. Logs a warning if more than one `MBeanServer` found, returning the first one from the list. Returns:MBeanServer the `MBeanServer` if found Exceptions MBeanServerNotFoundException: if no `MBeanServer` could be found See Also `javax.management.MBeanServerFactory#findMBeanServer`

public static MBeanServer locateMBeanServer() throws MBeanServerNotFoundException

Attempt to find a locally running MBeanServer. Fails if no MBeanServer can be found. Logs a warning if more than one MBeanServer found, returning the first one from the list.

Returns:MBeanServer

the MBeanServer if found

Exceptions

MBeanServerNotFoundException:: if no MBeanServer could be found

locateMBeanServer back to summary

locateMBeanServer	back to summary
public static MBeanServer locateMBeanServer(String agentId) throws MBeanServerNotFoundException Attempt to find a locally running `MBeanServer`. Fails if no `MBeanServer` can be found. Logs a warning if more than one `MBeanServer` found, returning the first one from the list. Parameters agentId:String the agent identifier of the MBeanServer to retrieve. If this parameter is `null`, all registered MBeanServers are considered. If the empty String is given, the platform MBeanServer will be returned. Returns:MBeanServer the `MBeanServer` if found Exceptions MBeanServerNotFoundException: if no `MBeanServer` could be found See Also `javax.management.MBeanServerFactory#findMBeanServer(String)`

public static MBeanServer locateMBeanServer(String agentId) throws MBeanServerNotFoundException

Attempt to find a locally running MBeanServer. Fails if no MBeanServer can be found. Logs a warning if more than one MBeanServer found, returning the first one from the list.

Parameters

agentId:String: the agent identifier of the MBeanServer to retrieve. If this parameter is null, all registered MBeanServers are considered. If the empty String is given, the platform MBeanServer will be returned.

Returns:MBeanServer

the MBeanServer if found

Exceptions

MBeanServerNotFoundException:: if no MBeanServer could be found

parameterInfoToTypes back to summary

parameterInfoToTypes	back to summary
public static Class<?>[] parameterInfoToTypes(MBeanParameterInfo[] paramInfo) throws ClassNotFoundException Convert an array of `MBeanParameterInfo` into an array of `Class` instances corresponding to the parameters. Parameters paramInfo:MBeanParameterInfo[] the JMX parameter info Returns:Class<?>[] the parameter types as classes Annotations @Nullable Exceptions ClassNotFoundException: if a parameter type could not be resolved

public static Class<?>[] parameterInfoToTypes(MBeanParameterInfo[] paramInfo) throws ClassNotFoundException

Convert an array of MBeanParameterInfo into an array of Class instances corresponding to the parameters.

Parameters

paramInfo:MBeanParameterInfo[]: the JMX parameter info

Returns:Class<?>[]

the parameter types as classes

Annotations

@Nullable

Exceptions

ClassNotFoundException:: if a parameter type could not be resolved

parameterInfoToTypes back to summary

parameterInfoToTypes	back to summary
public static Class<?>[] parameterInfoToTypes(MBeanParameterInfo[] paramInfo, ClassLoader classLoader) throws ClassNotFoundException Convert an array of `MBeanParameterInfo` into an array of `Class` instances corresponding to the parameters. Parameters paramInfo:MBeanParameterInfo[] the JMX parameter info classLoader:ClassLoader the ClassLoader to use for loading parameter types Returns:Class<?>[] the parameter types as classes Annotations @Nullable Exceptions ClassNotFoundException: if a parameter type could not be resolved

public static Class<?>[] parameterInfoToTypes(MBeanParameterInfo[] paramInfo, ClassLoader classLoader) throws ClassNotFoundException

Convert an array of MBeanParameterInfo into an array of Class instances corresponding to the parameters.

Parameters

paramInfo:MBeanParameterInfo[]: the JMX parameter info
classLoader:ClassLoader: the ClassLoader to use for loading parameter types

Returns:Class<?>[]

the parameter types as classes

Annotations

@Nullable

Exceptions

ClassNotFoundException:: if a parameter type could not be resolved

public abstract Class JmxUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail