|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NHttpRequestExecutionHandler
HTTP request execution handler can be used by client-side protocol handlers
to trigger the submission of a new HTTP request and the processing of an HTTP
response. When a new response entity is available for consumption,
responseEntity(HttpResponse, HttpContext)
is called.
After the ConsumingNHttpEntity
consumes the response body,
handleResponse(HttpResponse, HttpContext)
is notified that the
response is fully read.
Method Summary | |
---|---|
void |
finalizeContext(HttpContext context)
Triggered when the connection is terminated. |
void |
handleResponse(HttpResponse response,
HttpContext context)
Triggered when an HTTP response is ready to be processed. |
void |
initalizeContext(HttpContext context,
Object attachment)
Triggered when a new connection has been established and the HTTP context needs to be initialized. |
ConsumingNHttpEntity |
responseEntity(HttpResponse response,
HttpContext context)
Triggered when a response is received with an entity. |
HttpRequest |
submitRequest(HttpContext context)
Triggered when the underlying connection is ready to send a new HTTP request to the target host. |
Method Detail |
---|
void initalizeContext(HttpContext context, Object attachment)
The attachment object is the same object which was passed to the connecting I/O reactor when the connection request was made. The attachment may optionally contain some state information required in order to correctly initalize the HTTP context.
context
- the actual HTTP contextattachment
- the object passed to the connecting I/O reactor
upon the request for a new connection.ConnectingIOReactor.connect(java.net.SocketAddress, java.net.SocketAddress, java.lang.Object, org.apache.http.nio.reactor.SessionRequestCallback)
HttpRequest submitRequest(HttpContext context)
null if the client is not yet ready to send a
request. In this case the connection will remain open and
can be activated at a later point.
If the request has an entity, the entity must be an
instance of ProducingNHttpEntity
.
- Parameters:
context
- the actual HTTP context
- Returns:
- an HTTP request to be sent or
null if no
request needs to be sent
ConsumingNHttpEntity responseEntity(HttpResponse response, HttpContext context) throws IOException
ConsumingNHttpEntity
that will be used to consume the
entity. null
is a valid response value, and will indicate
that the entity should be silently ignored.
After the entity is fully consumed,
handleResponse(HttpResponse, HttpContext)
is called to notify a full response & entity are ready to be processed.
response
- The response containing the existing entity.context
- the actual HTTP context
IOException
void handleResponse(HttpResponse response, HttpContext context) throws IOException
response
- the HTTP response to be processedcontext
- the actual HTTP context
IOException
void finalizeContext(HttpContext context)
context
- the actual HTTP context
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |