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.client5.http.impl.io;
29  
30  import java.io.IOException;
31  
32  import org.apache.hc.core5.http.ClassicHttpResponse;
33  import org.apache.hc.core5.http.HttpException;
34  import org.apache.hc.core5.http.HttpResponseFactory;
35  import org.apache.hc.core5.http.config.Http1Config;
36  import org.apache.hc.core5.http.impl.io.DefaultHttpResponseParser;
37  import org.apache.hc.core5.http.message.LineParser;
38  import org.apache.hc.core5.util.CharArrayBuffer;
39  import org.slf4j.Logger;
40  import org.slf4j.LoggerFactory;
41  
42  /**
43   * Lenient HTTP response parser implementation that can skip malformed data until
44   * a valid HTTP response message head is encountered.
45   *
46   * @since 4.2
47   */
48  public class LenientHttpResponseParser extends DefaultHttpResponseParser {
49  
50      private static final Logger LOG = LoggerFactory.getLogger(LenientHttpResponseParser.class);
51  
52      /**
53       * Creates new instance of DefaultHttpResponseParser.
54       *
55       * @param lineParser      the line parser. If {@code null}
56       *                        {@link org.apache.hc.core5.http.message.BasicLineParser#INSTANCE} will be used.
57       * @param responseFactory HTTP response factory. If {@code null}
58       *                        {@link org.apache.hc.core5.http.impl.io.DefaultClassicHttpResponseFactory#INSTANCE}
59       *                        will be used.
60       * @param h1Config        HTTP/1.1 parameters. If {@code null}. {@link Http1Config#DEFAULT} will be used.
61       *
62       * @since 4.3
63       */
64      public LenientHttpResponseParser(
65              final LineParser lineParser,
66              final HttpResponseFactory<ClassicHttpResponse> responseFactory,
67              final Http1Config h1Config) {
68          super(lineParser, responseFactory, h1Config);
69      }
70  
71      /**
72       * Creates new instance of DefaultHttpResponseParser.
73       *
74       * @param h1Config        HTTP/1.1 parameters. If {@code null}. {@link Http1Config#DEFAULT} will be used.
75       *
76       * @since 4.3
77       */
78      public LenientHttpResponseParser(final Http1Config h1Config) {
79          this(null, null, h1Config);
80      }
81  
82      @Override
83      protected ClassicHttpResponse createMessage(final CharArrayBuffer buffer) throws IOException {
84          try {
85              return super.createMessage(buffer);
86          } catch (final HttpException ex) {
87              if (LOG.isDebugEnabled()) {
88                  LOG.debug("Garbage in response: {}", buffer);
89              }
90              return null;
91          }
92      }
93  
94  }