com.adaptris.core

Class WaitingOutOfStateHandler

java.lang.Object

com.adaptris.core.OutOfStateHandlerImp

com.adaptris.core.WaitingOutOfStateHandler

All Implemented Interfaces:

OutOfStateHandler

public class WaitingOutOfStateHandler
extends OutOfStateHandlerImp

This implementation of the OutOfStateHandler will simply wait on the current Thread for the StateManagedComponent to be in the correct/expected state.

While waiting, we will periodically check the StateManagedComponents state. This periodic check can be configured by setting the interval-to-check which is a TimeInterval.

We will also only wait for the StateManagedComponent to be in the right state for a maximum time, configured by setting the maximum-wait-time, which is also a TimeInterval. If the maximum time should pass while waiting, we will stop waiting and throw an OutOfStateException.

If you do not configure interval-to-check and/or maximum-wait-time, the following defaults will be applied;

• maximum-wait-time = 2 minutes.
• interval-to-check = 5 seconds.

Example configuration;

  
 <waiting-out-of-state-handler>
    <correct-state>STARTED</correct-state>
    <maximum-wait-time>
        <unit>MINUTES</UNIT>
        <interval>2</interval>
    </maximum-wait-time>
    <interval-to-check>
        <unit>SECONDS<<unit>
        <interval>5</interval>
    </interval-to-check>
 </waiting-out-of-state-handler>
 
 

In the adapter configuration file this class is aliased as waiting-out-of-state-handler which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
WaitingOutOfStateHandler()

Method Summary

Modifier and Type	Method and Description
TimeInterval	getIntervalToCheck()
TimeInterval	getMaximumWaitTime()
void	handleOutOfState(StateManagedComponent component)
protected long	intervalToCheckMs()
protected long	maxWaitTimeMs()
void	setIntervalToCheck(TimeInterval interval)
void	setMaximumWaitTime(TimeInterval max)

Methods inherited from class com.adaptris.core.OutOfStateHandlerImp

getCorrectState, isInCorrectState, setCorrectState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WaitingOutOfStateHandler

public WaitingOutOfStateHandler()

Method Detail

handleOutOfState

public void handleOutOfState(StateManagedComponent component)
                      throws OutOfStateException

Throws:

OutOfStateException

getMaximumWaitTime

public TimeInterval getMaximumWaitTime()

setMaximumWaitTime

public void setMaximumWaitTime(TimeInterval max)

getIntervalToCheck

public TimeInterval getIntervalToCheck()

setIntervalToCheck

public void setIntervalToCheck(TimeInterval interval)

intervalToCheckMs

protected long intervalToCheckMs()

maxWaitTimeMs

protected long maxWaitTimeMs()