javax.management

Class NotificationFilterSupport

public class NotificationFilterSupport extends Object implements NotificationFilter

Performs filtering of {@link Notification}s based on a list of type prefixes. The type of a notification is compared with each member of the list using {@link String#startsWith(String)} and, if one matches, the notification is allowed to pass through the filter. Matching on the beginning of the string is used in preference to wildcards, so type.* will match only notifications with a type beginning with code>type.*, not type. as expected.

Since: 1.5

Method Summary
voiddisableAllTypes()
Blocks all types by emptying the list of enabled attributes.
voiddisableType(String prefix)
Removes the specified type prefix from the list of enabled types, thus preventing matching types from passing through the filter.
voidenableType(String prefix)
Adds the specified type prefix to the list of enabled types, thus allowing types starting with this string to pass through the filter.
Vector<String>getEnabledTypes()
Returns the list of enabled types for this filter.
booleanisNotificationEnabled(Notification notif)
Returns true if the type of the specified notification begins with one of the enabled type prefixes.

Method Detail

disableAllTypes

public void disableAllTypes()
Blocks all types by emptying the list of enabled attributes.

disableType

public void disableType(String prefix)
Removes the specified type prefix from the list of enabled types, thus preventing matching types from passing through the filter. If the specified type prefix is not enabled, this operation has no effect.

Parameters: prefix the prefix to disable.

enableType

public void enableType(String prefix)
Adds the specified type prefix to the list of enabled types, thus allowing types starting with this string to pass through the filter. If the type prefix is already enabled, this has no effect.

Parameters: prefix the prefix to enable.

Throws: IllegalArgumentException if prefix is null.

getEnabledTypes

public Vector<String> getEnabledTypes()
Returns the list of enabled types for this filter.

Returns: the list of enabled types.

isNotificationEnabled

public boolean isNotificationEnabled(Notification notif)
Returns true if the type of the specified notification begins with one of the enabled type prefixes.

Parameters: notif the notification being filtered.

Returns: true if the notification's type is enabled.