View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.nio.protocol;
29  
30  import org.apache.http.ConnectionReuseStrategy;
31  import org.apache.http.protocol.HttpContext;
32  import org.apache.http.protocol.HttpProcessor;
33  
34  /**
35   * <tt>HttpAsyncRequestExecutionHandler</tt> represents a callback interface
36   * that combines functionality of {@link HttpAsyncRequestProducer} and
37   * {@link HttpAsyncResponseConsumer} and is capable of handling logically
38   * related series of HTTP request / response exchanges.
39   *
40   * @param <T> the result type of request execution.
41   * @since 4.2
42   */
43  public interface HttpAsyncRequestExecutionHandler<T>
44      extends HttpAsyncRequestProducer, HttpAsyncResponseConsumer<T> {
45  
46      /**
47       * Returns shared {@link HttpContext} instance.
48       *
49       * @return HTTP context
50       */
51      HttpContext getContext();
52  
53      /**
54       * Returns {@link HttpProcessor} implementation to be used to process
55       * HTTP request and response messages for protocol compliance.
56       *
57       * @return HTTP protocol processor.
58       */
59      HttpProcessor getHttpProcessor();
60  
61      /**
62       * Returns {@link ConnectionReuseStrategy} implementation to be used
63       * to determine whether or not the underlying connection can be kept alive
64       * after a particular HTTP request / response exchange.
65       *
66       * @return connection re-use strategy.
67       */
68      ConnectionReuseStrategy getConnectionReuseStrategy();
69  
70  }