public abstract class AbstractAsyncResponseConsumer<T> extends Object implements HttpAsyncResponseConsumer<T>
HttpAsyncResponseConsumer implementation that relieves its
subclasses from having to manage internal state and provides a number of protected
event methods that they need to implement.| Constructor and Description |
|---|
AbstractAsyncResponseConsumer() |
| Modifier and Type | Method and Description |
|---|---|
protected abstract T |
buildResult(HttpContext context)
Invoked to generate a result object from the received HTTP response
message.
|
boolean |
cancel()
Cancels the ongoing operation or process.
|
void |
close() |
void |
consumeContent(ContentDecoder decoder,
IOControl ioControl)
Use
onContentReceived(ContentDecoder, IOControl) instead. |
void |
failed(Exception ex)
Invoked to signal that the response processing terminated abnormally.
|
protected ContentType |
getContentType(HttpEntity entity) |
Exception |
getException()
Returns an exception in case of an abnormal termination.
|
T |
getResult()
Returns a result of the response processing, when available.
|
boolean |
isDone()
Determines whether or not the response processing completed.
|
protected void |
onClose()
Invoked when the consumer is being closed.
|
protected abstract void |
onContentReceived(ContentDecoder decoder,
IOControl ioControl)
Invoked to process a chunk of content from the
ContentDecoder. |
protected abstract void |
onEntityEnclosed(HttpEntity entity,
ContentType contentType)
Invoked if the response message encloses a content entity.
|
protected abstract void |
onResponseReceived(HttpResponse response)
Invoked when a HTTP response message is received.
|
protected abstract void |
releaseResources()
Invoked to release all system resources currently allocated.
|
void |
responseCompleted(HttpContext context)
Use
buildResult(HttpContext) instead. |
void |
responseReceived(HttpResponse response)
Use
onResponseReceived(HttpResponse) instead. |
protected abstract void onResponseReceived(HttpResponse response) throws HttpException, IOException
onContentReceived(ContentDecoder, IOControl) method
will be invoked only if the response messages has a content entity
enclosed.response - HTTP response message.HttpException - in case of HTTP protocol violationIOException - in case of an I/O errorprotected abstract void onContentReceived(ContentDecoder decoder, IOControl ioControl) throws IOException
ContentDecoder.
The IOControl interface can be used to suspend input events
if the consumer is temporarily unable to consume more content.
The consumer can use the ContentDecoder.isCompleted() method
to find out whether or not the message content has been fully consumed.
decoder - content decoder.ioControl - I/O control of the underlying connection.IOException - in case of an I/O errorprotected abstract void onEntityEnclosed(HttpEntity entity, ContentType contentType) throws IOException
entity - HTTP entitycontentType - expected content type.IOException - in case of an I/O errorprotected abstract T buildResult(HttpContext context) throws Exception
context - HTTP context.Exception - in case of an abnormal termination.protected abstract void releaseResources()
protected void onClose()
throws IOException
IOException - may be thrown by subclasssesprotected ContentType getContentType(HttpEntity entity)
public final void responseReceived(HttpResponse response) throws IOException, HttpException
onResponseReceived(HttpResponse) instead.responseReceived in interface HttpAsyncResponseConsumer<T>response - HTTP response message.IOException - in case of an I/O errorHttpException - in case of HTTP protocol violationpublic final void consumeContent(ContentDecoder decoder, IOControl ioControl) throws IOException
onContentReceived(ContentDecoder, IOControl) instead.consumeContent in interface HttpAsyncResponseConsumer<T>decoder - content decoder.ioControl - I/O control of the underlying connection.IOException - in case of an I/O errorpublic final void responseCompleted(HttpContext context)
buildResult(HttpContext) instead.responseCompleted in interface HttpAsyncResponseConsumer<T>context - HTTP contextpublic final boolean cancel()
Cancellablecancel in interface Cancellabletrue if the operation or process has been cancelled as a result of
this method call or false if it has already been cancelled or not started.public final void failed(Exception ex)
HttpAsyncResponseConsumerfailed in interface HttpAsyncResponseConsumer<T>ex - exceptionpublic final void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableIOExceptionpublic Exception getException()
HttpAsyncResponseConsumernull if the response processing is still ongoing
or if it completed successfully.getException in interface HttpAsyncResponseConsumer<T>HttpAsyncResponseConsumer.isDone()public T getResult()
HttpAsyncResponseConsumernull if the response processing is still ongoing.getResult in interface HttpAsyncResponseConsumer<T>HttpAsyncResponseConsumer.isDone()public boolean isDone()
HttpAsyncResponseConsumerHttpAsyncResponseConsumer.getResult()
can be used to obtain the result. If the response processing terminated
abnormally HttpAsyncResponseConsumer.getException() can be used to obtain the cause.isDone in interface HttpAsyncResponseConsumer<T>Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.