org.apache.hc.client5.http.support

Class ProxyStatusSupport

java.lang.Object

org.apache.hc.client5.http.support.ProxyStatusSupport

@Contract(threading=STATELESS)
public final class ProxyStatusSupport
extends Object

Parser for the Proxy-Status response field defined by RFC 9209. The field is a Structured Fields (RFC 8941) List whose members are Items: an intermediary identity followed by parameters.

Parsing is strict. Input that does not conform to the grammar is rejected with a ParseException, since RFC 8941 requires a field that fails to parse to be treated as absent rather than partially applied. The parser only decodes the field; it does not interpret or act on the reported values. Parameter values are returned by their structured-field types: String for tokens and strings, Long for integers, BigDecimal for decimals, Boolean for booleans and byte[] for byte sequences.

Since:

5.7

Method Summary

Modifier and Type	Method and Description
static List<ProxyStatus>	parse(CharSequence value) Parses a Proxy-Status field value into its ordered list of members.
static List<ProxyStatus>	parse(CharSequence value, ParserCursor cursor) Parses a Proxy-Status field value into its ordered list of members, starting at the current position of the given cursor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

parse

public static List<ProxyStatus> parse(CharSequence value)
                               throws ParseException

Parses a Proxy-Status field value into its ordered list of members.

Parameters:

value - the field value; must not be null.

Returns:

the parsed members, empty when the value contains no members.

Throws:

ParseException - if the value does not conform to RFC 9209 / RFC 8941.

parse

public static List<ProxyStatus> parse(CharSequence value,
                                      ParserCursor cursor)
                               throws ParseException

Parses a Proxy-Status field value into its ordered list of members, starting at the current position of the given cursor. This allows the field to be parsed directly from a FormattedHeader buffer without creating an intermediate String.

Parameters:

value - the buffer holding the field value; must not be null.

cursor - the cursor positioned at the start of the field value; must not be null.

Returns:

the parsed members, empty when the value contains no members.

Throws:

ParseException - if the value does not conform to RFC 9209 / RFC 8941.