public abstract class JmxUtils extends Object
locateMBeanServer()
Modifier and Type | Field and Description |
---|---|
static String |
IDENTITY_OBJECT_NAME_KEY
The key used when extending an existing
ObjectName with the
identity hash code of its corresponding managed resource. |
Constructor and Description |
---|
JmxUtils() |
Modifier and Type | Method and Description |
---|---|
static ObjectName |
appendIdentityToObjectName(ObjectName objectName,
Object 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 . |
static String |
getAttributeName(PropertyDescriptor property,
boolean useStrictCasing)
Return the JMX attribute name to use for the given JavaBeans property.
|
static Class<?> |
getClassToExpose(Class<?> clazz)
Return the class or interface to expose for the given bean class.
|
static Class<?> |
getClassToExpose(Object managedBean)
Return the class or interface to expose for the given bean.
|
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").
|
static String[] |
getMethodSignature(Method method)
Create a
String[] representing the argument signature of a
method. |
static Class<?> |
getMXBeanInterface(Class<?> clazz)
Return the Java 6 MXBean interface exists for the given class, if any
(that is, an interface whose name ends with "MXBean" and/or
carries an appropriate MXBean annotation).
|
static boolean |
isMBean(Class<?> clazz)
Determine whether the given bean class qualifies as an MBean as-is.
|
static boolean |
isMXBeanSupportAvailable()
Check whether MXBean support is available, i.e.
|
static MBeanServer |
locateMBeanServer()
Attempt to find a locally running
MBeanServer . |
static MBeanServer |
locateMBeanServer(String agentId)
Attempt to find a locally running
MBeanServer . |
static Class[] |
parameterInfoToTypes(MBeanParameterInfo[] paramInfo)
Convert an array of
MBeanParameterInfo into an array of
Class instances corresponding to the parameters. |
static Class[] |
parameterInfoToTypes(MBeanParameterInfo[] paramInfo,
ClassLoader classLoader)
Convert an array of
MBeanParameterInfo into an array of
Class instances corresponding to the parameters. |
public static final String IDENTITY_OBJECT_NAME_KEY
ObjectName
with the
identity hash code of its corresponding managed resource.public static MBeanServer locateMBeanServer() throws MBeanServerNotFoundException
MBeanServer
. Fails if no
MBeanServer
can be found. Logs a warning if more than one
MBeanServer
found, returning the first one from the list.MBeanServer
if foundMBeanServerNotFoundException
- if no MBeanServer
could be foundMBeanServerFactory.findMBeanServer(java.lang.String)
public static MBeanServer locateMBeanServer(String agentId) throws MBeanServerNotFoundException
MBeanServer
. Fails if no
MBeanServer
can be found. Logs a warning if more than one
MBeanServer
found, returning the first one from the list.agentId
- 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.MBeanServer
if foundMBeanServerNotFoundException
- if no MBeanServer
could be foundMBeanServerFactory.findMBeanServer(String)
public static Class[] parameterInfoToTypes(MBeanParameterInfo[] paramInfo) throws ClassNotFoundException
MBeanParameterInfo
into an array of
Class
instances corresponding to the parameters.paramInfo
- the JMX parameter infoClassNotFoundException
- if a parameter type could not be resolvedpublic static Class[] parameterInfoToTypes(MBeanParameterInfo[] paramInfo, ClassLoader classLoader) throws ClassNotFoundException
MBeanParameterInfo
into an array of
Class
instances corresponding to the parameters.paramInfo
- the JMX parameter infoclassLoader
- the ClassLoader to use for loading parameter typesClassNotFoundException
- if a parameter type could not be resolvedpublic static String[] getMethodSignature(Method method)
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 methods signature.method
- the method to build an argument signature forpublic static String getAttributeName(PropertyDescriptor property, boolean useStrictCasing)
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
.
property
- the JavaBeans property descriptoruseStrictCasing
- whether to use strict casingpublic static ObjectName appendIdentityToObjectName(ObjectName objectName, Object managedResource) throws MalformedObjectNameException
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
ObjectNamingStrategy
.objectName
- the original JMX ObjectNamemanagedResource
- the MBean instanceMalformedObjectNameException
- in case of an invalid object name specificationObjectUtils.getIdentityHexString(Object)
public static Class<?> getClassToExpose(Object managedBean)
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).
managedBean
- the bean instance (might be an AOP proxy)ClassUtils.getUserClass(Object)
public static Class<?> getClassToExpose(Class<?> clazz)
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).
clazz
- the bean class (might be an AOP proxy class)ClassUtils.getUserClass(Class)
public static boolean isMBean(Class<?> clazz)
This implementation checks for DynamicMBean
classes as well as classes with corresponding "*MBean" interface
(Standard MBeans) or corresponding "*MXBean" interface (Java 6 MXBeans).
clazz
- the bean class to analyzeMBeanExporter.isMBean(Class)
public static Class<?> getMBeanInterface(Class<?> clazz)
clazz
- the class to checkpublic static Class<?> getMXBeanInterface(Class<?> clazz)
clazz
- the class to checkpublic static boolean isMXBeanSupportAvailable()
true
if available; false
otherwise