net.java.truevfs.comp.jmx

Class JmxMediator<This extends JmxMediator<This>>

java.lang.Object

net.java.truevfs.comp.inst.Mediator<This>

net.java.truevfs.comp.jmx.JmxMediator<This>

Type Parameters:

This - the type of this mediator.

@Immutable
public abstract class JmxMediator<This extends JmxMediator<This>>
extends Mediator<This>

A mediator for the instrumentation of the TrueVFS Kernel with JMX.

Author:

Christian Schlichtherle

Constructor Summary

Constructors

Constructor and Description
JmxMediator()

Method Summary

Modifier and Type	Method and Description
<C extends JmxComponent> C	activate(C component) Activates and returns the given component.
boolean	deregister(ObjectName name) Removes any MBean with the given object name in the configured MBean server.
Package	getDomain() Returns the package object who's name should be used as the domain of any object names to register.
MBeanServer	getMBeanServer() Returns the MBean server for registering the MBeans.
net.java.truecommons.jmx.ObjectNameBuilder	nameBuilder(Class<?> type) Returns a new object name builder.
boolean	register(ObjectName name, Object mbean) Maps the given object name to the given mbean in the MBean server.

Methods inherited from class net.java.truevfs.comp.inst.Mediator

instrument, instrument, instrument, instrument, instrument, instrument, instrument, instrument, instrument, instrument, instrument, instrument, instrument, instrument, instrument

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxMediator

public JmxMediator()

Method Detail

activate

public <C extends JmxComponent> C activate(C component)

Activates and returns the given component.

Type Parameters:

C - the type of the component to activate.

Parameters:

component - the component to activate.

Returns:

The activated component.

deregister

public boolean deregister(ObjectName name)

Removes any MBean with the given object name in the configured MBean server.

The implementation in the class JmxMediator logs error messages at the warn and trace level when the deregistration fails with an InstanceNotFoundException.

Parameters:

name - the object name.

Returns:

true if any MBean has been successfully removed with the given name. false if no MBean was registered with the given name.

Throws:

IllegalArgumentException - if removing an MBean failed with an JMException.

getDomain

public Package getDomain()

Returns the package object who's name should be used as the domain of any object names to register.

getMBeanServer

public MBeanServer getMBeanServer()

Returns the MBean server for registering the MBeans.

The implementation in the class JmxMediator returns MBeanServerLocator.SINGLETON.get().

Returns:

the MBean server for registering the MBeans.

nameBuilder

public net.java.truecommons.jmx.ObjectNameBuilder nameBuilder(Class<?> type)

Returns a new object name builder.

Parameters:

type - the class identifying the type of the MBean who's name shall get build.

register

public boolean register(@CheckForNull
                        ObjectName name,
                        Object mbean)

Maps the given object name to the given mbean in the MBean server.

The implementation in the class JmxMediator logs error messages at the warn and trace level when the registration fails with an InstanceAlreadyExistsException.

Parameters:

name - the object name.

mbean - the MBean.

Returns:

true if the MBean has been successfully registered with the given name. false if any MBean was already registered with the given name.

Throws:

IllegalArgumentException - if registering the MBean failed with an JMException.