| java.lang.Object javax.management.NotificationFilterSupport
All known Subclasses: javax.management.relation.MBeanServerNotificationFilter,
NotificationFilterSupport | public class NotificationFilterSupport implements NotificationFilter,Serializable(Code) | | Provides an implementation of the
javax.management.NotificationFilter interface.
The filtering is performed on the notification type attribute.
Manages a list of enabled notification types.
A method allows users to enable/disable as many notification types as required.
Then, before sending a notification to a listener registered with a filter,
the notification broadcaster compares this notification type with all notification types
enabled by the filter. The notification will be sent to the listener
only if its filter enables this notification type.
Example:
NotificationFilterSupport myFilter = new NotificationFilterSupport();
myFilter.enableType("my_example.my_type");
myBroadcaster.addListener(myListener, myFilter, null);
The listener myListener will only receive notifications the type of which equals/starts with "my_example.my_type".
See Also: javax.management.NotificationBroadcaster.addNotificationListener author: Young Yang |
Method Summary | |
public synchronized void | disableAllTypes() Disables all notification types. | public synchronized void | disableType(String prefix) Disables all notifications the type of which starts with the specified prefix
to be sent to the listener. | public synchronized void | enableType(String prefix) Enables all the notifications the type of which starts with the specified prefix
to be sent to the listener. | public synchronized Vector | getEnabledTypes() Gets all the enabled notification types for this filter. | public synchronized boolean | isNotificationEnabled(Notification notification) Invoked before sending the specified notification to the listener.
This filter compares the type of the specified notification with each enabled type.
If the notification type matches one of the enabled types,
the notification should be sent to the listener and this method returns true .
Parameters: notification - The notification to be sent. |
disableAllTypes | public synchronized void disableAllTypes()(Code) | | Disables all notification types.
|
disableType | public synchronized void disableType(String prefix)(Code) | | Disables all notifications the type of which starts with the specified prefix
to be sent to the listener.
If the specified prefix is not in the list of enabled notification types,
this method has no effect.
Parameters: prefix - The prefix. |
enableType | public synchronized void enableType(String prefix) throws java.lang.IllegalArgumentException(Code) | | Enables all the notifications the type of which starts with the specified prefix
to be sent to the listener.
If the specified prefix is already in the list of enabled notification types,
this method has no effect.
Example:
// Enables all notifications the type of which starts with "my_example" to be sent.
myFilter.enableType("my_example");
// Enables all notifications the type of which is "my_example.my_type" to be sent.
myFilter.enableType("my_example.my_type");
Note that:
myFilter.enableType("my_example.*");
will no match any notification type.
Parameters: prefix - The prefix. exception: java.lang.IllegalArgumentException - The prefix parameter is null. |
getEnabledTypes | public synchronized Vector getEnabledTypes()(Code) | | Gets all the enabled notification types for this filter.
The list containing all the enabled notification types. |
isNotificationEnabled | public synchronized boolean isNotificationEnabled(Notification notification)(Code) | | Invoked before sending the specified notification to the listener.
This filter compares the type of the specified notification with each enabled type.
If the notification type matches one of the enabled types,
the notification should be sent to the listener and this method returns true .
Parameters: notification - The notification to be sent. true if the notification should be sent to the listener, false otherwise. |
|
|