org.apache.qpid.client.state

Class StateWaiter

java.lang.Object

org.apache.qpid.client.util.BlockingWaiter<AMQState>

org.apache.qpid.client.state.StateWaiter

public class StateWaiter
extends BlockingWaiter<AMQState>

This is an implementation of the BlockingWaiter to provide error handing and a waiting mechanism for state changes. On construction the current state and a set of States to await for is provided. When await() is called the state at construction is compared against the awaitStates. If the state at construction is a desired state then await() returns immediately. Otherwise it will block for the set timeout for a desired state to be achieved. The state changes are notified via the process(org.apache.qpid.client.state.AMQState) method. Any notified error is handled by the BlockingWaiter and thrown from the BlockingWaiter.block(long) method.

Constructor Summary

Constructors

Constructor and Description
StateWaiter(AMQStateManager stateManager, AMQState currentState, Set<AMQState> awaitStates)

Method Summary

Methods

Modifier and Type	Method and Description
AMQState	await() Await for the required State to be achieved within the default timeout.
AMQState	await(long timeout) Await for the required State to be achieved.
String	getConnectionDetails()
boolean	process(AMQState state) When the state is changed this StateWaiter is notified to process the change.

Methods inherited from class org.apache.qpid.client.util.BlockingWaiter

block, close, error, received

Methods inherited from class java.lang.Object

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

Constructor Detail

StateWaiter

public StateWaiter(AMQStateManager stateManager,
           AMQState currentState,
           Set<AMQState> awaitStates)

Parameters:

stateManager - The StateManager

currentState -

awaitStates -

Method Detail

process

public boolean process(AMQState state)

When the state is changed this StateWaiter is notified to process the change.

Specified by:

process in class BlockingWaiter<AMQState>

Parameters:

state - The new state that has been achieved.

Returns:

getConnectionDetails

public String getConnectionDetails()

Specified by:

getConnectionDetails in class BlockingWaiter<AMQState>

await

public AMQState await()
               throws QpidException

Await for the required State to be achieved within the default timeout.

Returns:

The achieved state that was requested.

Throws:

QpidException - The exception that prevented the required state from being achieved.

await

public AMQState await(long timeout)
               throws QpidException

Await for the required State to be achieved.

It is the responsibility of this class to remove the waiter from the StateManager

Parameters:

timeout - The time in milliseconds to wait for any of the states to be achieved.

Returns:

The achieved state that was requested.

Throws:

QpidException - The exception that prevented the required state from being achieved.