Class FutureResponseListener

java.lang.Object

org.eclipse.jetty.client.api.Response.Listener.Adapter

org.eclipse.jetty.client.util.BufferingResponseListener

org.eclipse.jetty.client.util.FutureResponseListener

All Implemented Interfaces:

Future<ContentResponse>, EventListener, Response.AsyncContentListener, Response.BeginListener, Response.CompleteListener, Response.ContentListener, Response.DemandedContentListener, Response.FailureListener, Response.HeaderListener, Response.HeadersListener, Response.Listener, Response.ResponseListener, Response.SuccessListener

public class FutureResponseListener
extends BufferingResponseListener
implements Future<ContentResponse>

A BufferingResponseListener that is also a Future, to allow applications to block (indefinitely or for a timeout) until onComplete(Result) is called, or to abort the request/response conversation.

Typical usage is:

Request request = httpClient.newRequest(...)...;
FutureResponseListener listener = new FutureResponseListener(request);
request.send(listener); // Asynchronous send
ContentResponse response = listener.get(5, TimeUnit.SECONDS); // Timed block

Nested Class Summary

Nested classes/interfaces inherited from interface Response.Listener

Response.Listener.Adapter

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	cancelled
private Throwable	failure
private final CountDownLatch	latch
private final Request	request
private ContentResponse	response

Constructor Summary

Constructors

Constructor	Description
FutureResponseListener(Request request)
FutureResponseListener(Request request, int maxLength)

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)
ContentResponse	get()
ContentResponse	get(long timeout, TimeUnit unit)
Request	getRequest()
private ContentResponse	getResult()
boolean	isCancelled()
boolean	isDone()
void	onComplete(Result result)	Callback method invoked when the request and the response have been processed, either successfully or not.

Methods inherited from class BufferingResponseListener

getContent, getContentAsInputStream, getContentAsString, getContentAsString, getContentAsString, getEncoding, getMediaType, onContent, onHeaders

Methods inherited from class Object

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

Methods inherited from interface Response.AsyncContentListener

onContent

Methods inherited from interface Response.ContentListener

onContent

Methods inherited from interface Response.DemandedContentListener

onBeforeContent

Methods inherited from interface Response.Listener

onBegin, onFailure, onHeader, onSuccess

Field Details

latch

private final CountDownLatch latch

request

private final Request request

response

private ContentResponse response

failure

private Throwable failure

cancelled

private volatile boolean cancelled

Constructor Details

FutureResponseListener

public FutureResponseListener(Request request)

FutureResponseListener

public FutureResponseListener(Request request,
 int maxLength)

Method Details

getRequest

public Request getRequest()

onComplete

public void onComplete(Result result)

Description copied from interface: Response.CompleteListener

Callback method invoked when the request and the response have been processed, either successfully or not.

The result parameter contains the request, the response, and eventual failures.

Requests may complete after response, for example in case of big uploads that are discarded or read asynchronously by the server. This method is always invoked after Response.SuccessListener.onSuccess(Response) or Response.FailureListener.onFailure(Response, Throwable), and only when request indicates that it is completed.

Specified by:

onComplete in interface Response.CompleteListener

Specified by:

onComplete in interface Response.Listener

Specified by:

onComplete in class BufferingResponseListener

Parameters:

result - the result of the request / response exchange

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<ContentResponse>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<ContentResponse>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<ContentResponse>

get

public ContentResponse get()
                    throws InterruptedException,
ExecutionException

Specified by:

get in interface Future<ContentResponse>

Throws:

InterruptedException

ExecutionException

get

public ContentResponse get(long timeout,
 TimeUnit unit)
                    throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

get in interface Future<ContentResponse>

Throws:

InterruptedException

ExecutionException

TimeoutException

getResult

private ContentResponse getResult()
                           throws ExecutionException

Throws:

ExecutionException