FileDocCategorySizeDatePackage
NotificationFilterSupport.javaAPI DocJava SE 5 API4984Fri Aug 26 14:57:34 BST 2005javax.management

NotificationFilterSupport

public class NotificationFilterSupport extends Object implements NotificationFilter, Serializable
Provides an implementation of the {@link 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".
see
javax.management.NotificationBroadcaster#addNotificationListener
since
1.5

Fields Summary
private static final long
serialVersionUID
private List
enabledTypes
Constructors Summary
Methods Summary
public synchronized voiddisableAllTypes()
Disables all notification types.

        enabledTypes.clear();
public synchronized voiddisableType(java.lang.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.

param
prefix The prefix.

        enabledTypes.remove(prefix);
public synchronized voidenableType(java.lang.String 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.

param
prefix The prefix.
exception
java.lang.IllegalArgumentException The prefix parameter is null.

        
        if (prefix == null) {
            throw new java.lang.IllegalArgumentException("The prefix cannot be null.");
        }
        if (!enabledTypes.contains(prefix)) {
            enabledTypes.add(prefix);
        }
public synchronized java.util.VectorgetEnabledTypes()
Gets all the enabled notification types for this filter.

return
The list containing all the enabled notification types.

        return (Vector)enabledTypes;
public synchronized booleanisNotificationEnabled(javax.management.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.

param
notification The notification to be sent.
return
true if the notification should be sent to the listener, false otherwise.


  
                                                                               
         
        
        String type = notification.getType();
        
        if (type == null) {
            return false;
        }        
        try {
            for (Iterator i = enabledTypes.iterator(); i.hasNext(); ) {
                String prefix = (String)i.next();                
                if (type.startsWith(prefix)) {
                    return true;
                }
            }
        } catch (java.lang.NullPointerException e) {
            // Should never occurs...
            return false;
        }        
        return false;