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.protocol;
29  
30  import org.apache.http.HttpRequestInterceptor;
31  import org.apache.http.HttpResponseInterceptor;
32  
33  /**
34   * HTTP protocol processor is a collection of protocol interceptors that
35   * implements the 'Chain of Responsibility' pattern, where each individual
36   * protocol interceptor is expected to work on a particular aspect of the HTTP
37   * protocol the interceptor is responsible for.
38   * <p>
39   * Usually the order in which interceptors are executed should not matter as
40   * long as they do not depend on a particular state of the execution context.
41   * If protocol interceptors have interdependencies and therefore must be
42   * executed in a particular order, they should be added to the protocol
43   * processor in the same sequence as their expected execution order.
44   * <p>
45   * Protocol interceptors must be implemented as thread-safe. Similarly to
46   * servlets, protocol interceptors should not use instance variables unless
47   * access to those variables is synchronized.
48   *
49   * @since 4.0
50   */
51  public interface HttpProcessor
52      extends HttpRequestInterceptor, HttpResponseInterceptor {
53  
54      // no additional methods
55  }