javax.management: public class: NotificationFilterSupport

javax.management
public class: NotificationFilterSupport [javadoc | source]

java.lang.Object
   javax.management.NotificationFilterSupport

All Implemented Interfaces:
NotificationFilter

Direct Known Subclasses:
MBeanServerNotificationFilter

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".

Also see:

javax.management.NotificationBroadcaster#addNotificationListener

since: 1.5 -

Method from javax.management.NotificationFilterSupport Summary:
disableAllTypes, disableType, enableType, getEnabledTypes, isNotificationEnabled

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.management.NotificationFilterSupport Detail:
public synchronized void disableAllTypes() { enabledTypes.clear(); } Disables all notification types.
public synchronized void disableType(String prefix) { enabledTypes.remove(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.
public synchronized void enableType(String prefix) throws IllegalArgumentException { if (prefix == null) { throw new IllegalArgumentException("The prefix cannot be null."); } if (!enabledTypes.contains(prefix)) { enabledTypes.add(prefix); } } 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.
public synchronized Vector<String> getEnabledTypes() { return (Vector< String >)enabledTypes; } Gets all the enabled notification types for this filter.
public synchronized boolean isNotificationEnabled(Notification notification) { String type = notification.getType(); if (type == null) { return false; } try { for (String prefix : enabledTypes) { if (type.startsWith(prefix)) { return true; } } } catch (java.lang.NullPointerException e) { // Should never occurs... return false; } return false; } 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`.

Method from javax.management.NotificationFilterSupport Detail:

 public synchronized  void disableAllTypes() {
        enabledTypes.clear();
}

Disables all notification types.

 public synchronized  void disableType(String prefix) {
        enabledTypes.remove(prefix);
}

 public synchronized  void enableType(String prefix) throws IllegalArgumentException {
        if (prefix == null) {
            throw new IllegalArgumentException("The prefix cannot be null.");
        }
        if (!enabledTypes.contains(prefix)) {
            enabledTypes.add(prefix);
        }
}

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");

myFilter.enableType("my_example.*");

 public synchronized Vector<String> getEnabledTypes() {
        return (Vector< String >)enabledTypes;
}

Gets all the enabled notification types for this filter.

 public synchronized boolean isNotificationEnabled(Notification notification) {
        String type = notification.getType();
        if (type == null) {
            return false;
        }
        try {
            for (String prefix : enabledTypes) {
                if (type.startsWith(prefix)) {
                    return true;
                }
            }
        } catch (java.lang.NullPointerException e) {
            // Should never occurs...
            return false;
        }
        return false;
}

true