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.message;
29  
30  import org.apache.hc.core5.http.Header;
31  import org.apache.hc.core5.http.ParseException;
32  import org.apache.hc.core5.util.CharArrayBuffer;
33  
34  /**
35   * Interface for parsing lines in the HEAD section of an HTTP message.
36   * There are individual methods for parsing a request line, a
37   * status line, or a header line.
38   * Instances of this interface are expected to be stateless and thread-safe.
39   *
40   * @since 4.0
41   */
42  public interface LineParser {
43  
44      /**
45       * Parses a request line from the given buffer containing one line of text.
46       *
47       * @param buffer    a buffer holding a line to parse
48       *
49       * @return  the parsed request line
50       *
51       * @throws ParseException        in case of a parse error
52       */
53      RequestLine parseRequestLine(CharArrayBuffer buffer) throws ParseException;
54  
55      /**
56       * Parses a status line from the given buffer containing one line of text.
57       *
58       * @param buffer    a buffer holding a line to parse
59       *
60       * @return  the parsed status line
61       *
62       * @throws ParseException        in case of a parse error
63       */
64      StatusLine parseStatusLine(CharArrayBuffer buffer) throws ParseException;
65  
66      /**
67       * Parses a header from the given buffer containing one line of text.
68       * The full header line is expected here. Header continuation
69       * lines must be joined by the caller before invoking this method.
70       *
71       * @param buffer    a buffer holding the full header line.
72       *
73       * @return  the header in the argument buffer.
74       *
75       * @throws ParseException        in case of a parse error
76       */
77      Header parseHeader(CharArrayBuffer buffer) throws ParseException;
78  
79  }