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