NotificationFilterSupport (Java SE 17 & JDK 17)
Description: declaration: module: java.management, package: javax.management, class: NotificationFilterSupport
Keywords: javax.management.NotificationFilterSupport class

Module java.management
Package javax.management

# Class NotificationFilterSupport

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

Since:
  1.5
See Also:
  - `NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)`
  - Serialized Form

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `NotificationFilterSupport()`
  Constructs a `NotificationFilterSupport`.

- ## Method Summary

  Modifier and Type
  Method
  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.

  ### Methods declared in class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### NotificationFilterSupport

    public NotificationFilterSupport()
    Constructs a `NotificationFilterSupport`.

- ## Method Details

  - ### 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 returns `true`.
    Specified by:
      `isNotificationEnabled` in interface `NotificationFilter`
    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");

    Note that:

    > `myFilter.enableType("my_example.*");`

    will no match any notification type.
    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.

  - ### getEnabledTypes

    public Vector<String> getEnabledTypes()
    Gets all the enabled notification types for this filter.
    Returns:
      The list containing all the enabled notification types.