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.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.NoHttpResponseException;
36  import org.apache.hc.core5.http.config.Http1Config;
37  import org.apache.hc.core5.http.message.LineParser;
38  import org.apache.hc.core5.http.message.StatusLine;
39  import org.apache.hc.core5.util.CharArrayBuffer;
40  
41  /**
42   * HTTP response parser that obtain its input from an instance
43   * of {@link org.apache.hc.core5.http.io.SessionInputBuffer}.
44   *
45   * @since 4.2
46   */
47  public class DefaultHttpResponseParser extends AbstractMessageParser<ClassicHttpResponse> {
48  
49      private final HttpResponseFactory<ClassicHttpResponse> responseFactory;
50  
51      /**
52       * Creates new instance of DefaultHttpResponseParser.
53       *
54       * @param lineParser the line parser. If {@code null}
55       *   {@link org.apache.hc.core5.http.message.LazyLineParser#INSTANCE} will be used
56       * @param responseFactory the response factory. If {@code null}
57       *   {@link DefaultClassicHttpResponseFactory#INSTANCE} will be used.
58       * @param http1Config the message http1Config. If {@code null}
59       *   {@link Http1Config#DEFAULT} will be used.
60       *
61       * @since 4.3
62       */
63      public DefaultHttpResponseParser(
64              final LineParser lineParser,
65              final HttpResponseFactory<ClassicHttpResponse> responseFactory,
66              final Http1Config http1Config) {
67          super(lineParser, http1Config);
68          this.responseFactory = responseFactory != null ? responseFactory : DefaultClassicHttpResponseFactory.INSTANCE;
69      }
70  
71      /**
72       * @since 4.3
73       */
74      public DefaultHttpResponseParser(final Http1Config http1Config) {
75          this(null, null, http1Config);
76      }
77  
78      /**
79       * @since 4.3
80       */
81      public DefaultHttpResponseParser() {
82          this(Http1Config.DEFAULT);
83      }
84  
85      @Override
86      protected IOException createConnectionClosedException() {
87          return new NoHttpResponseException("The target server failed to respond");
88      }
89  
90      @Override
91      protected ClassicHttpResponse createMessage(final CharArrayBuffer buffer) throws IOException, HttpException {
92          final StatusLine statusline = getLineParser().parseStatusLine(buffer);
93          final ClassicHttpResponse response = this.responseFactory.newHttpResponse(statusline.getStatusCode(), statusline.getReasonPhrase());
94          response.setVersion(statusline.getProtocolVersion());
95          return response;
96      }
97  
98  }