| java.lang.Object javax.management.JMX
JMX | public class JMX (Code) | | Static methods from the JMX API. There are no instances of this class.
since: 1.6 |
Method Summary | |
public static boolean | isMXBeanInterface(Class> interfaceClass) Test whether an interface is an MXBean interface.
An interface is an MXBean interface if it is annotated
MXBean @MXBean or
@MXBean(true) or if it does not have an
@MXBean annotation
and its name ends with "
MXBean ".
Parameters: interfaceClass - The candidate interface. | public static T | newMBeanProxy(MBeanServerConnection connection, ObjectName objectName, Class<T> interfaceClass) Make a proxy for a Standard MBean in a local or remote
MBean Server.
If you have an MBean Server
mbs containing an MBean
with
ObjectName
name , and if the MBean's
management interface is described by the Java interface
MyMBean , you can construct a proxy for the MBean like
this:
MyMBean proxy = JMX.newMBeanProxy(mbs, name, MyMBean.class);
Suppose, for example,
MyMBean looks like this:
public interface MyMBean {
public String getSomeAttribute();
public void setSomeAttribute(String value);
public void someOperation(String param1, int param2);
}
Then you can execute:
-
proxy.getSomeAttribute() which will result in a
call to
mbs.
| public static T | newMBeanProxy(MBeanServerConnection connection, ObjectName objectName, Class<T> interfaceClass, boolean notificationBroadcaster) Make a proxy for a Standard MBean in a local or remote MBean
Server that may also support the methods of
NotificationEmitter .
This method behaves the same as
JMX.newMBeanProxy(MBeanServerConnection,ObjectName,Class) , but
additionally, if
notificationBroadcaster is
true , then the MBean is assumed to be a
NotificationBroadcaster or
NotificationEmitter and the
returned proxy will implement
NotificationEmitter as
well as
interfaceClass . | public static T | newMXBeanProxy(MBeanServerConnection connection, ObjectName objectName, Class<T> interfaceClass) Make a proxy for an MXBean in a local or remote
MBean Server.
If you have an MBean Server
mbs containing an
MXBean with
ObjectName
name , and if the
MXBean's management interface is described by the Java
interface
MyMXBean , you can construct a proxy for
the MXBean like this:
MyMXBean proxy = JMX.newMXBeanProxy(mbs, name, MyMXBean.class);
Suppose, for example,
MyMXBean looks like this:
public interface MyMXBean {
public String getSimpleAttribute();
public void setSimpleAttribute(String value);
public
java.lang.management.MemoryUsage getMappedAttribute();
public void setMappedAttribute(MemoryUsage memoryUsage);
public MemoryUsage someOperation(String param1, MemoryUsage param2);
}
Then:
| public static T | newMXBeanProxy(MBeanServerConnection connection, ObjectName objectName, Class<T> interfaceClass, boolean notificationBroadcaster) Make a proxy for an MXBean in a local or remote MBean
Server that may also support the methods of
NotificationEmitter .
This method behaves the same as
JMX.newMXBeanProxy(MBeanServerConnection,ObjectName,Class) , but
additionally, if
notificationBroadcaster is
true , then the MXBean is assumed to be a
NotificationBroadcaster or
NotificationEmitter and the
returned proxy will implement
NotificationEmitter as
well as
interfaceClass . |
isMXBeanInterface | public static boolean isMXBeanInterface(Class> interfaceClass)(Code) | | Test whether an interface is an MXBean interface.
An interface is an MXBean interface if it is annotated
MXBean @MXBean or
@MXBean(true) or if it does not have an
@MXBean annotation
and its name ends with "
MXBean ".
Parameters: interfaceClass - The candidate interface. true if interfaceClass is an interface andmeets the conditions described. throws: NullPointerException - if interfaceClass is null. |
newMBeanProxy | public static T newMBeanProxy(MBeanServerConnection connection, ObjectName objectName, Class<T> interfaceClass)(Code) | | Make a proxy for a Standard MBean in a local or remote
MBean Server.
If you have an MBean Server
mbs containing an MBean
with
ObjectName
name , and if the MBean's
management interface is described by the Java interface
MyMBean , you can construct a proxy for the MBean like
this:
MyMBean proxy = JMX.newMBeanProxy(mbs, name, MyMBean.class);
Suppose, for example,
MyMBean looks like this:
public interface MyMBean {
public String getSomeAttribute();
public void setSomeAttribute(String value);
public void someOperation(String param1, int param2);
}
Then you can execute:
The object returned by this method is a
Proxy whose
InvocationHandler is an
MBeanServerInvocationHandler .
This method is equivalent to
JMX.newMBeanProxy(MBeanServerConnection,ObjectName,Class,boolean) newMBeanProxy(connection, objectName, interfaceClass,false) .
Parameters: connection - the MBean server to forward to. Parameters: objectName - the name of the MBean within connection to forward to. Parameters: interfaceClass - the management interface that the MBeanexports, which will also be implemented by the returned proxy.< Parameters: T - > allows the compiler to know that if the interfaceClass parameter is MyMBean.class , forexample, then the return type is MyMBean . the new proxy instance. |
newMBeanProxy | public static T newMBeanProxy(MBeanServerConnection connection, ObjectName objectName, Class<T> interfaceClass, boolean notificationBroadcaster)(Code) | | Make a proxy for a Standard MBean in a local or remote MBean
Server that may also support the methods of
NotificationEmitter .
This method behaves the same as
JMX.newMBeanProxy(MBeanServerConnection,ObjectName,Class) , but
additionally, if
notificationBroadcaster is
true , then the MBean is assumed to be a
NotificationBroadcaster or
NotificationEmitter and the
returned proxy will implement
NotificationEmitter as
well as
interfaceClass . A call to
NotificationBroadcaster.addNotificationListener on the proxy
will result in a call to
MBeanServerConnection.addNotificationListener(ObjectNameNotificationListenerNotificationFilterObject) , and
likewise for the other methods of
NotificationBroadcaster and
NotificationEmitter .
Parameters: connection - the MBean server to forward to. Parameters: objectName - the name of the MBean within connection to forward to. Parameters: interfaceClass - the management interface that the MBeanexports, which will also be implemented by the returned proxy. Parameters: notificationBroadcaster - make the returned proxyimplement NotificationEmitter by forwarding its methodsvia connection .< Parameters: T - > allows the compiler to know that if the interfaceClass parameter is MyMBean.class , forexample, then the return type is MyMBean . the new proxy instance. |
newMXBeanProxy | public static T newMXBeanProxy(MBeanServerConnection connection, ObjectName objectName, Class<T> interfaceClass)(Code) | | Make a proxy for an MXBean in a local or remote
MBean Server.
If you have an MBean Server
mbs containing an
MXBean with
ObjectName
name , and if the
MXBean's management interface is described by the Java
interface
MyMXBean , you can construct a proxy for
the MXBean like this:
MyMXBean proxy = JMX.newMXBeanProxy(mbs, name, MyMXBean.class);
Suppose, for example,
MyMXBean looks like this:
public interface MyMXBean {
public String getSimpleAttribute();
public void setSimpleAttribute(String value);
public
java.lang.management.MemoryUsage getMappedAttribute();
public void setMappedAttribute(MemoryUsage memoryUsage);
public MemoryUsage someOperation(String param1, MemoryUsage param2);
}
Then:
proxy.getSimpleAttribute() will result in a
call to
mbs. MBeanServerConnection.getAttributegetAttribute (name, "SimpleAttribute") .
proxy.setSimpleAttribute("whatever") will result
in a call to
mbs. MBeanServerConnection.setAttribute setAttribute (name,
new Attribute("SimpleAttribute", "whatever")) .
Because
String is a simple type, in the
sense of
javax.management.openmbean.SimpleType , it
is not changed in the context of an MXBean. The MXBean
proxy behaves the same as a Standard MBean proxy (see
JMX.newMBeanProxy(MBeanServerConnection,ObjectName,Class) newMBeanProxy ) for the attribute
SimpleAttribute .
proxy.getMappedAttribute() will result in a call
to
mbs.getAttribute("MappedAttribute") . The MXBean
mapping rules mean that the actual type of the attribute
MappedAttribute will be
javax.management.openmbean.CompositeData CompositeData and
that is what the
mbs.getAttribute call will return.
The proxy will then convert the
CompositeData back into
the expected type
MemoryUsage using the MXBean mapping
rules.
Similarly,
proxy.setMappedAttribute(memoryUsage) will convert the
MemoryUsage argument into a
CompositeData before calling
mbs.setAttribute .
proxy.someOperation("whatever", memoryUsage) will convert the
MemoryUsage argument into a
CompositeData and call
mbs.invoke . The value returned
by
mbs.invoke will be also be a
CompositeData ,
and the proxy will convert this into the expected type
MemoryUsage using the MXBean mapping rules.
The object returned by this method is a
Proxy whose
InvocationHandler is an
MBeanServerInvocationHandler .
This method is equivalent to
JMX.newMXBeanProxy(MBeanServerConnection,ObjectName,Class,boolean) newMXBeanProxy(connection, objectName, interfaceClass,false) .
Parameters: connection - the MBean server to forward to. Parameters: objectName - the name of the MBean within connection to forward to. Parameters: interfaceClass - the MXBean interface,which will also be implemented by the returned proxy.< Parameters: T - > allows the compiler to know that if the interfaceClass parameter is MyMXBean.class , forexample, then the return type is MyMXBean . the new proxy instance. |
newMXBeanProxy | public static T newMXBeanProxy(MBeanServerConnection connection, ObjectName objectName, Class<T> interfaceClass, boolean notificationBroadcaster)(Code) | | Make a proxy for an MXBean in a local or remote MBean
Server that may also support the methods of
NotificationEmitter .
This method behaves the same as
JMX.newMXBeanProxy(MBeanServerConnection,ObjectName,Class) , but
additionally, if
notificationBroadcaster is
true , then the MXBean is assumed to be a
NotificationBroadcaster or
NotificationEmitter and the
returned proxy will implement
NotificationEmitter as
well as
interfaceClass . A call to
NotificationBroadcaster.addNotificationListener on the proxy
will result in a call to
MBeanServerConnection.addNotificationListener(ObjectNameNotificationListenerNotificationFilterObject) , and
likewise for the other methods of
NotificationBroadcaster and
NotificationEmitter .
Parameters: connection - the MBean server to forward to. Parameters: objectName - the name of the MBean within connection to forward to. Parameters: interfaceClass - the MXBean interface,which will also be implemented by the returned proxy. Parameters: notificationBroadcaster - make the returned proxyimplement NotificationEmitter by forwarding its methodsvia connection .< Parameters: T - > allows the compiler to know that if the interfaceClass parameter is MyMXBean.class , forexample, then the return type is MyMXBean . the new proxy instance. |
|
|