Package org.eclipse.jetty.client.util

Class BufferingResponseListener

java.lang.Object

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

org.eclipse.jetty.client.util.BufferingResponseListener

All Implemented Interfaces:

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

Direct Known Subclasses:

ContinueProtocolHandler.ContinueListener, FutureResponseListener

public abstract class BufferingResponseListener
extends Response.Listener.Adapter

Implementation of Response.Listener that buffers the content up to a maximum length specified to the constructors.

The content may be retrieved from Response.Listener.onSuccess(Response) or onComplete(Result) via getContent() or getContentAsString().

Instances of this class are not reusable, so one must be allocated for each request.

Nested Class Summary

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

Response.Listener.Adapter

Constructor Summary

Constructors

Constructor	Description
BufferingResponseListener()	Creates an instance with a default maximum length of 2 MiB.
BufferingResponseListener(int maxLength)	Creates an instance with the given maximum length

Method Summary

Modifier and Type	Method	Description
byte[]	getContent()
InputStream	getContentAsInputStream()
String	getContentAsString()
String	getContentAsString(String encoding)
String	getContentAsString(Charset encoding)
String	getEncoding()
String	getMediaType()
abstract 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)	Callback method invoked when the response content has been received, parsed and there is demand.
void	onHeaders(Response response)	Callback method invoked when all the response headers have been received and parsed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.client.api.Response.AsyncContentListener

onContent

Methods inherited from interface org.eclipse.jetty.client.api.Response.ContentListener

onContent

Methods inherited from interface org.eclipse.jetty.client.api.Response.DemandedContentListener

onBeforeContent

Methods inherited from interface org.eclipse.jetty.client.api.Response.Listener

onBegin, onFailure, onHeader, onSuccess

Constructor Details

BufferingResponseListener

public BufferingResponseListener()

Creates an instance with a default maximum length of 2 MiB.

BufferingResponseListener

public BufferingResponseListener(int maxLength)

Creates an instance with the given maximum length

Parameters:

maxLength - the maximum length of the content

Method Details

onHeaders

public void onHeaders(Response response)

Description copied from interface: Response.HeadersListener

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

Parameters:

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

onContent

public void onContent(Response response,
 ByteBuffer content)

Description copied from interface: Response.ContentListener

Callback method invoked when the response content has been received, parsed and there is demand. This method may be invoked multiple times, and the content buffer must be consumed (or copied) before returning from this method.

Parameters:

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

content - the content bytes received

onComplete

public abstract 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.

Parameters:

result - the result of the request / response exchange

getMediaType

public String getMediaType()

getEncoding

public String getEncoding()

getContent

public byte[] getContent()

Returns:

the content as bytes

See Also:

• getContentAsString()

getContentAsString

public String getContentAsString()

Returns:

the content as a string, using the "Content-Type" header to detect the encoding or defaulting to UTF-8 if the encoding could not be detected.

See Also:

• getContentAsString(String)

getContentAsString

public String getContentAsString(String encoding)

Parameters:

encoding - the encoding of the content bytes

Returns:

the content as a string, with the specified encoding

See Also:

• getContentAsString()

getContentAsString

public String getContentAsString(Charset encoding)

Parameters:

encoding - the encoding of the content bytes

Returns:

the content as a string, with the specified encoding

See Also:

• getContentAsString()

getContentAsInputStream

public InputStream getContentAsInputStream()

Returns:

Content as InputStream