public class NotificationFilterSupport extends Object implements NotificationFilter
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:
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".NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
, Serialized Formpublic NotificationFilterSupport()
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 returns true
.
isNotificationEnabled
in interface NotificationFilter
notification
- The notification to be sent.true
if the notification should be sent to the listener, false
otherwise.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:
// 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.
prefix
- The prefix.IllegalArgumentException
- The prefix parameter is null.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.
prefix
- The prefix.public void disableAllTypes()
Disables all notification types.
public Vector<String> getEnabledTypes()
Gets all the enabled notification types for this filter.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.