com.cloudant.http

Class HttpConnectionInterceptorContext

java.lang.Object

com.cloudant.http.HttpConnectionInterceptorContext

public class HttpConnectionInterceptorContext
extends java.lang.Object

Provides the context for a HttpConnectionInterceptor.

The context is new for each request or replay of a request. If an interceptor instance needs to carry some state across replays of a request then the state must be stored using the setState(HttpConnectionInterceptor, String, Object) method and retrieved using the getState(HttpConnectionInterceptor, String, Class) method.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
HttpConnection	connection
boolean	replayRequest

Constructor Summary

Constructors

Constructor and Description
HttpConnectionInterceptorContext(HttpConnection connection) Constructor
HttpConnectionInterceptorContext(HttpConnectionInterceptorContext other) Shallow copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	getState(HttpConnectionInterceptor interceptor, java.lang.String stateName, java.lang.Class<T> stateType) Retrieve the state object associated with the specified interceptor instance and property name on this request context.
<T> void	setState(HttpConnectionInterceptor interceptor, java.lang.String stateName, T stateObjectToStore) Store some state on this request context associated with the specified interceptor instance.

Methods inherited from class java.lang.Object

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

Field Detail

replayRequest

public boolean replayRequest

connection

public final HttpConnection connection

Constructor Detail

HttpConnectionInterceptorContext

public HttpConnectionInterceptorContext(HttpConnection connection)

Constructor

Parameters:

connection - HttpConnection

HttpConnectionInterceptorContext

public HttpConnectionInterceptorContext(HttpConnectionInterceptorContext other)

Shallow copy constructor

Parameters:

other - Context to copy

Method Detail

setState

public <T> void setState(HttpConnectionInterceptor interceptor,
                         java.lang.String stateName,
                         T stateObjectToStore)

Store some state on this request context associated with the specified interceptor instance. Used where a single interceptor instance needs to associate state with each HTTP request.

Type Parameters:

T - the type of the state object to store

Parameters:

interceptor - the interceptor instance

stateName - the key to store the state object under

stateObjectToStore - the state object to store

Since:

2.6.0

See Also:

getState(HttpConnectionInterceptor, String, Class)

getState

public <T> T getState(HttpConnectionInterceptor interceptor,
                      java.lang.String stateName,
                      java.lang.Class<T> stateType)

Retrieve the state object associated with the specified interceptor instance and property name on this request context.

Type Parameters:

T - the type the stored state should be returned as

Parameters:

interceptor - the interceptor instance

stateName - the name key that the state object was stored under

stateType - class of the type the stored state should be returned as

Returns:

the stored state object

Since:

2.6.0

See Also:

setState(HttpConnectionInterceptor, String, Object)