Class NotificationFilterSupport
java.lang.Object
javax.management.NotificationFilterSupport
- All Implemented Interfaces:
Serializable
,NotificationFilter
- Direct Known Subclasses:
MBeanServerNotificationFilter
Provides an implementation of the
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:
The listenerNotificationFilterSupport myFilter = new NotificationFilterSupport(); myFilter.enableType("my_example.my_type"); myBroadcaster.addListener(myListener, myFilter, null);
myListener
will only receive notifications the type of which equals/starts with "my_example.my_type".- Since:
- 1.5
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Gets all the enabled notification types for this filter.boolean
isNotificationEnabled
(Notification notification) Invoked before sending the specified notification to the listener.
-
Constructor Details
-
NotificationFilterSupport
public NotificationFilterSupport()Constructs aNotificationFilterSupport
.
-
-
Method Details
-
isNotificationEnabled
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 returnstrue
.- Specified by:
isNotificationEnabled
in interfaceNotificationFilter
- Parameters:
notification
- The notification to be sent.- Returns:
true
if the notification should be sent to the listener,false
otherwise.
-
enableType
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");
will no match any notification type.myFilter.enableType("my_example.*");
- Parameters:
prefix
- The prefix.- Throws:
IllegalArgumentException
- The prefix parameter is null.
-
disableType
Removes the given prefix from the prefix list.
If the specified prefix is not in the list of enabled notification types, this method has no effect.- Parameters:
prefix
- The prefix.
-
disableAllTypes
public void disableAllTypes()Disables all notification types. -
getEnabledTypes
-