public class

StringMonitor

extends Monitor
implements StringMonitorMBean

java.lang.Object
↳	javax.management.NotificationBroadcasterSupport
	↳	javax.management.monitor.Monitor
		↳	javax.management.monitor.StringMonitor

Class Overview

Defines a monitor MBean designed to observe the values of a string attribute.

A string monitor sends notifications as follows:

if the attribute value matches the string to compare value, a match notification is sent. The notify match flag must be set to true.
Subsequent matchings of the string to compare values do not cause further notifications unless the attribute value differs from the string to compare value.
if the attribute value differs from the string to compare value, a differ notification is sent. The notify differ flag must be set to true.
Subsequent differences from the string to compare value do not cause further notifications unless the attribute value matches the string to compare value.

Summary

[Expand]

Inherited Constants

From class javax.management.monitor.Monitor

[Expand]

Inherited Fields

From class javax.management.monitor.Monitor

Public Constructors
	StringMonitor() Default constructor.

Public Methods
synchronized String	getDerivedGauge() This method is deprecated. As of JMX 1.2, replaced by `getDerivedGauge(ObjectName)`
synchronized String	getDerivedGauge(ObjectName object) Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, or `null` otherwise.
synchronized long	getDerivedGaugeTimeStamp(ObjectName object) Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or `0` otherwise.
synchronized long	getDerivedGaugeTimeStamp() This method is deprecated. As of JMX 1.2, replaced by `getDerivedGaugeTimeStamp(ObjectName)`
MBeanNotificationInfo[]	getNotificationInfo() Returns a `NotificationInfo` object containing the name of the Java class of the notification and the notification types sent by the string monitor.
synchronized boolean	getNotifyDiffer() Gets the differing notification's on/off switch value common to all observed MBeans.
synchronized boolean	getNotifyMatch() Gets the matching notification's on/off switch value common to all observed MBeans.
synchronized String	getStringToCompare() Gets the string to compare with the observed attribute common to all observed MBeans.
synchronized void	setNotifyDiffer(boolean value) Sets the differing notification's on/off switch value common to all observed MBeans.
synchronized void	setNotifyMatch(boolean value) Sets the matching notification's on/off switch value common to all observed MBeans.
synchronized void	setStringToCompare(String value) Sets the string to compare with the observed attribute common to all observed MBeans.
synchronized void	start() Starts the string monitor.
synchronized void	stop() Stops the string monitor.

[Expand]

Inherited Methods

From class javax.management.monitor.Monitor

synchronized void	addObservedObject(ObjectName object) Adds the specified object in the set of observed MBeans, if this object is not already present.
synchronized boolean	containsObservedObject(ObjectName object) Tests whether the specified object is in the set of observed MBeans.
synchronized long	getGranularityPeriod() Gets the granularity period (in milliseconds).
synchronized String	getObservedAttribute() Gets the attribute being observed.
synchronized ObjectName	getObservedObject() This method is deprecated. As of JMX 1.2, replaced by `getObservedObjects()`
synchronized ObjectName[]	getObservedObjects() Returns an array containing the objects being observed.
synchronized boolean	isActive() Tests whether the monitor MBean is active.
void	postDeregister() Allows the monitor MBean to perform any operations needed after having been unregistered by the MBean server.
void	postRegister(Boolean registrationDone) Allows the monitor MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.
void	preDeregister() Allows the monitor MBean to perform any operations it needs before being unregistered by the MBean server.
ObjectName	preRegister(MBeanServer server, ObjectName name) Allows the monitor MBean to perform any operations it needs before being registered in the MBean server.
synchronized void	removeObservedObject(ObjectName object) Removes the specified object from the set of observed MBeans.
synchronized void	setGranularityPeriod(long period) Sets the granularity period (in milliseconds).
void	setObservedAttribute(String attribute) Sets the attribute to observe.
synchronized void	setObservedObject(ObjectName object) This method is deprecated. As of JMX 1.2, replaced by `addObservedObject(ObjectName)`
abstract void	start() Starts the monitor.
abstract void	stop() Stops the monitor.

From class javax.management.NotificationBroadcasterSupport

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.management.MBeanRegistration

From interface javax.management.NotificationBroadcaster

From interface javax.management.NotificationEmitter

From interface javax.management.monitor.MonitorMBean

From interface javax.management.monitor.StringMonitorMBean

Public Constructors

public StringMonitor ()

Default constructor.

Public Methods

public synchronized String getDerivedGauge ()

This method is deprecated.
As of JMX 1.2, replaced by getDerivedGauge(ObjectName)

Returns the derived gauge of the first object in the set of observed MBeans.

Returns

The derived gauge.

public synchronized String getDerivedGauge (ObjectName object)

Gets the derived gauge of the specified object, if this object is contained in the set of observed MBeans, or null otherwise.

Parameters

object	the name of the MBean whose derived gauge is required.

Returns

The derived gauge of the specified object.

public synchronized long getDerivedGaugeTimeStamp (ObjectName object)

Gets the derived gauge timestamp of the specified object, if this object is contained in the set of observed MBeans, or 0 otherwise.

Parameters

object	the name of the object whose derived gauge timestamp is to be returned.

Returns

The derived gauge timestamp of the specified object.

public synchronized long getDerivedGaugeTimeStamp ()

This method is deprecated.
As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName)

Gets the derived gauge timestamp of the first object in the set of observed MBeans.

Returns

The derived gauge timestamp.

public MBeanNotificationInfo[] getNotificationInfo ()

Returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent by the string monitor.

Returns

the array of possible notifications.

public synchronized boolean getNotifyDiffer ()

Gets the differing notification's on/off switch value common to all observed MBeans.

Returns

true if the string monitor notifies when differing from the string to compare, false otherwise.

public synchronized boolean getNotifyMatch ()

Gets the matching notification's on/off switch value common to all observed MBeans.

Returns

true if the string monitor notifies when matching the string to compare, false otherwise.

public synchronized String getStringToCompare ()

Gets the string to compare with the observed attribute common to all observed MBeans.

Returns

The string value.

public synchronized void setNotifyDiffer (boolean value)

Sets the differing notification's on/off switch value common to all observed MBeans.

Parameters

value	The differing notification's on/off switch value.

public synchronized void setNotifyMatch (boolean value)

Sets the matching notification's on/off switch value common to all observed MBeans.

Parameters

value	The matching notification's on/off switch value.

public synchronized void setStringToCompare (String value)

Sets the string to compare with the observed attribute common to all observed MBeans.

Parameters

value	The string value.

Throws

IllegalArgumentException	The specified string to compare is null.

public synchronized void start ()

Starts the string monitor.

public synchronized void stop ()

Stops the string monitor.

Interfaces

Classes

Exceptions

StringMonitor

Class Overview

Summary

Public Constructors

public StringMonitor ()

Public Methods

public synchronized String getDerivedGauge ()

Returns

public synchronized String getDerivedGauge (ObjectName object)

Parameters

Returns

public synchronized long getDerivedGaugeTimeStamp (ObjectName object)

Parameters

Returns

public synchronized long getDerivedGaugeTimeStamp ()

Returns

public MBeanNotificationInfo[] getNotificationInfo ()

Returns

public synchronized boolean getNotifyDiffer ()

Returns

See Also

public synchronized boolean getNotifyMatch ()

Returns

See Also

public synchronized String getStringToCompare ()

Returns

See Also

public synchronized void setNotifyDiffer (boolean value)

Parameters

See Also

public synchronized void setNotifyMatch (boolean value)

Parameters

See Also

public synchronized void setStringToCompare (String value)

Parameters

Throws

See Also

public synchronized void start ()

public synchronized void stop ()