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 java.io.Serializable;
31  
32  import org.apache.hc.core5.http.FormattedHeader;
33  import org.apache.hc.core5.http.ParseException;
34  import org.apache.hc.core5.util.Args;
35  import org.apache.hc.core5.util.CharArrayBuffer;
36  
37  /**
38   * This class represents a raw HTTP header whose content is parsed 'on demand'
39   * only when the header value needs to be consumed.
40   *
41   * @since 4.0
42   */
43  public class BufferedHeader implements FormattedHeader, Serializable {
44  
45      private static final long serialVersionUID = -2768352615787625448L;
46  
47      /**
48       * Header name.
49       */
50      private final String name;
51  
52      /**
53       * The buffer containing the entire header line.
54       */
55      private final CharArrayBuffer buffer;
56  
57      /**
58       * The beginning of the header value in the buffer
59       */
60      private final int valuePos;
61  
62      /**
63       * @since 5.0
64       */
65      public static BufferedHeader create(final CharArrayBuffer buffer) {
66          try {
67              return new BufferedHeader(buffer);
68          } catch (final ParseException ex) {
69              throw new IllegalArgumentException(ex.getMessage());
70          }
71      }
72  
73      /**
74       * Creates a new header from a buffer.
75       * The name of the header will be parsed immediately,
76       * the value only if it is accessed.
77       *
78       * @param buffer    the buffer containing the header to represent
79       *
80       * @throws ParseException   in case of a parse error
81       */
82      public BufferedHeader(final CharArrayBuffer buffer) throws ParseException {
83          this(buffer, true);
84      }
85  
86      BufferedHeader(final CharArrayBuffer buffer, final boolean strict) throws ParseException {
87          super();
88          Args.notNull(buffer, "Char array buffer");
89          final int colon = buffer.indexOf(':');
90          if (colon <= 0) {
91              throw new ParseException("Invalid header", buffer, 0, buffer.length());
92          }
93          if (strict && TokenParser.isWhitespace(buffer.charAt(colon - 1))) {
94              throw new ParseException("Invalid header", buffer, 0, buffer.length(), colon - 1);
95          }
96          final String s = buffer.substringTrimmed(0, colon);
97          if (s.length() == 0) {
98              throw new ParseException("Invalid header", buffer, 0, buffer.length(), colon);
99          }
100         this.buffer = buffer;
101         this.name = s;
102         this.valuePos = colon + 1;
103     }
104 
105     @Override
106     public String getName() {
107         return this.name;
108     }
109 
110     @Override
111     public String getValue() {
112         return this.buffer.substringTrimmed(this.valuePos, this.buffer.length());
113     }
114 
115     @Override
116     public boolean isSensitive() {
117         return false;
118     }
119 
120     @Override
121     public int getValuePos() {
122         return this.valuePos;
123     }
124 
125     @Override
126     public CharArrayBuffer getBuffer() {
127         return this.buffer;
128     }
129 
130     @Override
131     public String toString() {
132         return this.buffer.toString();
133     }
134 
135 }