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.impl.nio.codecs;
29  
30  import org.apache.http.HttpException;
31  import org.apache.http.HttpResponse;
32  import org.apache.http.HttpResponseFactory;
33  import org.apache.http.ParseException;
34  import org.apache.http.StatusLine;
35  import org.apache.http.config.MessageConstraints;
36  import org.apache.http.impl.DefaultHttpResponseFactory;
37  import org.apache.http.message.LineParser;
38  import org.apache.http.message.ParserCursor;
39  import org.apache.http.nio.reactor.SessionInputBuffer;
40  import org.apache.http.params.HttpParams;
41  import org.apache.http.util.Args;
42  import org.apache.http.util.CharArrayBuffer;
43  
44  /**
45   * Default {@link org.apache.http.nio.NHttpMessageParser} implementation
46   * for {@link HttpResponse}s.
47   *
48   * @since 4.1
49   */
50  @SuppressWarnings("deprecation")
51  public class DefaultHttpResponseParser extends AbstractMessageParser<HttpResponse> {
52  
53      private final HttpResponseFactory responseFactory;
54  
55      /**
56       * @deprecated (4.3) use
57       *   {@link DefaultHttpResponseParser#DefaultHttpResponseParser(
58       *   SessionInputBuffer, LineParser, HttpResponseFactory, MessageConstraints)}
59       */
60      @Deprecated
61      public DefaultHttpResponseParser(
62              final SessionInputBuffer buffer,
63              final LineParser parser,
64              final HttpResponseFactory responseFactory,
65              final HttpParams params) {
66          super(buffer, parser, params);
67          Args.notNull(responseFactory, "Response factory");
68          this.responseFactory = responseFactory;
69      }
70  
71      /**
72       * Creates an instance of DefaultHttpResponseParser.
73       *
74       * @param buffer the session input buffer.
75       * @param parser the line parser. If {@code null}
76       *   {@link org.apache.http.message.BasicLineParser#INSTANCE} will be used.
77       * @param responseFactory the response factory. If {@code null}
78       *   {@link DefaultHttpResponseFactory#INSTANCE} will be used.
79       * @param constraints Message constraints. If {@code null}
80       *   {@link MessageConstraints#DEFAULT} will be used.
81       *
82       * @since 4.3
83       */
84      public DefaultHttpResponseParser(
85              final SessionInputBuffer buffer,
86              final LineParser parser,
87              final HttpResponseFactory responseFactory,
88              final MessageConstraints constraints) {
89          super(buffer, parser, constraints);
90          this.responseFactory = responseFactory != null ? responseFactory :
91              DefaultHttpResponseFactory.INSTANCE;
92      }
93  
94      /**
95       * @since 4.3
96       */
97      public DefaultHttpResponseParser(final SessionInputBuffer buffer, final MessageConstraints constraints) {
98          this(buffer, null, null, constraints);
99      }
100 
101     /**
102      * @since 4.3
103      */
104     public DefaultHttpResponseParser(final SessionInputBuffer buffer) {
105         this(buffer, null);
106     }
107 
108     @Override
109     protected HttpResponse createMessage(final CharArrayBuffer buffer)
110             throws HttpException, ParseException {
111         final ParserCursor cursor = new ParserCursor(0, buffer.length());
112         final StatusLine statusline = lineParser.parseStatusLine(buffer, cursor);
113         return this.responseFactory.newHttpResponse(statusline, null);
114     }
115 
116 }