- 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 theNotificationFilter
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);
myListener
will only receive notifications the type of which equals/starts with "my_example.my_type".
-
-
Constructor Summary
Constructors Constructor and Description NotificationFilterSupport()
-
Method Summary
Methods Modifier and Type Method and 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.boolean
isNotificationEnabled(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:
isNotificationEnabled
in interfaceNotificationFilter
- Parameters:
notification
- The notification to be sent.- Returns:
true
if the notification should be sent to the listener,false
otherwise.
-
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:
// 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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/management/notificationfiltersupport.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.