org.alweb.doff.http
Enum Header

java.lang.Object
  java.lang.Enum<Header>
      org.alweb.doff.http.Header

All Implemented Interfaces:

Serializable, Comparable<Header>

public enum Header
extends Enum<Header>

Represents the HTTP/1.1 headers.

Since:

1.3.4

Author:

Alexis Toulotte

See Also:

"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

Enum Constant Summary

ACCEPT
The Accept request-header field can be used to specify certain media types which are acceptable for the response.

ACCEPT_CHARSET
The Accept-Charset request-header field can be used to indicate what character sets are acceptable for the response.

ACCEPT_ENCODING
The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings that are acceptable in the response.

ACCEPT_LANGUAGE
The Accept-Language request-header field is similar to Accept, but restricts the set of natural languages that are preferred as a response to the request.

ACCEPT_RANGES
The Accept-Ranges response-header field allows the server to indicate its acceptance of range requests for a resource.

AGE
The Age response-header field conveys the sender's estimate of the amount of time since the response (or its revalidation) was generated at the origin server.

ALLOW
The Allow entity-header field lists the set of methods supported by the resource identified by the Request-URI.

AUTHORIZATION
A user agent that wishes to authenticate itself with a server does so by including an Authorization request-header field with the request.

CACHE_CONTROL
The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.

CONNECTION
The Connection general-header field allows the sender to specify options that are desired for that particular connection and MUST NOT be communicated by proxies over further connections.

CONTENT_DISPOSITION
The Content-Disposition response-header field has been proposed as a means for the origin server to suggest a default filename if the user requests that the content is saved to a file.

CONTENT_ENCODING
The Content-Encoding entity-header field is used as a modifier to the media-type.

CONTENT_LANGUAGE
The Content-Language entity-header field describes the natural language(s) of the intended audience for the enclosed entity.

CONTENT_LENGTH
The Content-Length entity-header field indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient or, in the case of the HEAD method, the size of the entity-body that would have been sent had the request been a GET.

CONTENT_LOCATION
The Content-Location entity-header field MAY be used to supply the resource location for the entity enclosed in the message when that entity is accessible from a location separate from the requested resource's URI.

CONTENT_MD5
The Content-MD5 entity-header field, as defined in RFC 1864, is an MD5 digest of the entity-body for the purpose of providing an end-to-end message integrity check (MIC) of the entity-body.

CONTENT_RANGE
The Content-Range entity-header is sent with a partial entity-body to specify where in the full entity-body the partial body should be applied.

CONTENT_TYPE
The Content-Type entity-header field indicates the media type of the entity-body sent to the recipient or, in the case of the HEAD method, the media type that would have been sent had the request been a GET.

DATE
The Date general-header field represents the date and time at which the message was originated, having the same semantics as orig-date in RFC 822.

ETAG
The ETag response-header field provides the current value of the entity tag for the requested variant.

EXPECT
The Expect request-header field is used to indicate that particular server behaviors are required by the client.

EXPIRES
The Expires entity-header field gives the date/time after which the response is considered stale.

FROM
The From request-header field, if given, SHOULD contain an Internet e-mail address for the human user who controls the requesting user agent.

HOST
The Host request-header field specifies the Internet host and port number of the resource being requested, as obtained from the original URI given by the user or referring resource.

IF_MATCH
The If-Match request-header field is used with a method to make it conditional.

IF_MODIFIED_SINCE
The If-Modified-Since request-header field is used with a method to make it conditional: if the requested variant has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message-body.

IF_NONE_MATCH
The If-None-Match request-header field is used with a method to make it conditional.

IF_RANGE
If a client has a partial copy of an entity in its cache, and wishes to have an up-to-date copy of the entire entity in its cache, it could use the Range request-header with a conditional GET.

IF_UNMODIFIED_SINCE
The If-Unmodified-Since request-header field is used with a method to make it conditional.

LAST_MODIFIED
The Last-Modified entity-header field indicates the date and time at which the origin server believes the variant was last modified.

LOCATION
The Location response-header field is used to redirect the recipient to a location other than the Request-URI for completion of the request or identification of a new resource.

MAX_FORWARDS
The Max-Forwards request-header field provides a mechanism with the TRACE and OPTIONS methods to limit the number of proxies or gateways that can forward the request to the next inbound server.

MIME_VERSION
HTTP/1.1 messages MAY include a single MIME-Version general-header field to indicate what version of the MIME protocol was used to construct the message.

PRAGMA
The Pragma general-header field is used to include implementation- specific directives that might apply to any recipient along the request/response chain.

PROXY_AUTHENTICATE
The Proxy-Authenticate response-header field MUST be included as part of a 407 (Proxy Authentication Required) response.

PROXY_AUTHORIZATION
The Proxy-Authorization request-header field allows the client to identify itself (or its user) to a proxy which requires authentication.

RANGE

REFERER
The Referer[sic] request-header field allows the client to specify, for the server's benefit, the address (URI) of the resource from which the Request-URI was obtained (the "referrer", although the header field is misspelled).

RETRY_AFTER
The Retry-After response-header field can be used with a 503 (Service Unavailable) response to indicate how long the service is expected to be unavailable to the requesting client.

SERVER
The Server response-header field contains information about the software used by the origin server to handle the request.

TE
The TE request-header field indicates what extension transfer-codings it is willing to accept in the response and whether or not it is willing to accept trailer fields in a chunked transfer-coding.

TRAILER
The Trailer general field value indicates that the given set of header fields is present in the trailer of a message encoded with chunked transfer-coding.

TRANSFER_ENCODING
The Transfer-Encoding general-header field indicates what (if any) type of transformation has been applied to the message body in order to safely transfer it between the sender and the recipient.

UPGRADE
The Upgrade general-header allows the client to specify what additional communication protocols it supports and would like to use if the server finds it appropriate to switch protocols.

USER_AGENT
The User-Agent request-header field contains information about the user agent originating the request.

VARY
The Vary field value indicates the set of request-header fields that fully determines, while the response is fresh, whether a cache is permitted to use the response to reply to a subsequent request without revalidation.

VIA
The Via general-header field MUST be used by gateways and proxies to indicate the intermediate protocols and recipients between the user agent and the server on requests, and between the origin server and the client on responses.

WARNING
The Warning general-header field is used to carry additional information about the status or transformation of a message which might not be reflected in the message.

WWW_AUTHENTICATE
The WWW-Authenticate response-header field MUST be included in 401 (Unauthorized) response messages.

Method Summary

String	toString() Provides a string representation of this header.
static Header	valueOf(String name) Returns the enum constant of this type with the specified name.
static Header[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACCEPT

public static final Header ACCEPT

The Accept request-header field can be used to specify certain media types which are acceptable for the response.

ACCEPT_CHARSET

public static final Header ACCEPT_CHARSET

The Accept-Charset request-header field can be used to indicate what character sets are acceptable for the response.

ACCEPT_ENCODING

public static final Header ACCEPT_ENCODING

The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings that are acceptable in the response.

ACCEPT_LANGUAGE

public static final Header ACCEPT_LANGUAGE

The Accept-Language request-header field is similar to Accept, but restricts the set of natural languages that are preferred as a response to the request.

ACCEPT_RANGES

public static final Header ACCEPT_RANGES

The Accept-Ranges response-header field allows the server to indicate its acceptance of range requests for a resource.

AGE

public static final Header AGE

The Age response-header field conveys the sender's estimate of the amount of time since the response (or its revalidation) was generated at the origin server.

ALLOW

public static final Header ALLOW

The Allow entity-header field lists the set of methods supported by the resource identified by the Request-URI.

AUTHORIZATION

public static final Header AUTHORIZATION

A user agent that wishes to authenticate itself with a server does so by including an Authorization request-header field with the request.

CACHE_CONTROL

public static final Header CACHE_CONTROL

The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.

CONNECTION

public static final Header CONNECTION

The Connection general-header field allows the sender to specify options that are desired for that particular connection and MUST NOT be communicated by proxies over further connections.

CONTENT_DISPOSITION

public static final Header CONTENT_DISPOSITION

The Content-Disposition response-header field has been proposed as a means for the origin server to suggest a default filename if the user requests that the content is saved to a file. This usage is derived from the definition of Content-Disposition in RFC 1806.

Since:

1.3.5

See Also:

"http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html"

CONTENT_ENCODING

public static final Header CONTENT_ENCODING

The Content-Encoding entity-header field is used as a modifier to the media-type. When present, its value indicates what additional content codings have been applied to the entity-body, and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header field.

CONTENT_LANGUAGE

public static final Header CONTENT_LANGUAGE

The Content-Language entity-header field describes the natural language(s) of the intended audience for the enclosed entity.

CONTENT_LENGTH

public static final Header CONTENT_LENGTH

The Content-Length entity-header field indicates the size of the entity-body, in decimal number of OCTETs, sent to the recipient or, in the case of the HEAD method, the size of the entity-body that would have been sent had the request been a GET.

CONTENT_LOCATION

public static final Header CONTENT_LOCATION

The Content-Location entity-header field MAY be used to supply the resource location for the entity enclosed in the message when that entity is accessible from a location separate from the requested resource's URI.

CONTENT_MD5

public static final Header CONTENT_MD5

The Content-MD5 entity-header field, as defined in RFC 1864, is an MD5 digest of the entity-body for the purpose of providing an end-to-end message integrity check (MIC) of the entity-body.

CONTENT_RANGE

public static final Header CONTENT_RANGE

The Content-Range entity-header is sent with a partial entity-body to specify where in the full entity-body the partial body should be applied.

CONTENT_TYPE

public static final Header CONTENT_TYPE

The Content-Type entity-header field indicates the media type of the entity-body sent to the recipient or, in the case of the HEAD method, the media type that would have been sent had the request been a GET.

DATE

public static final Header DATE

The Date general-header field represents the date and time at which the message was originated, having the same semantics as orig-date in RFC 822.

ETAG

public static final Header ETAG

The ETag response-header field provides the current value of the entity tag for the requested variant.

EXPECT

public static final Header EXPECT

The Expect request-header field is used to indicate that particular server behaviors are required by the client.

EXPIRES

public static final Header EXPIRES

The Expires entity-header field gives the date/time after which the response is considered stale. A stale cache entry may not normally be returned by a cache (either a proxy cache or a user agent cache) unless it is first validated with the origin server (or with an intermediate cache that has a fresh copy of the entity).

FROM

public static final Header FROM

The From request-header field, if given, SHOULD contain an Internet e-mail address for the human user who controls the requesting user agent.

HOST

public static final Header HOST

The Host request-header field specifies the Internet host and port number of the resource being requested, as obtained from the original URI given by the user or referring resource.

IF_MATCH

public static final Header IF_MATCH

The If-Match request-header field is used with a method to make it conditional. A client that has one or more entities previously obtained from the resource can verify that one of those entities is current by including a list of their associated entity tags in the If-Match header field.

IF_MODIFIED_SINCE

public static final Header IF_MODIFIED_SINCE

The If-Modified-Since request-header field is used with a method to make it conditional: if the requested variant has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message-body.

IF_NONE_MATCH

public static final Header IF_NONE_MATCH

The If-None-Match request-header field is used with a method to make it conditional. A client that has one or more entities previously obtained from the resource can verify that none of those entities is current by including a list of their associated entity tags in the If-None-Match header field.

IF_RANGE

public static final Header IF_RANGE

If a client has a partial copy of an entity in its cache, and wishes to have an up-to-date copy of the entire entity in its cache, it could use the Range request-header with a conditional GET.

IF_UNMODIFIED_SINCE

public static final Header IF_UNMODIFIED_SINCE

The If-Unmodified-Since request-header field is used with a method to make it conditional. If the requested resource has not been modified since the time specified in this field, the server SHOULD perform the requested operation as if the If-Unmodified-Since header were not present.

LAST_MODIFIED

public static final Header LAST_MODIFIED

The Last-Modified entity-header field indicates the date and time at which the origin server believes the variant was last modified.

LOCATION

public static final Header LOCATION

The Location response-header field is used to redirect the recipient to a location other than the Request-URI for completion of the request or identification of a new resource.

MAX_FORWARDS

public static final Header MAX_FORWARDS

The Max-Forwards request-header field provides a mechanism with the TRACE and OPTIONS methods to limit the number of proxies or gateways that can forward the request to the next inbound server.

MIME_VERSION

public static final Header MIME_VERSION

HTTP/1.1 messages MAY include a single MIME-Version general-header field to indicate what version of the MIME protocol was used to construct the message. Use of the MIME-Version header field indicates that the message is in full compliance with the MIME protocol (as defined in RFC 2045).

Since:

1.3.5

See Also:

"http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html"

PRAGMA

public static final Header PRAGMA

The Pragma general-header field is used to include implementation- specific directives that might apply to any recipient along the request/response chain.

PROXY_AUTHENTICATE

public static final Header PROXY_AUTHENTICATE

The Proxy-Authenticate response-header field MUST be included as part of a 407 (Proxy Authentication Required) response. The field value consists of a challenge that indicates the authentication scheme and parameters applicable to the proxy for this Request-URI.

PROXY_AUTHORIZATION

public static final Header PROXY_AUTHORIZATION

The Proxy-Authorization request-header field allows the client to identify itself (or its user) to a proxy which requires authentication.

RANGE

public static final Header RANGE

See Also:

"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"

REFERER

public static final Header REFERER

The Referer[sic] request-header field allows the client to specify, for the server's benefit, the address (URI) of the resource from which the Request-URI was obtained (the "referrer", although the header field is misspelled).

RETRY_AFTER

public static final Header RETRY_AFTER

The Retry-After response-header field can be used with a 503 (Service Unavailable) response to indicate how long the service is expected to be unavailable to the requesting client.

SERVER

public static final Header SERVER

The Server response-header field contains information about the software used by the origin server to handle the request. The field can contain multiple product tokens and comments identifying the server and any significant subproducts.

TE

public static final Header TE

The TE request-header field indicates what extension transfer-codings it is willing to accept in the response and whether or not it is willing to accept trailer fields in a chunked transfer-coding.

TRAILER

public static final Header TRAILER

The Trailer general field value indicates that the given set of header fields is present in the trailer of a message encoded with chunked transfer-coding.

TRANSFER_ENCODING

public static final Header TRANSFER_ENCODING

The Transfer-Encoding general-header field indicates what (if any) type of transformation has been applied to the message body in order to safely transfer it between the sender and the recipient.

UPGRADE

public static final Header UPGRADE

The Upgrade general-header allows the client to specify what additional communication protocols it supports and would like to use if the server finds it appropriate to switch protocols.

USER_AGENT

public static final Header USER_AGENT

The User-Agent request-header field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations.

VARY

public static final Header VARY

The Vary field value indicates the set of request-header fields that fully determines, while the response is fresh, whether a cache is permitted to use the response to reply to a subsequent request without revalidation.

VIA

public static final Header VIA

The Via general-header field MUST be used by gateways and proxies to indicate the intermediate protocols and recipients between the user agent and the server on requests, and between the origin server and the client on responses.

WARNING

public static final Header WARNING

The Warning general-header field is used to carry additional information about the status or transformation of a message which might not be reflected in the message.

WWW_AUTHENTICATE

public static final Header WWW_AUTHENTICATE

The WWW-Authenticate response-header field MUST be included in 401 (Unauthorized) response messages. The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters applicable to the Request-URI.

Method Detail

values

public static final Header[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(Header c : Header.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static Header valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

toString

public String toString()

Provides a string representation of this header.

Overrides:

toString in class Enum<Header>

Returns:

The real HTTP header name.