com.ibm.cloud.objectstorage.waiters

Class WaiterImpl<Input extends AmazonWebServiceRequest,Output>

java.lang.Object

com.ibm.cloud.objectstorage.waiters.WaiterImpl<Input,Output>

All Implemented Interfaces:

Waiter<Input>

public class WaiterImpl<Input extends AmazonWebServiceRequest,Output>
extends Object
implements Waiter<Input>

Constructor Summary

Constructors

Constructor and Description
WaiterImpl(WaiterBuilder<Input,Output> waiterBuilder) Constructs a new waiter with the given internal parameters

Method Summary

Modifier and Type	Method and Description
void	run(WaiterParameters<Input> waiterParameters) Polls synchronously until it is determined that the resource transitioned into the desired state or not.
Future<Void>	runAsync(WaiterParameters<Input> waiterParameters, WaiterHandler callback) Polls asynchronously until it is determined that the resource transitioned into the desired state or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

WaiterImpl

public WaiterImpl(WaiterBuilder<Input,Output> waiterBuilder)

Constructs a new waiter with the given internal parameters

Parameters:

waiterBuilder - Takes in default parameters and builds a basic waiter. Excludes request and custom polling strategy parameters.

Method Detail

run

public void run(WaiterParameters<Input> waiterParameters)
         throws AmazonServiceException,
                WaiterTimedOutException,
                WaiterUnrecoverableException

Polls synchronously until it is determined that the resource transitioned into the desired state or not.

Specified by:

run in interface Waiter<Input extends AmazonWebServiceRequest>

Parameters:

waiterParameters - Custom provided parameters. Includes request and optional custom polling strategy

Throws:

AmazonServiceException - If the service exception thrown doesn't match any of the expected exceptions, it's re-thrown.

WaiterUnrecoverableException - If the resource transitions into a failure/unexpected state.

WaiterTimedOutException - If the resource doesn't transition into the desired state even after a certain number of retries.

runAsync

public Future<Void> runAsync(WaiterParameters<Input> waiterParameters,
                             WaiterHandler callback)
                      throws AmazonServiceException,
                             WaiterTimedOutException,
                             WaiterUnrecoverableException

Polls asynchronously until it is determined that the resource transitioned into the desired state or not. Includes additional callback.

Specified by:

runAsync in interface Waiter<Input extends AmazonWebServiceRequest>

Parameters:

waiterParameters - Custom provided parameters. Includes request and optional custom polling strategy

callback - Custom callback

Returns:

Future object that holds the result of an asynchronous computation of waiter

Throws:

AmazonServiceException

WaiterTimedOutException

WaiterUnrecoverableException