alma.ACS.MasterComponentImpl

Interface SubsysResourceMonitor.ResourceErrorHandler<T>

All Known Implementing Classes:

MasterComponentImplBase.DefaultResourceErrorHandler

Enclosing class:

SubsysResourceMonitor

public static interface SubsysResourceMonitor.ResourceErrorHandler<T>

Error handler that gets notified when a monitored resource becomes unavailable or degraded.

By implementing a custom error handler, a master component can attempt first to cure the situation, or go into ERROR state by calling doTransition(SubsystemStateEvent.SUBSYSEVENT_ERROR);.

Method Summary

Modifier and Type	Method and Description
void	badState(T resource, java.lang.String stateName) Called when SubsysResourceMonitor was found in a bad state, but still replied in time.
void	resourceRecovered(T resource) Notification that the monitored resource has recovered after a previous failure or timeout.
boolean	resourceUnreachable(T resource) Called when the resource could not be reached at all because of a timeout or network/middleware communication errors.

Method Detail

resourceUnreachable

boolean resourceUnreachable(T resource)

Called when the resource could not be reached at all because of a timeout or network/middleware communication errors. The resource object is passed to allow using one handler for many resources.

The return value controls whether monitoring of this resource will be stopped:

1. true means that the error handler decided that this resource is unreachable beyond repair, and that no further monitoring calls should be made. This can avoid potential problems with an increasing number of hanging calls and eventually stopping the respective threads.
2. false means that monitoring calls should continue.

badState

void badState(T resource,
              java.lang.String stateName)

Called when SubsysResourceMonitor was found in a bad state, but still replied in time.

Parameters:

resource - The resource object is passed to allow using one handler for many resources.

stateName - Name of the bad state the resource was found in. If the resource does not support named states, it may return any String that indicates the problem. For example, SubsysResourceMonitor.PingableResourceChecker returns "ping() failed." which is then used as the stateName.

See Also:

SubsysResourceMonitor.ResourceChecker.checkState()

resourceRecovered

void resourceRecovered(T resource)

Notification that the monitored resource has recovered after a previous failure or timeout. This notification can only work if monitoring has continued after the problem was detected, which is always the case for badState problems, but depends on the return value of resourceUnreachable in case of timeout. problems.

Since:

ACS 8.0.0 (has existed in sub-interface RecoverableResourceErrorHandler since 6.0.3)