public class UsageOutOfRangeFilter extends Object implements NotificationFilter
UsageNotification
s where the
notification source and usage parameter name match specified values, and the value of
the usage parameter contained in the notification falls outside a specified range.
If the notification contains usage information for some other notification source or usage parameter, or the value of the usage parameter falls within the specified range, the notification is suppressed.
Notifications that are not instances of UsageNotification
are suppressed
by this filter.
Constructor and Description |
---|
UsageOutOfRangeFilter(NotificationSource notificationSource,
String paramName,
long lowValue,
long highValue)
Create a
UsageOutOfRangeFilter . |
UsageOutOfRangeFilter(ServiceID service,
SbbID sbb,
String paramName,
long lowValue,
long highValue)
Deprecated.
Replaced with
UsageOutOfRangeFilter(NotificationSource, String, long, long)
as usage collecting has been expanded to include SLEE components other than SBBs. |
Modifier and Type | Method and Description |
---|---|
boolean |
isNotificationEnabled(Notification notification)
Determine whether the specified notification should be delivered to notification
listeners using this notification filter.
|
public UsageOutOfRangeFilter(ServiceID service, SbbID sbb, String paramName, long lowValue, long highValue) throws NullPointerException, InvalidArgumentException
UsageOutOfRangeFilter(NotificationSource, String, long, long)
as usage collecting has been expanded to include SLEE components other than SBBs.UsageOutOfRangeFilter
. A filter created using this constructor
will only allow SLEE 1.0-compliant usage notifications to pass through where they
otherwise satisfy the filtering criteria.service
- the component identifier of the Service whose usage parameter
should be monitored.sbb
- the component identifier of the SBB whose usage parameter should be
monitored.paramName
- the name of a usage parameter defined by the SBB.lowValue
- the lower bound of the range. Notifications are allowed through
this filter if the value of the specified usage parameter is less than
this value.highValue
- the upper bound of the range. Notifications are allowed through
this filter if the value of the specified usage parameter is greater than
this value.NullPointerException
- if service
, sbb
, or
paramName
is null
.InvalidArgumentException
- if highValue < lowValue
.public UsageOutOfRangeFilter(NotificationSource notificationSource, String paramName, long lowValue, long highValue) throws NullPointerException, InvalidArgumentException
UsageOutOfRangeFilter
. A filter created using this constructor
will only allow SLEE 1.0-compliant usage notifications to pass through where they
otherwise satisfy the filtering criteria.notificationSource
- the notification source whose usage parameter should be
monitored.paramName
- the name of a usage parameter defined by the SBB.lowValue
- the lower bound of the range. Notifications are allowed through
this filter if the value of the specified usage parameter is less than
this value.highValue
- the upper bound of the range. Notifications are allowed through
this filter if the value of the specified usage parameter is greater than
this value.NullPointerException
- if notificationSource
or paramName
is null
.InvalidArgumentException
- if highValue < lowValue
.public boolean isNotificationEnabled(Notification notification)
isNotificationEnabled
in interface NotificationFilter
notification
- the notification to be sent.true
if the notification should be delivered to notification
listeners, false
otherwise. This method always returns
false
if notification
is not an instance of
UsageNotification
.