org.jolokia.backend.plugin

Interface MBeanPluginContext

All Superinterfaces:

MBeanServerExecutor

public interface MBeanPluginContext
extends MBeanServerExecutor

A MBeanPlugin's context for accessing JMX with all known MBeanServers. Also it allows to register on MBeans for offering own functionality.

Since:

12/01/15

Author:

roland

Nested Class Summary

Nested classes/interfaces inherited from interface org.jolokia.backend.executor.MBeanServerExecutor

MBeanServerExecutor.MBeanAction<R>, MBeanServerExecutor.MBeanEachCallback

Method Summary

Modifier and Type	Method and Description
ObjectName	registerMBean(Object pMBean, String... pOptionalName) Register a MBean under a certain name to the platform MBeanServer.

Methods inherited from interface org.jolokia.backend.executor.MBeanServerExecutor

call, each, hasMBeansListChangedSince, queryNames

Method Detail

registerMBean

ObjectName registerMBean(Object pMBean,
                         String... pOptionalName)
                  throws MalformedObjectNameException,
                         NotCompliantMBeanException,
                         InstanceAlreadyExistsException

Register a MBean under a certain name to the platform MBeanServer. No neeed to unregister, the MBean will be automatically unregistered when shutting down the agent. It is recommended to use the domain jolokia and a type type=plugin when registering MBeans.

Parameters:

pMBean - MBean to register

pOptionalName - optional name under which the bean should be registered. If not provided, it depends on whether the MBean to register implements MBeanRegistration or not.

Returns:

the name under which the MBean is registered.

Throws:

MalformedObjectNameException

NotCompliantMBeanException

InstanceAlreadyExistsException