io.openio.sds

Class RequestContext

java.lang.Object

io.openio.sds.RequestContext

public class RequestContext
extends java.lang.Object

Generic parameters and context for all OpenIO SDS requests, including a request ID, a timeout (or deadline), etc.

Constructor Summary

Constructors

Constructor and Description
RequestContext() Build a new RequestContext with a default 30s timeout.
RequestContext(RequestContext src) Copy constructor.

Method Summary

Modifier and Type	Method and Description
RequestContext	computeDeadline() Compute a deadline from the timeout().
int	deadline() Get the deadline for this request.
int	elapsed() Tell the time elapsed since this request has started.
RequestContext	ensureRequestId() Ensure this request has an ID and it is at least 8 characters.
boolean	hasDeadline() Tell whether this request has a deadline or not.
boolean	hasStarted() Tell if this request has started.
boolean	hasTimeout() Tell whether this request has a timeout or not.
java.lang.String	requestId() Get the request ID.
RequestContext	resetDeadline() Reset the deadline set on this request.
RequestContext	startTiming() Start timing this request.
int	timeout() Get the timeout for the request.
RequestContext	withDeadline(int deadline) Set a deadline on the whole request.
RequestContext	withRequestId(java.lang.String requestId) Set a request ID.
RequestContext	withTimeout(int timeout) Set a timeout for each unique sub-request resulting from an API call.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestContext

public RequestContext()

Build a new RequestContext with a default 30s timeout.

RequestContext

public RequestContext(RequestContext src)

Copy constructor. Build a new RequestContext from another one. This will keep the request ID, the timeout and the deadline (if there is one).

Parameters:

src - The RequestContext to copy.

Method Detail

ensureRequestId

public RequestContext ensureRequestId()

Ensure this request has an ID and it is at least 8 characters.

Returns:

this

requestId

public java.lang.String requestId()

Get the request ID.

Returns:

the request ID (auto-generated if not set)

withRequestId

public RequestContext withRequestId(java.lang.String requestId)

Set a request ID.

Parameters:

requestId - a request ID string. If is null, it will be auto-generated. If it is less than 8 characters, it will be suffixed.

Returns:

this

computeDeadline

public RequestContext computeDeadline()

Compute a deadline from the timeout(). This also means that the timeout will be recomputed for each unique sub-request resulting from an API call. If this request has started, compute the timeout from the start, otherwise compute it from now.

Returns:

this

deadline

public int deadline()

Get the deadline for this request. If a timeout has been set (withTimeout(int)) but no deadline, computeDeadline() will be called.

Returns:

the overall deadline for this request, in milliseconds

elapsed

public int elapsed()

Tell the time elapsed since this request has started.

Returns:

the duration since this request has started, in milliseconds

hasDeadline

public boolean hasDeadline()

Tell whether this request has a deadline or not. This will always return true after computeDeadline() or deadline() has been called.

Returns:

true if this request has a deadline.

hasStarted

public boolean hasStarted()

Tell if this request has started.

Returns:

true if this request has started.

hasTimeout

public boolean hasTimeout()

Tell whether this request has a timeout or not.

Returns:

true if this request has timeout.

resetDeadline

public RequestContext resetDeadline()

Reset the deadline set on this request. This must be called when reusing a context only for its timeout and request ID.

Returns:

this

startTiming

public RequestContext startTiming()

Start timing this request.

Returns:

this

timeout

public int timeout()

Get the timeout for the request. If hasDeadline() returns true, successive calls to this method will return decreasing values, and negative values when the deadline has been exceeded.

Returns:

the timeout for this request, in milliseconds

withDeadline

public RequestContext withDeadline(int deadline)

Set a deadline on the whole request. This will reset any previous timeout set with withTimeout(int) to the duration from now to the deadline.

Parameters:

deadline - the deadline in milliseconds

Returns:

this

withTimeout

public RequestContext withTimeout(int timeout)

Set a timeout for each unique sub-request resulting from an API call. This will reset any previous deadline set with withDeadline(int). The timeout will be used to compute the deadline when startTiming() or deadline() is called.

Parameters:

timeout - a timeout in milliseconds

Returns:

this