Package org.apache.http.nio.protocol
Class AbstractAsyncRequestConsumer<T>
java.lang.Object
org.apache.http.nio.protocol.AbstractAsyncRequestConsumer<T>
- All Implemented Interfaces:
Closeable
,AutoCloseable
,HttpAsyncRequestConsumer<T>
- Direct Known Subclasses:
BasicAsyncRequestConsumer
public abstract class AbstractAsyncRequestConsumer<T>
extends Object
implements HttpAsyncRequestConsumer<T>
Abstract
HttpAsyncRequestConsumer
implementation that relieves its
subclasses from having to manage internal state and provides a number of protected
event methods that they need to implement.- Since:
- 4.2
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract T
buildResult
(HttpContext context) Invoked to generate a result object from the received HTTP request message.final void
close()
final void
consumeContent
(ContentDecoder decoder, IOControl ioControl) UseonContentReceived(ContentDecoder, IOControl)
instead.final void
Invoked to signal that the request processing terminated abnormally.Returns an exception in case of an abnormal termination.Returns a result of the request execution, when available.boolean
isDone()
Determines whether or not the request execution 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 theContentDecoder
.protected abstract void
onEntityEnclosed
(HttpEntity entity, ContentType contentType) Invoked if the request message encloses a content entity.protected abstract void
onRequestReceived
(HttpRequest request) Invoked when a HTTP request message is received.protected abstract void
Invoked to release all system resources currently allocated.final void
requestCompleted
(HttpContext context) UsebuildResult(HttpContext)
instead.final void
requestReceived
(HttpRequest request) UseonRequestReceived(HttpRequest)
instead.
-
Field Details
-
completed
-
result
-
ex
-
-
Constructor Details
-
AbstractAsyncRequestConsumer
public AbstractAsyncRequestConsumer()
-
-
Method Details
-
onRequestReceived
Invoked when a HTTP request message is received. Please note that theonContentReceived(ContentDecoder, IOControl)
method will be invoked only for if the request message implementsHttpEntityEnclosingRequest
interface and has a content entity enclosed.- Parameters:
request
- HTTP request message.- Throws:
HttpException
- in case of HTTP protocol violationIOException
- in case of an I/O error
-
onEntityEnclosed
protected abstract void onEntityEnclosed(HttpEntity entity, ContentType contentType) throws IOException Invoked if the request message encloses a content entity.- Parameters:
entity
- HTTP entitycontentType
- expected content type.- Throws:
IOException
- in case of an I/O error
-
onContentReceived
protected abstract void onContentReceived(ContentDecoder decoder, IOControl ioControl) throws IOException Invoked to process a chunk of content from theContentDecoder
. TheIOControl
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.- Parameters:
decoder
- content decoder.ioControl
- I/O control of the underlying connection.- Throws:
IOException
- in case of an I/O error
-
buildResult
Invoked to generate a result object from the received HTTP request message.- Parameters:
context
- HTTP context.- Returns:
- result of the request processing.
- Throws:
Exception
- in case of an abnormal termination.
-
releaseResources
protected abstract void releaseResources()Invoked to release all system resources currently allocated. -
onClose
Invoked when the consumer is being closed.- Throws:
IOException
- may be thrown by subclassses- Since:
- 4.3
-
requestReceived
UseonRequestReceived(HttpRequest)
instead.- Specified by:
requestReceived
in interfaceHttpAsyncRequestConsumer<T>
- Parameters:
request
- HTTP request message.- Throws:
HttpException
- in case of HTTP protocol violationIOException
- in case of an I/O error
-
consumeContent
UseonContentReceived(ContentDecoder, IOControl)
instead.- Specified by:
consumeContent
in interfaceHttpAsyncRequestConsumer<T>
- Parameters:
decoder
- content decoder.ioControl
- I/O control of the underlying connection.- Throws:
IOException
- in case of an I/O error
-
requestCompleted
UsebuildResult(HttpContext)
instead.- Specified by:
requestCompleted
in interfaceHttpAsyncRequestConsumer<T>
- Parameters:
context
- HTTP context
-
failed
Description copied from interface:HttpAsyncRequestConsumer
Invoked to signal that the request processing terminated abnormally.- Specified by:
failed
in interfaceHttpAsyncRequestConsumer<T>
- Parameters:
ex
- exception
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
getException
Description copied from interface:HttpAsyncRequestConsumer
Returns an exception in case of an abnormal termination. This method returnsnull
if the request execution is still ongoing or if it completed successfully.- Specified by:
getException
in interfaceHttpAsyncRequestConsumer<T>
- See Also:
-
getResult
Description copied from interface:HttpAsyncRequestConsumer
Returns a result of the request execution, when available. This method returnsnull
if the request execution is still ongoing.- Specified by:
getResult
in interfaceHttpAsyncRequestConsumer<T>
- See Also:
-
isDone
public boolean isDone()Description copied from interface:HttpAsyncRequestConsumer
Determines whether or not the request execution completed. If the request processing terminated normallyHttpAsyncRequestConsumer.getResult()
can be used to obtain the result. If the request processing terminated abnormallyHttpAsyncRequestConsumer.getException()
can be used to obtain the cause.- Specified by:
isDone
in interfaceHttpAsyncRequestConsumer<T>
-