|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HeaderValueParser
Interface for parsing header values into elements. Instances of this interface are expected to be stateless and thread-safe.
Method Summary | |
---|---|
HeaderElement[] |
parseElements(CharArrayBuffer buffer,
int indexFrom,
int indexTo)
Parses a header value into elements. |
HeaderElement |
parseHeaderElement(CharArrayBuffer buffer,
int indexFrom,
int indexTo)
Parses a single header element. |
NameValuePair |
parseNameValuePair(CharArrayBuffer buffer,
int indexFrom,
int indexTo)
Parses a name=value specification, where the = and value are optional. |
NameValuePair[] |
parseParameters(CharArrayBuffer buffer,
int indexFrom,
int indexTo)
Parses a list of name-value pairs. |
Method Detail |
---|
HeaderElement[] parseElements(CharArrayBuffer buffer, int indexFrom, int indexTo) throws ParseException
RuntimeException
.
Some HTTP headers (such as the set-cookie header) have values that can be decomposed into multiple elements. In order to be processed by this parser, such headers must be in the following form:
header = [ element ] *( "," [ element ] ) element = name [ "=" [ value ] ] *( ";" [ param ] ) param = name [ "=" [ value ] ] name = token value = ( token | quoted-string ) token = 1*<any char except "=", ",", ";", <"> and white space> quoted-string = <"> *( text | quoted-char ) <"> text = any char except <"> quoted-char = "\" char
Any amount of white space is allowed between any part of the
header, element or param and is ignored. A missing value in any
element or param will be stored as the empty String
;
if the "=" is also missing null will be stored instead.
buffer
- buffer holding the header value to parse
ParseException
- in case of a parse errorHeaderElement parseHeaderElement(CharArrayBuffer buffer, int indexFrom, int indexTo) throws ParseException
buffer
- buffer holding the element to parse
ParseException
- in case of a parse errorNameValuePair[] parseParameters(CharArrayBuffer buffer, int indexFrom, int indexTo) throws ParseException
RuntimeException
.
This method comforms to the generic grammar and formatting rules outlined in the Section 2.2 and Section 3.6 of RFC 2616.
The following rules are used throughout this specification to describe basic parsing constructs. The US-ASCII coded character set is defined by ANSI X3.4-1986.
OCTET =CHAR = UPALPHA = LOALPHA = ALPHA = UPALPHA | LOALPHA DIGIT = CTL = CR = LF = SP = HT = <"> =
Many HTTP/1.1 header field values consist of words separated by LWS or special characters. These special characters MUST be in a quoted string to be used within a parameter value (as defined in section 3.6).
token = 1*separators = "(" | ")" | "<" | ">" | "@" | "," | ";" | ":" | "\" | <"> | "/" | "[" | "]" | "?" | "=" | "{" | "}" | SP | HT
A string of text is parsed as a single word if it is quoted using double-quote marks.
quoted-string = ( <"> *(qdtext | quoted-pair ) <"> ) qdtext =>
The backslash character ("\") MAY be used as a single-character quoting mechanism only within quoted-string and comment constructs.
quoted-pair = "\" CHAR
Parameters are in the form of attribute/value pairs.
parameter = attribute "=" value attribute = token value = token | quoted-string
buffer
- buffer holding the name-value list to parse
ParseException
- in case of a parse errorNameValuePair parseNameValuePair(CharArrayBuffer buffer, int indexFrom, int indexTo) throws ParseException
buffer
- the buffer holding the name-value pair to parse
null
if no value is specified
ParseException
- in case of a parse error
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |