org.apache.aries.jmx.agent

Interface JMXAgent

All Known Implementing Classes:

JMXAgentImpl

public interface JMXAgent

This JMXAgent class represent agent for MBeanServers registered in ServiceRegistry. It's responsible for registration and unregistration MBeans with available MBeanServers.

Version:

$Rev: 1341868 $ $Date: 2012-05-23 10:06:29 -0400 (Wed, 23 May 2012) $

Method Summary

Methods

Modifier and Type	Method and Description
JMXAgentContext	getAgentContext() Gets JMXAgentContext @see JMXAgentContext.
ExecutorService	getRegistrationExecutor() Gets registration ExecutorService.
void	registerMBean(MBeanHandler mBeanHandler) Registers MBean with all available MBeanServers.
void	registerMBeans(MBeanServer server) Registers MBeans with provided MBeanServer.
void	setAgentContext(JMXAgentContext agentContext) Sets JMXAgentContext for this agent.
void	start() This method starts JMX agent.
void	stop() Stops JMXAgent.
void	unregisterMBean(MBeanHandler mBeanHandler) Unregisters MBean with all available MBeanServers.
void	unregisterMBean(String name) Deprecated.
void	unregisterMBeans(MBeanServer server) Unregisters MBeans with provided MBeanServer.

Method Detail

start

void start()

This method starts JMX agent. Creates and starting all MBean Handlers and MBeanServiceTracker.

registerMBeans

void registerMBeans(MBeanServer server)

Registers MBeans with provided MBeanServer.

Parameters:

server - MBeanServer with which MBeans are going to be registered

unregisterMBeans

void unregisterMBeans(MBeanServer server)

Unregisters MBeans with provided MBeanServer.

Parameters:

server - MBeanServer with which MBeans are going to be unregistered.

registerMBean

void registerMBean(MBeanHandler mBeanHandler)

Registers MBean with all available MBeanServers.

Parameters:

mBeanHandler - handler which contains MBean info.

unregisterMBean

void unregisterMBean(MBeanHandler mBeanHandler)

Unregisters MBean with all available MBeanServers.

Parameters:

mBeanHandler - handler which contains MBean info.

unregisterMBean

void unregisterMBean(String name)

Deprecated.

Unregisters MBean with all available MBeanServers.

Parameters:

name - of MBean to be unregistered.

stop

void stop()

Stops JMXAgent. This method stops MBeanServiceTracker and all MBean handlers.

getAgentContext

JMXAgentContext getAgentContext()

Gets JMXAgentContext @see JMXAgentContext.

Returns:

JMXAgentContext instance.

setAgentContext

void setAgentContext(JMXAgentContext agentContext)

Sets JMXAgentContext for this agent.

Parameters:

agentContext - JMXAgentContext instance created for this agent.

getRegistrationExecutor

ExecutorService getRegistrationExecutor()

Gets registration ExecutorService.

Returns:

registration executor.