/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
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. * * @see org.apache.http.nio.reactor.ConnectingIOReactor#connect * * @param context the actual HTTP context * @param attachment the object passed to the connecting I/O reactor * upon the request for a new connection. */ void initalizeContext(HttpContext context, Object attachment); /** * Triggered when the underlying connection is ready to send a new * HTTP request to the target host. This method may return * {@code 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 {@link org.apache.http.nio.entity.ProducingNHttpEntity}. * * @param context the actual HTTP context * @return an HTTP request to be sent or {@code null} if no * request needs to be sent */ HttpRequest submitRequest(HttpContext context); /** * Triggered when a response is received with an entity. This method should * return a {@link ConsumingNHttpEntity} that will be used to consume the * entity. {@code null} is a valid response value, and will indicate * that the entity should be silently ignored. *
* After the entity is fully consumed, * {@link NHttpRequestExecutionHandler#handleResponse(HttpResponse, HttpContext)} * is called to notify a full response & entity are ready to be processed. * * @param response * The response containing the existing entity. * @param context * the actual HTTP context * @return An entity that will asynchronously consume the response's content * body. */ ConsumingNHttpEntity responseEntity(HttpResponse response, HttpContext context) throws IOException; /** * Triggered when an HTTP response is ready to be processed. * * @param response * the HTTP response to be processed * @param context * the actual HTTP context */ void handleResponse(HttpResponse response, HttpContext context) throws IOException; /** * Triggered when the connection is terminated. This event can be used * to release objects stored in the context or perform some other kind * of cleanup. * * @param context the actual HTTP context */ void finalizeContext(HttpContext context); }