org.ops4j.pax.radman.jmx
Interface JMXServer

public interface JMXServer

JMXServer represents the JMX Agent (comprising an MBeanServer and a JMX Connector) Convention:

• JMXServer must be registered to OSGi as a service.

Since:

0.1.0

Author:

Gavin Bong

Field Summary

static java.lang.String	SERVER_AUTHENTICATOR_PID SERVER_AUTHENTICATOR_PID is the configuration key describing which MBeanServerAuthenticator registered OSGi service to be used as mbean server authenticator.
static java.lang.String	SERVER_FORWARDER_PID SERVER_FORWARDER_PID is the configuration key describing which MBeanServerForwarder registered OSGi service to be used as the mbean server forwarder.
static java.lang.String	SERVER_HOST_IP SERVER_HOST_IP is the configuration key of which jmx server ip address that this JMXServer represent.
static java.lang.String	SERVER_INSTANCE SERVER_INSANCE is the configuration key to uniquely identified jmx server.
static java.lang.String	SERVER_NAMESPACE SERVER_NAMESPACE is the configuration key describing this JMXServer namespace.
static java.lang.String	SERVER_PORT SERVER_PORT is the configuration key of which jmx server port that this JMXServer connects to.

Method Summary

java.lang.String	getJMXServerId() Returns the server id.
void	registerMBean(javax.management.DynamicMBean mBean, java.lang.String objectName) Register the manage bean service.
void	unregisterMBean(java.lang.String objectName) Deregisters an MBean from this MBeanServer

Field Detail

SERVER_HOST_IP

static final java.lang.String SERVER_HOST_IP

SERVER_HOST_IP is the configuration key of which jmx server ip address that this JMXServer represent.

This configuration must not be null.

Since:

0.1.0

See Also:

Constant Field Values

SERVER_PORT

static final java.lang.String SERVER_PORT

SERVER_PORT is the configuration key of which jmx server port that this JMXServer connects to.

This configuration value must not be null and must be an integer value.

Since:

0.1.0

See Also:

Constant Field Values

SERVER_NAMESPACE

static final java.lang.String SERVER_NAMESPACE

SERVER_NAMESPACE is the configuration key describing this JMXServer namespace.

This configuration must not be null.

Since:

0.1.0

See Also:

Constant Field Values

SERVER_INSTANCE

static final java.lang.String SERVER_INSTANCE

SERVER_INSANCE is the configuration key to uniquely identified jmx server.

This configuration must not be null.

Since:

0.1.0

See Also:

Constant Field Values

SERVER_AUTHENTICATOR_PID

static final java.lang.String SERVER_AUTHENTICATOR_PID

SERVER_AUTHENTICATOR_PID is the configuration key describing which MBeanServerAuthenticator registered OSGi service to be used as mbean server authenticator.

Please note that:

• This configuration is optional; and
• The cardinality between JMXServer and JMXAuthenticator instances are many to many.

Since:

0.2.0

See Also:

JMXAuthenticator, JMX Authentication and Authorization, Constant Field Values

SERVER_FORWARDER_PID

static final java.lang.String SERVER_FORWARDER_PID

SERVER_FORWARDER_PID is the configuration key describing which MBeanServerForwarder registered OSGi service to be used as the mbean server forwarder.

Please note that:

• This configuration is optional; and
• The cardinality between JMXServer and MBeanServerForwarder instance is one to one.

Since:

0.2.0

See Also:

MBeanServerForwarder, JMX Authentication and Authorization, Constant Field Values

Method Detail

getJMXServerId

java.lang.String getJMXServerId()

Returns the server id.

Returns:

The server id.

Since:

0.1.0

registerMBean

void registerMBean(javax.management.DynamicMBean mBean,
                   java.lang.String objectName)
                   throws java.lang.IllegalArgumentException,
                          javax.management.JMException

Register the manage bean service.

Parameters:

mBean - The mBean to register. This argument must not be null.

objectName - The object name. This argument must not be null.

Throws:

java.lang.IllegalArgumentException - Thrown if one or both arguments are null.

javax.management.JMException - Thrown if registering mBean fails.

Since:

0.1.0

unregisterMBean

void unregisterMBean(java.lang.String objectName)
                     throws java.lang.IllegalArgumentException,
                            javax.management.JMException

Deregisters an MBean from this MBeanServer

Parameters:

objectName - identifies an MBean & conforms to the format accepted by ObjectName

Throws:

java.lang.IllegalArgumentException - Thrown if the specified objectName argument must not be null.

javax.management.JMException - Thrown if unregister fails.

Since:

0.1.0