org.apache.synapse

Class JmxAdapter

java.lang.Object

org.apache.synapse.JmxAdapter

public class JmxAdapter
extends Object

JMX Adaptor class providing a JMX server connector to be able to query MBeans via JConsole or any other JMX-compatible management solution.
The provided JNDI port will be used to create a local RMI registry. If no RMI port will be provided dynamic RMI ports will be used for remote MBean queries.
If the JMXAdaptor shall be used in a firewalled environment, additionally a fixed RMI port should be provided and both ports should be opened in the firewall.
JMX URL used if only JNDI port is provided:
service:jmx:rmi:///jndi/rmi://:/synapse
JMX URL used if JNDI port and RMI port are provided:
service:jmx:rmi://:/jndi/rmi://:/synapse

Constructor Summary

Constructors

Constructor and Description
JmxAdapter(JmxInformation jmxInformation) Creates a new instance of a JMX Adaptor using the provided JMX information.

Method Summary

Modifier and Type	Method and Description
JmxInformation	getJmxInformation()
boolean	isRunning() Determines whether the JMX Connector server has been started and is running.
void	setJmxInformation(JmxInformation jmxInformation)
void	start() Lazily creates the RMI registry and starts the JMX connector server based on the
void	stop() Stops the JMX connector server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JmxAdapter

public JmxAdapter(JmxInformation jmxInformation)

Creates a new instance of a JMX Adaptor using the provided JMX information.

Parameters:

jmxInformation - any JMX related information

Method Detail

start

public void start()

Lazily creates the RMI registry and starts the JMX connector server based on the

Throws:

SynapseException - if the JMX configuration is erroneous and/or the connector server cannot be started

stop

public void stop()

Stops the JMX connector server.

isRunning

public boolean isRunning()

Determines whether the JMX Connector server has been started and is running.

Returns:

true, if the connector server is running, otherwise false

getJmxInformation

public JmxInformation getJmxInformation()

setJmxInformation

public void setJmxInformation(JmxInformation jmxInformation)