Class MBeanServerNotificationFilter

java.lang.Object

javax.management.NotificationFilterSupport

javax.management.relation.MBeanServerNotificationFilter

All Implemented Interfaces:

Serializable, NotificationFilter

public class MBeanServerNotificationFilter
extends NotificationFilterSupport

Filter for MBeanServerNotification. This filter filters MBeanServerNotification notifications by selecting the ObjectNames of interest and the operations (registration, unregistration, both) of interest (corresponding to notification types).

The serialVersionUID of this class is 2605900539589789736L.

Since:

1.5

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MBeanServerNotificationFilter()	Creates a filter selecting all MBeanServerNotification notifications for all ObjectNames.

Method Summary

Modifier and Type	Method	Description
void	disableAllObjectNames()	Disables any MBeanServerNotification (all ObjectNames are deselected).
void	disableObjectName(ObjectName objectName)	Disables MBeanServerNotifications concerning given ObjectName.
void	enableAllObjectNames()	Enables all MBeanServerNotifications (all ObjectNames are selected).
void	enableObjectName(ObjectName objectName)	Enables MBeanServerNotifications concerning given ObjectName.
Vector<ObjectName>	getDisabledObjectNames()	Gets all the ObjectNames disabled.
Vector<ObjectName>	getEnabledObjectNames()	Gets all the ObjectNames enabled.
boolean	isNotificationEnabled(Notification notif)	Invoked before sending the specified notification to the listener.

Methods declared in class NotificationFilterSupport

disableAllTypes, disableType, enableType, getEnabledTypes

Modifier and Type	Method	Description
void	disableAllTypes()	Disables all notification types.
void	disableType(String prefix)	Removes the given prefix from the prefix list.
void	enableType(String prefix)	Enables all the notifications the type of which starts with the specified prefix to be sent to the listener.
Vector<String>	getEnabledTypes()	Gets all the enabled notification types for this filter.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

MBeanServerNotificationFilter

public MBeanServerNotificationFilter()

Creates a filter selecting all MBeanServerNotification notifications for all ObjectNames.

Method Details

disableAllObjectNames

public void disableAllObjectNames()

Disables any MBeanServerNotification (all ObjectNames are deselected).

disableObjectName

public void disableObjectName(ObjectName objectName)
                       throws IllegalArgumentException

Disables MBeanServerNotifications concerning given ObjectName.

Parameters:

objectName - ObjectName no longer of interest

Throws:

IllegalArgumentException - if the given ObjectName is null

enableAllObjectNames

public void enableAllObjectNames()

Enables all MBeanServerNotifications (all ObjectNames are selected).

enableObjectName

public void enableObjectName(ObjectName objectName)
                      throws IllegalArgumentException

Enables MBeanServerNotifications concerning given ObjectName.

Parameters:

objectName - ObjectName of interest

Throws:

IllegalArgumentException - if the given ObjectName is null

getEnabledObjectNames

public Vector<ObjectName> getEnabledObjectNames()

Gets all the ObjectNames enabled.

Returns:

Vector of ObjectNames:

- null means all ObjectNames are implicitly selected, except the ObjectNames explicitly deselected

- empty means all ObjectNames are deselected, i.e. no ObjectName selected.

getDisabledObjectNames

public Vector<ObjectName> getDisabledObjectNames()

Gets all the ObjectNames disabled.

Returns:

Vector of ObjectNames:

- null means all ObjectNames are implicitly deselected, except the ObjectNames explicitly selected

- empty means all ObjectNames are selected, i.e. no ObjectName deselected.

isNotificationEnabled

public boolean isNotificationEnabled(Notification notif)
                              throws IllegalArgumentException

Invoked before sending the specified notification to the listener.

If:

- the ObjectName of the concerned MBean is selected (explicitly OR (implicitly and not explicitly deselected))

AND

- the type of the operation (registration or unregistration) is selected

then the notification is sent to the listener.

Specified by:

isNotificationEnabled in interface NotificationFilter

Overrides:

isNotificationEnabled in class NotificationFilterSupport

Parameters:

notif - The notification to be sent.

Returns:

true if the notification has to be sent to the listener, false otherwise.

Throws:

IllegalArgumentException - if null parameter