Class NotificationFilterSupport
- java.lang.Object
-
- javax.management.NotificationFilterSupport
-
- All Implemented Interfaces:
- Serializable, NotificationFilter
- Direct Known Subclasses:
- MBeanServerNotificationFilter
public class NotificationFilterSupport extends Object implements NotificationFilter
Provides an implementation of theNotificationFilterinterface. 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);myListenerwill only receive notifications the type of which equals/starts with "my_example.my_type".
-
-
Constructor Summary
Constructors Constructor and Description NotificationFilterSupport()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description voiddisableAllTypes()Disables all notification types.voiddisableType(String prefix)Removes the given prefix from the prefix list.voidenableType(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.booleanisNotificationEnabled(Notification notification)Invoked before sending the specified notification to the listener.
-
-
-
Method Detail
isNotificationEnabled
public 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 returnstrue.- Specified by:
-
isNotificationEnabledin interfaceNotificationFilter - Parameters:
-
notification- The notification to be sent. - Returns:
-
trueif the notification should be sent to the listener,falseotherwise.
enableType
public void enableType(String prefix) throws IllegalArgumentException
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:
Note that:// 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
public void disableType(String prefix)
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.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
