Package org.jdrupes.httpcodec.protocols.http

Class HttpField<T>

java.lang.Object

org.jdrupes.httpcodec.protocols.http.HttpField<T>

Type Parameters:

T - the type of the header field’s value

public class HttpField<T>
extends Object

A base class for all kinds of header field values.

See Also:

• Message Headers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT
static final String	ACCEPT_CHARSET
static final String	ACCEPT_ENCODING
static final String	ACCEPT_LANGUAGE
static final String	AGE
static final String	ALLOW
static final String	AUTHORIZATION
static final String	CACHE_CONTROL
static final String	CONNECTION
static final String	CONTENT_LENGTH
static final String	CONTENT_LOCATION
static final String	CONTENT_TYPE
static final String	COOKIE
static final String	DATE
static final String	ETAG
static final String	EXPECT
static final String	EXPIRES
static final String	FROM
protected static final Pattern	headerLinePatter
static final String	HOST
static final String	IF_MATCH
static final String	IF_MODIFIED_SINCE
static final String	IF_NONE_MATCH
static final String	IF_UNMODIFIED_SINCE
static final String	LAST_MODIFIED
static final String	LOCATION
static final String	MAX_FORWARDS
static final String	PRAGMA
static final String	PROXY_AUTHENTICATE
static final String	PROXY_AUTHORIZATION
static final String	RETRY_AFTER
static final String	SERVER
static final String	SET_COOKIE
static final String	TE
static final String	TRAILER
static final String	TRANSFER_ENCODING
static final String	UPGRADE
static final String	USER_AGENT
static final String	VARY
static final String	VIA
static final String	WARNING
static final String	WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor	Description
HttpField(String headerLine, Converter<T> converter)	Creates a new representation of a header field from its textual representation.
HttpField(String name, T value, Converter<T> converter)	Creates a new representation of a header field with the given value and converter.

Method Summary

Modifier and Type	Method	Description
String	asFieldValue()	Returns the string representation of this field’s value.
String	asHeaderField()	Returns the string representation of this header field as it appears in an HTTP message.
Converter<T>	converter()	Returns the cconverter used by this field.
static Converter<?>	lookupConverter(String fieldName)	Returns the proper converter for the header field with the given name.
String	name()	Returns the header field name.
HttpField<T>	setValue(T value)	Sets the header field’s value.
String	toString()
T	value()	Returns the header field’s parsed value.

Methods inherited from class java.lang.Object

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

Field Details

headerLinePatter

protected static final Pattern headerLinePatter

ACCEPT

public static final String ACCEPT

See Also:

• RFC 7231, 5.3.2
• Constant Field Values

ACCEPT_CHARSET

public static final String ACCEPT_CHARSET

See Also:

• RFC 7231, 5.3.3
• Constant Field Values

ACCEPT_ENCODING

public static final String ACCEPT_ENCODING

See Also:

• RFC 7231, 5.3.4
• Constant Field Values

ACCEPT_LANGUAGE

public static final String ACCEPT_LANGUAGE

See Also:

• RFC 7231, 5.3.5
• Constant Field Values

AGE

public static final String AGE

See Also:

• RFC 7234, 5.1
• Constant Field Values

ALLOW

public static final String ALLOW

See Also:

• RFC 7231, 7.4.1
• Constant Field Values

AUTHORIZATION

public static final String AUTHORIZATION

See Also:

• RFC 7235, 4.2
• Constant Field Values

CACHE_CONTROL

public static final String CACHE_CONTROL

See Also:

• RFC 7234, 5.2
• Constant Field Values

COOKIE

public static final String COOKIE

See Also:

• RFC 6265, 5.4
• Constant Field Values

CONNECTION

public static final String CONNECTION

See Also:

• RFC 7230, 6.1
• Constant Field Values

CONTENT_LENGTH

public static final String CONTENT_LENGTH

See Also:

• RFC 7230, 3.3.2
• Constant Field Values

CONTENT_LOCATION

public static final String CONTENT_LOCATION

See Also:

• RFC 7231, 3.1.4.2
• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• RFC 7231, 3.1.1.5
• Constant Field Values

DATE

public static final String DATE

See Also:

• RFC 7231, 7.1.1.2
• Constant Field Values

ETAG

public static final String ETAG

See Also:

• RFC 7232, 2.3
• Constant Field Values

EXPECT

public static final String EXPECT

See Also:

• RFC 7231, 5.1.1
• Constant Field Values

EXPIRES

public static final String EXPIRES

See Also:

• RFC 7234, 5.3
• Constant Field Values

FROM

public static final String FROM

See Also:

• RFC 7231, 5.5.1
• Constant Field Values

HOST

public static final String HOST

See Also:

• RFC 7230, 5.4
• Constant Field Values

IF_MATCH

public static final String IF_MATCH

See Also:

• RFC 7232, 3.1
• Constant Field Values

IF_NONE_MATCH

public static final String IF_NONE_MATCH

See Also:

• RFC 7232, 3.2
• Constant Field Values

IF_MODIFIED_SINCE

public static final String IF_MODIFIED_SINCE

See Also:

• RFC 7232, 3.3
• Constant Field Values

IF_UNMODIFIED_SINCE

public static final String IF_UNMODIFIED_SINCE

See Also:

• RFC 7232, 3.4
• Constant Field Values

LAST_MODIFIED

public static final String LAST_MODIFIED

See Also:

• RFC 7232, 2.2
• Constant Field Values

LOCATION

public static final String LOCATION

See Also:

• RFC 7231, 7.1.2
• Constant Field Values

MAX_FORWARDS

public static final String MAX_FORWARDS

See Also:

• RFC 7231, 5.1.2
• Constant Field Values

PRAGMA

public static final String PRAGMA

See Also:

• RFC 7234, 5.4
• Constant Field Values

PROXY_AUTHENTICATE

public static final String PROXY_AUTHENTICATE

See Also:

• RFC 7235, 4.3
• Constant Field Values

PROXY_AUTHORIZATION

public static final String PROXY_AUTHORIZATION

See Also:

• RFC 7235, 4.4
• Constant Field Values

RETRY_AFTER

public static final String RETRY_AFTER

See Also:

• RFC 7231, 7.1.3
• Constant Field Values

SERVER

public static final String SERVER

See Also:

• RFC 7231, 7.4.2
• Constant Field Values

SET_COOKIE

public static final String SET_COOKIE

See Also:

• RFC 6265, 4.1.1
• Constant Field Values

TE

public static final String TE

See Also:

• RFC 7230, 4.3
• Constant Field Values

TRAILER

public static final String TRAILER

See Also:

• RFC 7230, 4.4
• Constant Field Values

TRANSFER_ENCODING

public static final String TRANSFER_ENCODING

See Also:

• RFC 7230, 3.3.1
• Constant Field Values

UPGRADE

public static final String UPGRADE

See Also:

• RFC 7230, 6.7
• Constant Field Values

USER_AGENT

public static final String USER_AGENT

See Also:

• RFC 7231, 5.5.3
• Constant Field Values

VARY

public static final String VARY

See Also:

• RFC 7231, 7.1.4
• Constant Field Values

VIA

public static final String VIA

See Also:

• RFC 7230, 5.7.1
• Constant Field Values

WARNING

public static final String WARNING

See Also:

• RFC 7234, 5.5
• Constant Field Values

WWW_AUTHENTICATE

public static final String WWW_AUTHENTICATE

See Also:

• RFC 7235, 4.1
• Constant Field Values

Constructor Details

HttpField

public HttpField(String name,
 T value,
 Converter<T> converter)

Creates a new representation of a header field with the given value and converter.

For fields with a constant definition in this class, the name is normalized.

Parameters:

name - the field name

value - the value

converter - the converter

HttpField

public HttpField(String headerLine,
 Converter<T> converter)
          throws ParseException

Creates a new representation of a header field from its textual representation.

For fields with a constant definition in this class, the name is normalized.

Parameters:

headerLine - the header line

converter - the converter

Throws:

ParseException - if an error occurs while parsing the header line

Method Details

lookupConverter

public static Converter<?> lookupConverter(String fieldName)

Returns the proper converter for the header field with the given name.

Works for all well known field names, i.e. the field names defined as constants in this class. If the field name is unknown, a string converter is returned.

Parameters:

fieldName - the field name

Returns:

the converter

name

public String name()

Returns the header field name.

Returns:

the name

value

public T value()

Returns the header field’s parsed value.

Returns:

the field’s value

converter

public Converter<T> converter()

Returns the cconverter used by this field.

Returns:

the converter

setValue

public HttpField<T> setValue(T value)

Sets the header field’s value.

Parameters:

value - the new value

Returns:

the field for easy chaining

asFieldValue

public String asFieldValue()

Returns the string representation of this field’s value.

Returns:

the field value as string

asHeaderField

public String asHeaderField()

Returns the string representation of this header field as it appears in an HTTP message.

Note that the returned string may span several lines (may contain CR/LF), but is has no trailing CR/LF.

Returns:

the field as it occurs in a header

toString

public String toString()

Overrides:

toString in class Object