mx4j.monitor

Class MX4JMonitor

java.lang.Object

javax.management.StandardMBean

mx4j.monitor.MX4JMonitor

All Implemented Interfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, MX4JMonitorMBean

Direct Known Subclasses:

MX4JCounterMonitor, MX4JGaugeMonitor, MX4JStringMonitor

public abstract class MX4JMonitor
extends javax.management.StandardMBean
implements MX4JMonitorMBean, javax.management.MBeanRegistration, javax.management.NotificationEmitter

The class that implements the Monitor behavior of the JMX specification. IMPLEMENTATION NOTE: There is one single thread that handles monitoring, for all monitor objects. There is one single task per each monitor object that runs. The queue will have possibly many tasks per each monitor type. Each monitor handles many MBeans, but only one attribute; however, both MBeans and attribute can be changed, though it would be a strange way to use the monitor.

Version:

$Revision: 1.4 $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MX4JMonitor.MonitorInfo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MX4JMonitor(java.lang.Class management)

Method Summary

Modifier and Type	Method and Description
void	addNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback) Adds a notification listener to this emitter.
void	addObservedObject(javax.management.ObjectName name)
void	clearObservedObjects()
boolean	containsObservedObject(javax.management.ObjectName name)
protected abstract MX4JMonitor.MonitorInfo	createMonitorInfo()
protected javax.management.Notification	createMonitorNotification(java.lang.String type, long sequence, java.lang.String message, javax.management.ObjectName observed, java.lang.String attribute, java.lang.Object gauge, java.lang.Object trigger)
protected javax.management.NotificationBroadcasterSupport	createNotificationEmitter()
long	getGranularityPeriod()
protected Logger	getLogger()
protected MX4JMonitor.MonitorInfo	getMonitorInfo(javax.management.ObjectName name)
java.lang.String	getObservedAttribute()
javax.management.ObjectName[]	getObservedObjects()
boolean	isActive()
protected abstract void	monitor(javax.management.ObjectName name, java.lang.String attribute, java.lang.Object value, MX4JMonitor.MonitorInfo info)
void	postDeregister() Callback called just after the MBean has been successfully unregistered.
void	postRegister(java.lang.Boolean registrationDone) Callback called just after the MBean has been registered (successfully or not).
void	preDeregister() Callback called just before MBean unregistration from the MBeanServer.
javax.management.ObjectName	preRegister(javax.management.MBeanServer server, javax.management.ObjectName name) Callback called just before MBean registration in the MBeanServer.
protected void	putMonitorInfo(javax.management.ObjectName name, MX4JMonitor.MonitorInfo info)
protected void	removeMonitorInfo(javax.management.ObjectName name)
void	removeNotificationListener(javax.management.NotificationListener listener) Removes a notification listener from this emitter.
void	removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback) Removes a notification listener from this MBean.
void	removeObservedObject(javax.management.ObjectName name)
protected void	sendErrorNotification(MX4JMonitor.MonitorInfo info, java.lang.String type, java.lang.String message, javax.management.ObjectName observed, java.lang.String attribute)
void	sendNotification(javax.management.Notification notification)
protected void	sendNotification(java.lang.String type, java.lang.String message, javax.management.ObjectName name, java.lang.String attribute, java.lang.Object gauge, java.lang.Object trigger)
void	setGranularityPeriod(long granularity)
void	setObservedAttribute(java.lang.String attribute)
void	start()
protected void	startMonitor()
void	stop()
protected void	stopMonitor()

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, getParameterName, invoke, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.management.NotificationBroadcaster

getNotificationInfo

Constructor Detail

MX4JMonitor

protected MX4JMonitor(java.lang.Class management)
               throws javax.management.NotCompliantMBeanException

Throws:

javax.management.NotCompliantMBeanException

Method Detail

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)

Description copied from interface: javax.management.MBeanRegistration

Callback called just before MBean registration in the MBeanServer. Any exception thrown by this method will cause the MBean registration to abort.

Specified by:

preRegister in interface javax.management.MBeanRegistration

Parameters:

server - The MBeanServer on which the MBean will be registered.

name - The ObjectName of the MBean.

Returns:

The ObjectName of the registered MBean, must not be null

postRegister

public void postRegister(java.lang.Boolean registrationDone)

Description copied from interface: javax.management.MBeanRegistration

Callback called just after the MBean has been registered (successfully or not).

Specified by:

postRegister in interface javax.management.MBeanRegistration

Parameters:

registrationDone - True if the registration was successful, false otherwise.

preDeregister

public void preDeregister()

Description copied from interface: javax.management.MBeanRegistration

Callback called just before MBean unregistration from the MBeanServer. Any exception thrown by this method will cause the MBean unregistration to abort.

Specified by:

preDeregister in interface javax.management.MBeanRegistration

postDeregister

public void postDeregister()

Description copied from interface: javax.management.MBeanRegistration

Callback called just after the MBean has been successfully unregistered.

Specified by:

postDeregister in interface javax.management.MBeanRegistration

createNotificationEmitter

protected javax.management.NotificationBroadcasterSupport createNotificationEmitter()

addNotificationListener

public void addNotificationListener(javax.management.NotificationListener listener,
                                    javax.management.NotificationFilter filter,
                                    java.lang.Object handback)
                             throws java.lang.IllegalArgumentException

Description copied from interface: javax.management.NotificationBroadcaster

Adds a notification listener to this emitter.

Specified by:

addNotificationListener in interface javax.management.NotificationBroadcaster

Parameters:

listener - The notification listener which will handle the notifications emitted.

filter - Filters notifications that the listener should receive; may be null, if no filtering is required.

handback - An opaque object to be sent back to the listener when a notification is emitted.

Throws:

java.lang.IllegalArgumentException

See Also:

NotificationBroadcaster.removeNotificationListener(NotificationListener)

removeNotificationListener

public void removeNotificationListener(javax.management.NotificationListener listener)
                                throws javax.management.ListenerNotFoundException

Description copied from interface: javax.management.NotificationBroadcaster

Removes a notification listener from this emitter. If the listener has been registered with different handback objects or notification filters, all entries corresponding to the listener will be removed.

Specified by:

removeNotificationListener in interface javax.management.NotificationBroadcaster

Parameters:

listener - The notification listener that was previously added to this emitter.

Throws:

javax.management.ListenerNotFoundException - If the listener is not registered with the emitter.

See Also:

NotificationBroadcaster.addNotificationListener(NotificationListener, NotificationFilter, Object)

removeNotificationListener

public void removeNotificationListener(javax.management.NotificationListener listener,
                                       javax.management.NotificationFilter filter,
                                       java.lang.Object handback)
                                throws javax.management.ListenerNotFoundException

Description copied from interface: javax.management.NotificationEmitter

Removes a notification listener from this MBean. The MBean must have a registered listener that exactly matches the given listener, filter, and handback parameters.

Specified by:

removeNotificationListener in interface javax.management.NotificationEmitter

Parameters:

listener - The listener that was previously added to this MBean.

filter - The filter that was specified when the listener was added.

handback - The handback that was specified when the listener was added.

Throws:

javax.management.ListenerNotFoundException - If the triple listener, filter, handback is not registered with the emitter

sendNotification

public void sendNotification(javax.management.Notification notification)

start

public void start()

Specified by:

start in interface MX4JMonitorMBean

stop

public void stop()

Specified by:

stop in interface MX4JMonitorMBean

isActive

public boolean isActive()

Specified by:

isActive in interface MX4JMonitorMBean

addObservedObject

public void addObservedObject(javax.management.ObjectName name)
                       throws java.lang.IllegalArgumentException

Specified by:

addObservedObject in interface MX4JMonitorMBean

Throws:

java.lang.IllegalArgumentException

removeObservedObject

public void removeObservedObject(javax.management.ObjectName name)

Specified by:

removeObservedObject in interface MX4JMonitorMBean

containsObservedObject

public boolean containsObservedObject(javax.management.ObjectName name)

Specified by:

containsObservedObject in interface MX4JMonitorMBean

getObservedObjects

public javax.management.ObjectName[] getObservedObjects()

Specified by:

getObservedObjects in interface MX4JMonitorMBean

clearObservedObjects

public void clearObservedObjects()

getObservedAttribute

public java.lang.String getObservedAttribute()

Specified by:

getObservedAttribute in interface MX4JMonitorMBean

setObservedAttribute

public void setObservedAttribute(java.lang.String attribute)

Specified by:

setObservedAttribute in interface MX4JMonitorMBean

getGranularityPeriod

public long getGranularityPeriod()

Specified by:

getGranularityPeriod in interface MX4JMonitorMBean

setGranularityPeriod

public void setGranularityPeriod(long granularity)
                          throws java.lang.IllegalArgumentException

Specified by:

setGranularityPeriod in interface MX4JMonitorMBean

Throws:

java.lang.IllegalArgumentException

startMonitor

protected void startMonitor()

stopMonitor

protected void stopMonitor()

getLogger

protected Logger getLogger()

sendNotification

protected void sendNotification(java.lang.String type,
                                java.lang.String message,
                                javax.management.ObjectName name,
                                java.lang.String attribute,
                                java.lang.Object gauge,
                                java.lang.Object trigger)

createMonitorNotification

protected javax.management.Notification createMonitorNotification(java.lang.String type,
                                                                  long sequence,
                                                                  java.lang.String message,
                                                                  javax.management.ObjectName observed,
                                                                  java.lang.String attribute,
                                                                  java.lang.Object gauge,
                                                                  java.lang.Object trigger)

monitor

protected abstract void monitor(javax.management.ObjectName name,
                                java.lang.String attribute,
                                java.lang.Object value,
                                MX4JMonitor.MonitorInfo info)

createMonitorInfo

protected abstract MX4JMonitor.MonitorInfo createMonitorInfo()

getMonitorInfo

protected MX4JMonitor.MonitorInfo getMonitorInfo(javax.management.ObjectName name)

putMonitorInfo

protected void putMonitorInfo(javax.management.ObjectName name,
                              MX4JMonitor.MonitorInfo info)

removeMonitorInfo

protected void removeMonitorInfo(javax.management.ObjectName name)

sendErrorNotification

protected void sendErrorNotification(MX4JMonitor.MonitorInfo info,
                                     java.lang.String type,
                                     java.lang.String message,
                                     javax.management.ObjectName observed,
                                     java.lang.String attribute)