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.hc.core5.http.protocol;
29  
30  import java.io.IOException;
31  
32  import org.apache.hc.core5.annotation.Contract;
33  import org.apache.hc.core5.annotation.ThreadingBehavior;
34  import org.apache.hc.core5.http.EntityDetails;
35  import org.apache.hc.core5.http.HttpException;
36  import org.apache.hc.core5.http.HttpResponse;
37  import org.apache.hc.core5.http.HttpResponseInterceptor;
38  import org.apache.hc.core5.http.HttpStatus;
39  import org.apache.hc.core5.http.ProtocolException;
40  import org.apache.hc.core5.util.Args;
41  
42  /**
43   * This response interceptor is responsible for making the protocol conformance checks
44   * of outgoing response messages.
45   * <p>
46   * This interceptor is essential for the HTTP protocol conformance and
47   * the correct operation of the server-side message processing pipeline.
48   * </p>
49   *
50   * @since 5.3
51   */
52  @Contract(threading = ThreadingBehavior.IMMUTABLE)
53  public class ResponseConformance implements HttpResponseInterceptor {
54  
55      public static final ResponseConformance INSTANCE = new ResponseConformance();
56  
57      public ResponseConformance() {
58          super();
59      }
60  
61      @Override
62      public void process(final HttpResponse response, final EntityDetails entity, final HttpContext context)
63              throws HttpException, IOException {
64          Args.notNull(response, "HTTP response");
65          final int status = response.getCode();
66          switch (status) {
67              case HttpStatus.SC_NO_CONTENT:
68              case HttpStatus.SC_NOT_MODIFIED:
69                  if (entity != null) {
70                      throw new ProtocolException("Response " + status + " must not enclose an entity");
71                  }
72          }
73      }
74  
75  }