Package org.eclipse.jetty.client.util

Class InputStreamResponseListener

java.lang.Object

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

org.eclipse.jetty.client.util.InputStreamResponseListener

All Implemented Interfaces:

EventListener, Response.AsyncContentListener, Response.BeginListener, Response.CompleteListener, Response.ContentListener, Response.FailureListener, Response.HeaderListener, Response.HeadersListener, Response.Listener, Response.ResponseListener, Response.SuccessListener

public class InputStreamResponseListener
extends Response.Listener.Adapter

Implementation of Response.Listener that produces an InputStream that allows applications to read the response content.

Typical usage is:

 InputStreamResponseListener listener = new InputStreamResponseListener();
 client.newRequest(...).send(listener);

 // Wait for the response headers to arrive
 Response response = listener.get(5, TimeUnit.SECONDS);
 if (response.getStatus() == 200)
 {
     // Obtain the input stream on the response content
     try (InputStream input = listener.getInputStream())
     {
         // Read the response content
     }
 }
 

The HttpClient implementation (the producer) will feed the input stream asynchronously while the application (the consumer) is reading from it.

If the consumer is faster than the producer, then the consumer will block with the typical InputStream.read() semantic. If the consumer is slower than the producer, then the producer will block until the client consumes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.Response.Listener

Response.Listener.Adapter

Constructor Summary

Constructors

Constructor	Description
InputStreamResponseListener()

Method Summary

Modifier and Type	Method	Description
Result	await(long timeout, TimeUnit unit)	Waits for the given timeout for the whole request/response cycle to be finished, then returns the corresponding result.
Response	get(long timeout, TimeUnit unit)	Waits for the given timeout for the response to be available, then returns it.
InputStream	getInputStream()	Returns an InputStream providing the response content bytes.
void	onComplete(Result result)	Callback method invoked when the request and the response have been processed, either successfully or not.
void	onContent(Response response, ByteBuffer content, org.eclipse.jetty.util.Callback callback)	Callback method invoked asynchronously when the response content has been received.
void	onFailure(Response response, Throwable failure)	Callback method invoked when the response has failed in the process of being received
void	onHeaders(Response response)	Callback method invoked when the response headers have been received and parsed.
void	onSuccess(Response response)	Callback method invoked when the whole response has been successfully received.

Methods inherited from class org.eclipse.jetty.client.api.Response.Listener.Adapter

onBegin, onContent, onHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStreamResponseListener

public InputStreamResponseListener()

Method Detail

onHeaders

public void onHeaders(Response response)

Description copied from interface: Response.HeadersListener

Callback method invoked when the response headers have been received and parsed.

Specified by:

onHeaders in interface Response.HeadersListener

Overrides:

onHeaders in class Response.Listener.Adapter

Parameters:

response - the response containing the response line data and the headers

onContent

public void onContent(Response response,
                      ByteBuffer content,
                      org.eclipse.jetty.util.Callback callback)

Description copied from interface: Response.AsyncContentListener

Callback method invoked asynchronously when the response content has been received.

Specified by:

onContent in interface Response.AsyncContentListener

Overrides:

onContent in class Response.Listener.Adapter

Parameters:

response - the response containing the response line data and the headers

content - the content bytes received

callback - the callback to call when the content is consumed.

onSuccess

public void onSuccess(Response response)

Description copied from interface: Response.SuccessListener

Callback method invoked when the whole response has been successfully received.

Specified by:

onSuccess in interface Response.SuccessListener

Overrides:

onSuccess in class Response.Listener.Adapter

Parameters:

response - the response containing the response line data and the headers

onFailure

public void onFailure(Response response,
                      Throwable failure)

Description copied from interface: Response.FailureListener

Callback method invoked when the response has failed in the process of being received

Specified by:

onFailure in interface Response.FailureListener

Overrides:

onFailure in class Response.Listener.Adapter

Parameters:

response - the response containing data up to the point the failure happened

failure - the failure happened

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

Overrides:

onComplete in class Response.Listener.Adapter

Parameters:

result - the result of the request / response exchange

get

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

Waits for the given timeout for the response to be available, then returns it.

The wait ends as soon as all the HTTP headers have been received, without waiting for the content. To wait for the whole content, see await(long, TimeUnit).

Parameters:

timeout - the time to wait

unit - the timeout unit

Returns:

the response

Throws:

InterruptedException - if the thread is interrupted

TimeoutException - if the timeout expires

ExecutionException - if a failure happened

await

public Result await(long timeout,
                    TimeUnit unit)
             throws InterruptedException,
                    TimeoutException

Waits for the given timeout for the whole request/response cycle to be finished, then returns the corresponding result.

Parameters:

timeout - the time to wait

unit - the timeout unit

Returns:

the result

Throws:

InterruptedException - if the thread is interrupted

TimeoutException - if the timeout expires

See Also:

get(long, TimeUnit)

getInputStream

public InputStream getInputStream()

Returns an InputStream providing the response content bytes.

The method may be invoked only once; subsequent invocations will return a closed InputStream.

Returns:

an input stream providing the response content