Class AbstractResponseListener

java.lang.Object

org.eclipse.jetty.client.AbstractResponseListener

All Implemented Interfaces:

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

Direct Known Subclasses:

BufferingResponseListener, RetainingResponseListener

public abstract class AbstractResponseListener
extends Object
implements Response.Listener

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResponseListener(RetainableByteBuffer.Mutable accumulator)

Method Summary

Modifier and Type	Method	Description
byte[]	getContent()
InputStream	getContentAsInputStream()
String	getContentAsString()
String	getContentAsString(String encoding)
String	getContentAsString(Charset charset)
String	getEncoding()
long	getMaxLength()
String	getMediaType()
void	onContent(Response response, ByteBuffer content)	Callback method invoked when the response content has been received, parsed and there is demand.
void	onContent(Response response, Content.Chunk chunk, Runnable demander)	Callback method invoked when the response content has been received, parsed and there is demand.
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 all 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 Object

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

Methods inherited from interface Response.AsyncContentListener

onContentSource

Methods inherited from interface Response.Listener

onBegin, onComplete, onHeader

Constructor Details

AbstractResponseListener

protected AbstractResponseListener(RetainableByteBuffer.Mutable accumulator)

Method Details

getMaxLength

public long getMaxLength()

getEncoding

public String getEncoding()

getMediaType

public String getMediaType()

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.

Specified by:

onHeaders in interface Response.HeadersListener

Specified by:

onHeaders in interface Response.Listener

Parameters:

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

onContent

public void onContent(Response response,
 Content.Chunk chunk,
 Runnable demander)
               throws Exception

Description copied from interface: Response.AsyncContentListener

Callback method invoked when the response content has been received, parsed and there is demand. The chunk must be consumed, copied, or retained before returning from this method as it is then automatically released. The demander must be run before this method may be invoked again.

Specified by:

onContent in interface Response.AsyncContentListener

Specified by:

onContent in interface Response.ContentListener

Parameters:

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

chunk - the chunk received

demander - the runnable to be run to demand the next chunk

Throws:

Exception - an uncaught exception will abort the response, release the chunk and fail the content source from which the chunk was read from

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. This method is also always invoked when content arrives as demand is automatically registered on return.

Specified by:

onContent in interface Response.ContentListener

Specified by:

onContent in interface Response.Listener

Parameters:

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

content - the content bytes received

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.Listener

Specified by:

onSuccess in interface Response.SuccessListener

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

Specified by:

onFailure in interface Response.Listener

Parameters:

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

failure - the failure happened

getContent

public byte[] getContent()

Returns:

the content as a byte array.

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 charset)

Parameters:

charset - the charset of the content bytes

Returns:

the content as a string, with the specified charset

See Also:

• getContentAsString()

getContentAsInputStream

public InputStream getContentAsInputStream()

Returns:

the content as InputStream