Package org.apache.http.nio.protocol

Class NullRequestConsumer

java.lang.Object

org.apache.http.nio.protocol.NullRequestConsumer

All Implemented Interfaces:

Closeable, AutoCloseable, HttpAsyncRequestConsumer<Object>

class NullRequestConsumer
extends Object
implements HttpAsyncRequestConsumer<Object>

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuffer	buffer
private boolean	completed

Constructor Summary

Constructors

Constructor	Description
NullRequestConsumer()

Method Summary

Modifier and Type	Method	Description
void	close()
void	consumeContent(ContentDecoder decoder, IOControl ioControl)	Invoked to process a chunk of content from the ContentDecoder.
void	failed(Exception ex)	Invoked to signal that the request processing terminated abnormally.
Exception	getException()	Returns an exception in case of an abnormal termination.
Object	getResult()	Returns a result of the request execution, when available.
boolean	isDone()	Determines whether or not the request execution completed.
void	requestCompleted(HttpContext context)	Invoked to signal that the request has been fully processed.
void	requestReceived(HttpRequest request)	Invoked when a HTTP request message is received.

Methods inherited from class java.lang.Object

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

Field Details

buffer

private final ByteBuffer buffer

completed

private volatile boolean completed

Constructor Details

NullRequestConsumer

NullRequestConsumer()

Method Details

requestReceived

public void requestReceived(HttpRequest request)

Description copied from interface: HttpAsyncRequestConsumer

Invoked when a HTTP request message is received. Please note that the HttpAsyncRequestConsumer.consumeContent(ContentDecoder, IOControl) method will be invoked only for if the request message implements HttpEntityEnclosingRequest interface and has a content entity enclosed.

Specified by:

requestReceived in interface HttpAsyncRequestConsumer<Object>

Parameters:

request - HTTP request message.

consumeContent

public void consumeContent(ContentDecoder decoder,
 IOControl ioControl)
                    throws IOException

Description copied from interface: HttpAsyncRequestConsumer

Invoked to process a chunk of content from the ContentDecoder. The IOControl interface can be used to suspend input event notifications if the consumer is temporarily unable to process content.

The consumer can use the ContentDecoder.isCompleted() method to find out whether or not the message content has been fully consumed.

Please note that the ContentDecoder object is not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on other thread to resume input event notifications when the consumer is capable of processing more content.

Specified by:

consumeContent in interface HttpAsyncRequestConsumer<Object>

Parameters:

decoder - content decoder.

ioControl - I/O control of the underlying connection.

Throws:

IOException - in case of an I/O error

requestCompleted

public void requestCompleted(HttpContext context)

Description copied from interface: HttpAsyncRequestConsumer

Invoked to signal that the request has been fully processed.

Specified by:

requestCompleted in interface HttpAsyncRequestConsumer<Object>

Parameters:

context - HTTP context

failed

public void failed(Exception ex)

Description copied from interface: HttpAsyncRequestConsumer

Invoked to signal that the request processing terminated abnormally.

Specified by:

failed in interface HttpAsyncRequestConsumer<Object>

Parameters:

ex - exception

getResult

public Object getResult()

Description copied from interface: HttpAsyncRequestConsumer

Returns a result of the request execution, when available. This method returns null if the request execution is still ongoing.

Specified by:

getResult in interface HttpAsyncRequestConsumer<Object>

See Also:

• HttpAsyncRequestConsumer.isDone()

getException

public Exception getException()

Description copied from interface: HttpAsyncRequestConsumer

Returns an exception in case of an abnormal termination. This method returns null if the request execution is still ongoing or if it completed successfully.

Specified by:

getException in interface HttpAsyncRequestConsumer<Object>

See Also:

• HttpAsyncRequestConsumer.isDone()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isDone

public boolean isDone()

Description copied from interface: HttpAsyncRequestConsumer

Determines whether or not the request execution completed. If the request processing terminated normally HttpAsyncRequestConsumer.getResult() can be used to obtain the result. If the request processing terminated abnormally HttpAsyncRequestConsumer.getException() can be used to obtain the cause.

Specified by:

isDone in interface HttpAsyncRequestConsumer<Object>