public interface StatisticNotificationSession extends OsidSession
This session defines methods to receive notifications on statistics. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForStatisticNotifications()
Tests if this user can register for
Statistic
notifications. |
Utility |
getUtility()
Gets the
Utility associated with this session. |
Id |
getUtilityId()
Gets the
Utility Id associated with this
session. |
void |
registerForStatisticsExceedingAverageRateThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value,
DateTimeResolution rateInterval)
Register for notifications of the rate exceeding a threshold.
|
void |
registerForStatisticsExceedingDeltaThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of the delta exceeding a threshold.
|
void |
registerForStatisticsExceedingMeanThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of means exceeding a threshold.
|
void |
registerForStatisticsExceedingMedianThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of medians exceeding a threshold.
|
void |
registerForStatisticsExceedingPercentChangeThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of the percentage change exceeding a
threshold.
|
void |
registerForStatisticsExceedingRMSThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of the root mean square exceeding a
threshold.
|
void |
registerForStatisticsExceedingSumThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications sums exceeding a threshold.
|
void |
registerForStatisticsFailingAverageRateThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value,
DateTimeResolution rateInterval)
Register for notifications of the rate failing a threshold.
|
void |
registerForStatisticsFailingDeltaThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of the delta failing a threshold.
|
void |
registerForStatisticsFailingMeanThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications means failing a threshold.
|
void |
registerForStatisticsFailingMedianThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of medians failing a threshold.
|
void |
registerForStatisticsFailingPercentChangeThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of the percentage change failing a
threshold.
|
void |
registerForStatisticsFailingRMSThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications of the root mean square failing a
threshold.
|
void |
registerForStatisticsFailingSumThreshold(Id meterId,
long interval,
DateTimeResolution units,
java.math.BigDecimal value)
Register for notifications sums failing a threshold.
|
void |
useFederatedUtilityView()
Federates the view for methods in this session.
|
void |
useIsolatedUtilityView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getUtilityId()
Utility
Id
associated with this
session. Utility Id
associated with this sessionmandatory
- This method must be implemented. Utility getUtility() throws OperationFailedException, PermissionDeniedException
Utility
associated with this session. Utility
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForStatisticNotifications()
Statistic
notifications. A return of true does not guarantee successful
authorization. A return of false indicates that it is known all
methods in this session will result in a PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedUtilityView()
mandatory
- This method is must be implemented. void useIsolatedUtilityView()
mandatory
- This method is must be implemented. void registerForStatisticsExceedingSumThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.exceededSumThreshold()
is invoked when the
sum exceeds the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsFailingSumThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.failedSumThreshold()
is invoked when the sum
falls below the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsExceedingMeanThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.exceededMeanThreshold()
is invoked when the
mean exceeds the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsFailingMeanThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.failedMeanThreshold()
is invoked when the
mean falls below the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsExceedingMedianThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.exceededMeanThreshold()
is invoked when the
median exceeds the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsFailingMedianThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.failedMeanThreshold()
is invoked when the
median falls below the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsExceedingRMSThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.exceededRMSThreshold()
is
invoked when the rms exceeds the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsFailingRMSThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.failedRMSThreshold()
is
invoked when the rms falls below the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId or units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsExceedingDeltaThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.exceededDeltaThreshold()
is invoked when the
delta exceeds the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsFailingDeltaThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.failedDeltaThreshold()
is invoked when the
delta falls below the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsExceedingPercentChangeThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.exceededPercentChangeThreshold()
is invoked when the change exceeds the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId
or
units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsFailingPercentChangeThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.failedPercentChangeThreshold()
is invoked when the change falls below the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valueNullArgumentException
- meterId or units
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsExceedingAverageRateThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value, DateTimeResolution rateInterval) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.exceededAverageRateThreshold()
is invoked
when the average rate exceeds the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valuerateInterval
- the time interval of the rateNullArgumentException
- meterId, units,
or rateInterval
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStatisticsFailingAverageRateThreshold(Id meterId, long interval, DateTimeResolution units, java.math.BigDecimal value, DateTimeResolution rateInterval) throws OperationFailedException, PermissionDeniedException
StatisticReceiver.failedAverageRateThreshold()
is invoked when
the average rate falls below the given value.meterId
- the meter Id
interval
- the time interval from the presentunits
- the date time unitsvalue
- the threshold valuerateInterval
- the time interval of the rateNullArgumentException
- meterId, units,
or rateInterval
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.