Package com.onshape.api.base

Class PollingHandler

java.lang.Object

com.onshape.api.base.PollingHandler

public class PollingHandler
extends Object

Utility class for polling GET methods

Author:

Peter Harman peter.harman@cae.tech

Method Summary

Modifier and Type	Method	Description
int	getInitialDelay()	Gets the initial delay in seconds used for polling methods.
int	getMaximumCalls()	Gets the maximum number of sequential calls for a single method.
int	getMaximumDelay()	Gets the maximum delay in seconds used for polling methods.
<T> CompletableFuture<T>	poll(String href, Class<T> responseType, Predicate<T> until)	Request the given URL until the predicate is satisfied on the response object.
void	setInitialDelay(int initialDelay)	Sets the initial delay in seconds used for polling methods.
void	setMaximumCalls(int maximumCalls)	Sets the maximum number of sequential calls for a single method.
void	setMaximumDelay(int maximumDelay)	Sets the maximum delay in seconds used for polling methods.

Methods inherited from class java.lang.Object

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

Method Detail

getInitialDelay

public int getInitialDelay()

Gets the initial delay in seconds used for polling methods.

Returns:

Initial delay in seconds

setInitialDelay

public void setInitialDelay(int initialDelay)

Sets the initial delay in seconds used for polling methods.

Parameters:

initialDelay - Initial delay in seconds

getMaximumDelay

public int getMaximumDelay()

Gets the maximum delay in seconds used for polling methods.

Returns:

Maximum delay in seconds

setMaximumDelay

public void setMaximumDelay(int maximumDelay)

Sets the maximum delay in seconds used for polling methods.

Parameters:

maximumDelay - Maximum delay in seconds

getMaximumCalls

public int getMaximumCalls()

Gets the maximum number of sequential calls for a single method.

Returns:

Maximum number of calls

setMaximumCalls

public void setMaximumCalls(int maximumCalls)

Sets the maximum number of sequential calls for a single method.

Parameters:

maximumCalls - Maximum number of calls

poll

public <T> CompletableFuture<T> poll(String href,
                                     Class<T> responseType,
                                     Predicate<T> until)

Request the given URL until the predicate is satisfied on the response object. Returns a CompletableFuture that supports blocking, cancellation or concurrent usage.

Type Parameters:

T - The response type

Parameters:

href - The URL

responseType - Class object of response type

until - Predicate to be satisfied

Returns:

A CompletableFuture of the response