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