com.kdgregory.logging.aws.internal

Class AbstractJMXManager

java.lang.Object

com.kdgregory.logging.aws.internal.AbstractJMXManager

public abstract class AbstractJMXManager
extends Object

This class manages the relationships between the writer statistics beans and the JMX server(s) where they should be registered. Servers and beans may be added or removed in any order; this class ensures that beans will be registered with any new servers, and any new beans will be registered with all existing servers.

This works by using a "marker bean" that is registered with an MBean server and also with the singleton instance of this class. Statistics beans are added to the singleton instance by their appender. Either type of addition is a trigger to ensure that the statistics beans are registered with all known servers.

The object name used to register the marker bean is retained, and used as the base for the object name(s) used to register the statistics bean(s): the stats bean name will append ",appender=X", where X is the appender name.

Subclasses are expected to manage the singleton instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected InternalLogger	logger
protected Map<MBeanServer,String>	registrationNames
protected Map<Object,List<MBeanServer>>	registrations
protected Map<String,AbstractWriterStatistics>	statsBeans
protected Map<String,Class<?>>	statsBeanTypes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJMXManager(InternalLogger logger)

Method Summary

Modifier and Type	Method and Description
void	addMarkerBean(Object bean, MBeanServer server, ObjectName registrationName) Adds relationship between a marker bean and an MBeanServer.
void	addStatsBean(String appenderName, AbstractWriterStatistics statsBean, Class<?> statsBeanClass) Adds a writer's statsbean and its class to the internal tracking tables.
protected void	registerAppenderBean(String appenderName, MBeanServer mbeanServer) Registers an appender's stats bean with a server.
void	removeMarkerBean(Object bean) Will deregister a StatisticsMBean instance from all known servers.
void	removeStatsBean(String appenderName) Removes information about a stats bean from the internal tables and deregisters it from any MBeanServers.
protected void	unregisterAppenderBean(String appenderName, MBeanServer mbeanServer) Deregisters an appender's stats bean from a server.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected InternalLogger logger

registrations

protected Map<Object,List<MBeanServer>> registrations

registrationNames

protected Map<MBeanServer,String> registrationNames

statsBeans

protected Map<String,AbstractWriterStatistics> statsBeans

statsBeanTypes

protected Map<String,Class<?>> statsBeanTypes

Constructor Detail

AbstractJMXManager

protected AbstractJMXManager(InternalLogger logger)

Method Detail

addMarkerBean

public void addMarkerBean(Object bean,
                          MBeanServer server,
                          ObjectName registrationName)

Adds relationship between a marker bean and an MBeanServer. If any writer beans are known, they will be registered with the server at this time.

Attempting to add the same bean/server more than once is silently ignored (it should never happen in the real world, so does not rate a check).

removeMarkerBean

public void removeMarkerBean(Object bean)

Will deregister a StatisticsMBean instance from all known servers.

addStatsBean

public void addStatsBean(String appenderName,
                         AbstractWriterStatistics statsBean,
                         Class<?> statsBeanClass)

Adds a writer's statsbean and its class to the internal tracking tables. If there are known StatisticsMBean/MBeanServer associations, the stats bean will also be registered with those servers.

These tables are managed by appender name. Calling with the same name and same appender bean is silently ignored. Calling with the same name but a different appender bean is an error. In the real world, neither of these cases should happen, because the appender is registered during initialization.

removeStatsBean

public void removeStatsBean(String appenderName)

Removes information about a stats bean from the internal tables and deregisters it from any MBeanServers. This is normally called when the appender is closed.

registerAppenderBean

protected void registerAppenderBean(String appenderName,
                                    MBeanServer mbeanServer)

Registers an appender's stats bean with a server.

unregisterAppenderBean

protected void unregisterAppenderBean(String appenderName,
                                      MBeanServer mbeanServer)

Deregisters an appender's stats bean from a server.