Class: javax.management.NotificationFilterSupport

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".
See:
@see javax.management.NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
Since:
@since 1.5

Inheritance

Superclass tree: Implements:

Methods

  • NotificationFilterSupporttop

    public NotificationFilterSupport()
    Related Links:
    Google Code Search
    Stack Overflow

  • disableAllTypestop

    public synchronized void disableAllTypes()
    Disables all notification types.
    Related Links:
    Google Code Search
    Stack Overflow

  • disableTypetop

    public synchronized 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:
    @param prefix The prefix.
    Related Links:
    Google Code Search
    Stack Overflow

  • enableTypetop

    public synchronized 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.
    Parameters:
    @param prefix The prefix.
    Exceptions:
    @exception IllegalArgumentException The prefix parameter is null.
    Related Links:
    Google Code Search
    Stack Overflow

  • getEnabledTypestop

    public synchronized Vector<String> getEnabledTypes()
    Gets all the enabled notification types for this filter.
    Return:
    @return The list containing all the enabled notification types.
    Related Links:
    Google Code Search
    Stack Overflow

  • isNotificationEnabledtop

    public synchronized 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.
    Parameters:
    @param notification The notification to be sent.
    Return:
    @return true if the notification should be sent to the listener, false otherwise.
    Specified by:
    isNotificationEnabled from NotificationFilter
    Related Links:
    Google Code Search
    Stack Overflow