|
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 ch.boye.httpclientandroidlib.message; |
|
29 |
|
30 import java.io.Serializable; |
|
31 |
|
32 import ch.boye.httpclientandroidlib.FormattedHeader; |
|
33 import ch.boye.httpclientandroidlib.HeaderElement; |
|
34 import ch.boye.httpclientandroidlib.ParseException; |
|
35 import ch.boye.httpclientandroidlib.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, Cloneable, 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 /** |
|
64 * Creates a new header from a buffer. |
|
65 * The name of the header will be parsed immediately, |
|
66 * the value only if it is accessed. |
|
67 * |
|
68 * @param buffer the buffer containing the header to represent |
|
69 * |
|
70 * @throws ParseException in case of a parse error |
|
71 */ |
|
72 public BufferedHeader(final CharArrayBuffer buffer) |
|
73 throws ParseException { |
|
74 |
|
75 super(); |
|
76 if (buffer == null) { |
|
77 throw new IllegalArgumentException |
|
78 ("Char array buffer may not be null"); |
|
79 } |
|
80 int colon = buffer.indexOf(':'); |
|
81 if (colon == -1) { |
|
82 throw new ParseException |
|
83 ("Invalid header: " + buffer.toString()); |
|
84 } |
|
85 String s = buffer.substringTrimmed(0, colon); |
|
86 if (s.length() == 0) { |
|
87 throw new ParseException |
|
88 ("Invalid header: " + buffer.toString()); |
|
89 } |
|
90 this.buffer = buffer; |
|
91 this.name = s; |
|
92 this.valuePos = colon + 1; |
|
93 } |
|
94 |
|
95 |
|
96 public String getName() { |
|
97 return this.name; |
|
98 } |
|
99 |
|
100 public String getValue() { |
|
101 return this.buffer.substringTrimmed(this.valuePos, this.buffer.length()); |
|
102 } |
|
103 |
|
104 public HeaderElement[] getElements() throws ParseException { |
|
105 ParserCursor cursor = new ParserCursor(0, this.buffer.length()); |
|
106 cursor.updatePos(this.valuePos); |
|
107 return BasicHeaderValueParser.DEFAULT |
|
108 .parseElements(this.buffer, cursor); |
|
109 } |
|
110 |
|
111 public int getValuePos() { |
|
112 return this.valuePos; |
|
113 } |
|
114 |
|
115 public CharArrayBuffer getBuffer() { |
|
116 return this.buffer; |
|
117 } |
|
118 |
|
119 public String toString() { |
|
120 return this.buffer.toString(); |
|
121 } |
|
122 |
|
123 public Object clone() throws CloneNotSupportedException { |
|
124 // buffer is considered immutable |
|
125 // no need to make a copy of it |
|
126 return super.clone(); |
|
127 } |
|
128 |
|
129 } |