Package org.jivesoftware.openfire

Class JMXManager

java.lang.Object

org.jivesoftware.openfire.JMXManager

public class JMXManager
extends Object

Manages the JMX configuration for Openfire.

Author:

Tom Evans

Field Summary

Fields

Modifier and Type	Field	Description
static SystemProperty<Boolean>	XMPP_JMX_ENABLED	Enables / disables JMX support in Openfire.
static SystemProperty<Integer>	XMPP_JMX_PORT	Defines the TCP port number for the JMX connector.
static SystemProperty<Boolean>	XMPP_JMX_SECURE	Controls if the JMX connector is configured to require Openfire admin credentials.

Constructor Summary

Constructors

Constructor	Description
JMXManager()

Method Summary

Modifier and Type	Method	Description
org.eclipse.jetty.jmx.MBeanContainer	getContainer()
static JMXManager	getInstance()
static int	getPort()	Returns the port number for the JMX connector.
static boolean	isEnabled()	Returns true if JMX support is enabled.
static boolean	isSecure()	Returns true if the JMX connector is configured to require Openfire admin credentials.
void	setContainer(org.eclipse.jetty.jmx.MBeanContainer mbContainer)
static void	setEnabled(boolean enabled)
static void	setPort(int port)
static void	setSecure(boolean secure)
static ObjectName	tryRegister(Object mbean, String name)	Registers a MBean in the platform MBean server, replacing any MBean that might have been registered earlier using the same object name.
static void	tryRegister(Object mbean, ObjectName objectName)	Registers a MBean in the platform MBean server, replacing any MBean that might have been registered earlier using the same object name.
static void	tryUnregister(String name)	Unregisters a MBean from the platform MBean server.
static void	tryUnregister(ObjectName objectName)	Unregisters a MBean from the platform MBean server.

Methods inherited from class java.lang.Object

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

Field Detail

XMPP_JMX_ENABLED

public static final SystemProperty<Boolean> XMPP_JMX_ENABLED

Enables / disables JMX support in Openfire. This option can be configured via the admin console or by setting the following system property:

    xmpp.jmx.enabled=true (default: false)
 

XMPP_JMX_SECURE

public static final SystemProperty<Boolean> XMPP_JMX_SECURE

Controls if the JMX connector is configured to require Openfire admin credentials. This option can be configured via the admin console or by setting the following system property:

    xmpp.jmx.secure=false (default: true)
 

XMPP_JMX_PORT

public static final SystemProperty<Integer> XMPP_JMX_PORT

Defines the TCP port number for the JMX connector. This option can be configured via the admin console or by setting the following system property:

    xmpp.jmx.port=[port] (default: 1099)
 

Constructor Detail

JMXManager

public JMXManager()

Method Detail

isSecure

public static boolean isSecure()

Returns true if the JMX connector is configured to require Openfire admin credentials. This option can be configured via the admin console or by setting the following system property:

    xmpp.jmx.secure=false (default: true)
 

Returns:

true if the JMX connector requires authentication

setSecure

public static void setSecure(boolean secure)

getPort

public static int getPort()

Returns the port number for the JMX connector. This option can be configured via the admin console or by setting the following system property:

    xmpp.jmx.port=[port] (default: 1099)
 

Returns:

Port number for the JMX connector

setPort

public static void setPort(int port)

isEnabled

public static boolean isEnabled()

Returns true if JMX support is enabled. This option can be configured via the admin console or by setting the following system property:

    xmpp.jmx.enabled=true (default: false)
 

Returns:

true if JMX support is enabled

setEnabled

public static void setEnabled(boolean enabled)

getInstance

public static JMXManager getInstance()

getContainer

public org.eclipse.jetty.jmx.MBeanContainer getContainer()

setContainer

public void setContainer(org.eclipse.jetty.jmx.MBeanContainer mbContainer)

tryRegister

public static ObjectName tryRegister(@Nonnull
                                     Object mbean,
                                     @Nonnull
                                     String name)

Registers a MBean in the platform MBean server, replacing any MBean that might have been registered earlier using the same object name. This method will log but otherwise ignore any exception that is thrown when registrating the bean.

Parameters:

mbean - The bean to register

name - The identifier to register the bean under.

Returns:

the ObjectName instance used the register the bean.

tryRegister

public static void tryRegister(@Nonnull
                               Object mbean,
                               @Nonnull
                               ObjectName objectName)

Registers a MBean in the platform MBean server, replacing any MBean that might have been registered earlier using the same object name. This method will log but otherwise ignore any exception that is thrown when registrating the bean.

Parameters:

mbean - The bean to register

objectName - The identifier to register the bean under.

tryUnregister

public static void tryUnregister(@Nonnull
                                 String name)

Unregisters a MBean from the platform MBean server. This method will log but otherwise ignore any exception that is thrown when unregistering the bean.

Parameters:

name - The identifier that was used to register the bean under.

tryUnregister

public static void tryUnregister(@Nonnull
                                 ObjectName objectName)

Unregisters a MBean from the platform MBean server. This method will log but otherwise ignore any exception that is thrown when unregistering the bean.

Parameters:

objectName - The identifier that was used to register the bean under.