stella.net.tpl

Interface TsiErrorPolicy

All Known Implementing Classes:

TsiError.DefaultErrorPolicy

public interface TsiErrorPolicy

Interface that defines necessary methods to allow proper error handling on TsiErrors. A policy is needed for non-specific errors (those that have no individual class) to determine their lag and the maximum number of occurences.

The general error-reset policy of Pilar errors is as follows:

• If an error has occured for the first time, it may be deleted, unless its getResetMax(stella.net.tpl.TsiError) is set to zero.
• If this is a recurrent occurence of the error, the time of the last occurence must be at least getResetLag(stella.net.tpl.TsiError) in the past.
• If the number of occurences reached getAccumulateCount(stella.net.tpl.TsiError), all accumulated errors may not span a time span shorter than getAccumulateSpan(stella.net.tpl.TsiError). E.g. clearing of a severe error once may be ok, but if it occured three times within an hour, this seems fishy.
• If the number of occurences is getResetMax(stella.net.tpl.TsiError), the error may not be cleared.

Method Summary

Modifier and Type	Method and Description
int	getAccumulateCount(TsiError tsi) Returns the number of error occurences for that the accumulation span has to be checked.
long	getAccumulateSpan(TsiError tsi) Returns the maximum time span allowed for the occurence of getAccumulateCount(stella.net.tpl.TsiError) errors.
long	getResetLag(TsiError tsi) Returns the minimum time that must pass between clearing of errors.
int	getResetMax(TsiError tsi) Returns the maximum number of error of the specified type allowed pending.
boolean	ignore(TsiError tsi) Returns true, if this error can savly be ignored under the current policy.

Method Detail

getResetLag

long getResetLag(TsiError tsi)

Returns the minimum time that must pass between clearing of errors. If zero is returned, clearing can commence without delay.

getAccumulateSpan

long getAccumulateSpan(TsiError tsi)

Returns the maximum time span allowed for the occurence of getAccumulateCount(stella.net.tpl.TsiError) errors. This means, once the maximum number of errors is reached, clearing of this error is only allowed, if the occurence date of the max num last error is at least this time span in the past.

getAccumulateCount

int getAccumulateCount(TsiError tsi)

Returns the number of error occurences for that the accumulation span has to be checked. Useful only if less then getResetMax(stella.net.tpl.TsiError).

getResetMax

int getResetMax(TsiError tsi)

Returns the maximum number of error of the specified type allowed pending. Negative number indicate no restriction.

ignore

boolean ignore(TsiError tsi)

Returns true, if this error can savly be ignored under the current policy.