java.lang.Object
- java.lang.Enum<HeaderField>
- - org.refcodes.web.HeaderField

All Implemented Interfaces:

Serializable, Comparable<HeaderField>, org.refcodes.mixin.NameAccessor
```
public enum HeaderField
extends Enum<HeaderField>
implements org.refcodes.mixin.NameAccessor
```
The Enum HeaderField.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor
  org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ACCEPT`
`ACCEPT_CHARSET`
`ACCEPT_ENCODING`
`ACCEPT_LANGUAGE`	"...
`ACCESS_TOKEN`	For OAuth: "...
`ALLOW`
`AUTHORIZATION`
`CLIENT_ID`	For OAuth: "...
`CLIENT_SECRET`	For OAuth: "...
`CONNECTION`
`CONTENT_ENCODING`
`CONTENT_LANGUAGE`
`CONTENT_LENGTH`
`CONTENT_LOCATION`
`CONTENT_MD5`
`CONTENT_RANGE`
`CONTENT_TYPE`
`COOKIE`	The Cookie HTTP Request-Header contains stored HTTP cookies previously sent by the server with the `SET_COOKIE` header.
`EXPIRES`
`EXPIRES_IN`	For OAuth: "...
`EXTENSION_HEADER`
`GRANT_TYPE`	For OAuth, it must be set to `GrantType.AUTHORIZATION_CODE`: "...
`HOST`
`LAST_MODIFIED`
`LOCATION`	"...
`NOT_BEFORE_POLICY`	Probably legacy, encountered upon using KeyCloak with OAuth.
`PASSWORD`	For OAuth: "...
`REDIRECT_URI`	For OAuth: "...
`REFRESH_EXPIRES_IN`	Probably legacy, encountered upon using KeyCloak with OAuth.
`REFRESH_TOKEN`	For OAuth: "...
`REQUEST_ID`
`SCOPE`	For OAuth: OAuth scopes let you specify exactly how your application needs to access a user's resource.
`SESSION_ID`
`SESSION_STATE`	Probably legacy, encountered upon using KeyCloak with OAuth.
`SET_COOKIE`	The Set-Cookie HTTP Response-Header is used to send cookies from the server to the user agent.
`TOKEN_TYPE`	Token type, see also `TokenType`.
`USER_AGENT`
`USERNAME`	For OAuth: "...
`WWW_AUTHENTICATE`
`X_B3_PARENT_SPAN_ID`	B3 ids are fixed-length lowerhex encoded values.
`X_B3_TRACE_ID`	B3 ids are fixed-length lowerhex encoded values.
`X_B3_TRACE_SPAN_ID`	B3 ids are fixed-length lowerhex encoded values.
`X_REQUEST_ID`	"...

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getName()`
`static HeaderField`	`toHeaderField(String aHttpHeaderField)`	Retrieves the `HeaderField` which corresponds to the given HTTP Header-Field name.
`static String`	`toHttpHeaderField(String aHttpHeaderField)`	Normalizes the input HTTP Header-Field to match the case of the Header-Fields as defined in this `HeaderField` enumeration.
`static HeaderField`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static HeaderField[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AUTHORIZATION
```
public static final HeaderField AUTHORIZATION
```
  - ALLOW
```
public static final HeaderField ALLOW
```
  - CONTENT_ENCODING
```
public static final HeaderField CONTENT_ENCODING
```
  - CONTENT_LANGUAGE
```
public static final HeaderField CONTENT_LANGUAGE
```
  - CONTENT_LENGTH
```
public static final HeaderField CONTENT_LENGTH
```
  - CONTENT_LOCATION
```
public static final HeaderField CONTENT_LOCATION
```
  - CONTENT_MD5
```
public static final HeaderField CONTENT_MD5
```
  - CONTENT_RANGE
```
public static final HeaderField CONTENT_RANGE
```
  - CONTENT_TYPE
```
public static final HeaderField CONTENT_TYPE
```
  - EXPIRES
```
public static final HeaderField EXPIRES
```
  - LAST_MODIFIED
```
public static final HeaderField LAST_MODIFIED
```
  - EXTENSION_HEADER
```
public static final HeaderField EXTENSION_HEADER
```
  - COOKIE
```
public static final HeaderField COOKIE
```
    The Cookie HTTP Request-Header contains stored HTTP cookies previously sent by the server with the SET_COOKIE header.
  - SET_COOKIE
```
public static final HeaderField SET_COOKIE
```
    The Set-Cookie HTTP Response-Header is used to send cookies from the server to the user agent.
  - ACCEPT
```
public static final HeaderField ACCEPT
```
  - ACCEPT_ENCODING
```
public static final HeaderField ACCEPT_ENCODING
```
  - ACCEPT_LANGUAGE
```
public static final HeaderField ACCEPT_LANGUAGE
```
    "... The Accept-Language request HTTP header advertises which languages the client is able to understand, and which locale variant is preferred ..."
    
    See Also:
    
    "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language"
  - ACCEPT_CHARSET
```
public static final HeaderField ACCEPT_CHARSET
```
  - CONNECTION
```
public static final HeaderField CONNECTION
```
  - HOST
```
public static final HeaderField HOST
```
  - LOCATION
```
public static final HeaderField 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. For 201 (Created) responses, the Location is that of the new resource which was created by the request. For 3xx responses, the location SHOULD indicate the server's preferred URI for automatic redirection to the resource. The field value consists of a single absolute URI ..."
    
    See Also:
    
    "https://tools.ietf.org/html/rfc2616#page-135"
  - USER_AGENT
```
public static final HeaderField USER_AGENT
```
  - REQUEST_ID
```
public static final HeaderField REQUEST_ID
```
  - SESSION_ID
```
public static final HeaderField SESSION_ID
```
  - WWW_AUTHENTICATE
```
public static final HeaderField WWW_AUTHENTICATE
```
  - X_B3_TRACE_ID
```
public static final HeaderField X_B3_TRACE_ID
```
    B3 ids are fixed-length lowerhex encoded values.
  - X_B3_TRACE_SPAN_ID
```
public static final HeaderField X_B3_TRACE_SPAN_ID
```
    B3 ids are fixed-length lowerhex encoded values.
  - X_B3_PARENT_SPAN_ID
```
public static final HeaderField X_B3_PARENT_SPAN_ID
```
    B3 ids are fixed-length lowerhex encoded values.
  - X_REQUEST_ID
```
public static final HeaderField X_REQUEST_ID
```
    "... The X-RequestId Header-Field MUST be a combination of a globally unique value in the format of a GUID followed by an increasing decimal counter which MUST increase with every new HTTP-Request (for example, "{E2EA6C1C-E61B-49E9-9CFB-38184F907552}:123456"). The GUID portion of the X-RequestId header MUST be unique across all Session Contexts and MUST NOT change for the life of the Session Context. The client MUST send this header on every request and the server MUST return this header with the same information in the response back to the client ..."
    
    See Also:
    
    "https://msdn.microsoft.com/en-us/library/dn530858(v=exchg.80).aspx"
  - SCOPE
```
public static final HeaderField SCOPE
```
    For OAuth: OAuth scopes let you specify exactly how your application needs to access a user's resource. Scope is specified on either the authorization or token endpoints using the parameter scope. Scope is expressed as a set of case-sensitive and space-delimited strings. The authorization server may override the scope request, in this case it must include scope in its response to inform a client of their actual scope. When a scope is not specified, the server may either fallback to a well-documented default, or fail the request. "... OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. The scope of the access token as described by Section 3.3. ...", "... OPTIONAL. The scope of the access request as described by Section 3.3 ..." (https://tools.ietf.org/html/rfc6749)
  - ACCESS_TOKEN
```
public static final HeaderField ACCESS_TOKEN
```
    For OAuth: "... REQUIRED. The access token issued by the authorization server ..." (https://tools.ietf.org/html/rfc6749)
  - REFRESH_TOKEN
```
public static final HeaderField REFRESH_TOKEN
```
    For OAuth: "... OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in Section 6. ..." (https://tools.ietf.org/html/rfc6749)
  - TOKEN_TYPE
```
public static final HeaderField TOKEN_TYPE
```
    Token type, see also TokenType. For OAuth: "... REQUIRED. The type of the token issued as described in Section 7.1. Value is case insensitive ..." (https://tools.ietf.org/html/rfc6749)
  - EXPIRES_IN
```
public static final HeaderField EXPIRES_IN
```
    For OAuth: "... RECOMMENDED. The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value ..." (https://tools.ietf.org/html/rfc6749)
  - CLIENT_ID
```
public static final HeaderField CLIENT_ID
```
    For OAuth: "... REQUIRED. The client identifier issued to the client during the registration process described by Section 2.2. ..." (https://tools.ietf.org/html/rfc6749)
  - CLIENT_SECRET
```
public static final HeaderField CLIENT_SECRET
```
    For OAuth: "... REQUIRED. The client secret. The client MAY omit the parameter if the client secret is an empty string ..." (https://tools.ietf.org/html/rfc6749)
  - GRANT_TYPE
```
public static final HeaderField GRANT_TYPE
```
    For OAuth, it must be set to GrantType.AUTHORIZATION_CODE: "... grant_type REQUIRED. Value MUST be set to "authorization_code" ..." (https://tools.ietf.org/html/rfc6749)
  - REDIRECT_URI
```
public static final HeaderField REDIRECT_URI
```
    For OAuth: "... REQUIRED, if the "redirect_uri" parameter was included in the authorization request as described in Section 4.1.1, and their values MUST be identical ..." (https://tools.ietf.org/html/rfc6749)
  - USERNAME
```
public static final HeaderField USERNAME
```
    For OAuth: "... REQUIRED. The resource owner username ..." (https://tools.ietf.org/html/rfc6749)
  - PASSWORD
```
public static final HeaderField PASSWORD
```
    For OAuth: "... REQUIRED. The resource owner password ..." (https://tools.ietf.org/html/rfc6749)
  - SESSION_STATE
```
public static final HeaderField SESSION_STATE
```
    Probably legacy, encountered upon using KeyCloak with OAuth.
  - REFRESH_EXPIRES_IN
```
public static final HeaderField REFRESH_EXPIRES_IN
```
    Probably legacy, encountered upon using KeyCloak with OAuth.
  - NOT_BEFORE_POLICY
```
public static final HeaderField NOT_BEFORE_POLICY
```
    Probably legacy, encountered upon using KeyCloak with OAuth.
- Method Detail
  - values
```
public static HeaderField[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (HeaderField c : HeaderField.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HeaderField 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
    
    NullPointerException - if the argument is null
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface org.refcodes.mixin.NameAccessor
  - toHeaderField
```
public static HeaderField toHeaderField(String aHttpHeaderField)
```
    Retrieves the HeaderField which corresponds to the given HTTP Header-Field name. The provided HTTP Header-Field name is tested case insensitive.
    
    Parameters:
    
    aHttpHeaderField - The HTTP Header-Field name for which to get a unified HeaderField.
    
    Returns:
    
    Returns the according HeaderField or null if none such HeaderField has yet been defined.
  - toHttpHeaderField
```
public static String toHttpHeaderField(String aHttpHeaderField)
```
    Normalizes the input HTTP Header-Field to match the case of the Header-Fields as defined in this HeaderField enumeration. If there is none such corresponding Header-Field, then the provided Header-Field is returned as is.
    
    Parameters:
    
    aHttpHeaderField - The incoming Header-Field to be normalized.
    
    Returns:
    
    The normalized HeaderF-Field or, if not possible, the unmodified Header-Field-

Enum HeaderField

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTHORIZATION

ALLOW

CONTENT_ENCODING

CONTENT_LANGUAGE

CONTENT_LENGTH

CONTENT_LOCATION

CONTENT_MD5

CONTENT_RANGE

CONTENT_TYPE

EXPIRES

LAST_MODIFIED

EXTENSION_HEADER

COOKIE

SET_COOKIE

ACCEPT

ACCEPT_ENCODING

ACCEPT_LANGUAGE

ACCEPT_CHARSET

CONNECTION

HOST

LOCATION

USER_AGENT

REQUEST_ID

SESSION_ID

WWW_AUTHENTICATE

X_B3_TRACE_ID

X_B3_TRACE_SPAN_ID

X_B3_PARENT_SPAN_ID

X_REQUEST_ID

SCOPE

ACCESS_TOKEN

REFRESH_TOKEN

TOKEN_TYPE

EXPIRES_IN

CLIENT_ID

CLIENT_SECRET

GRANT_TYPE

REDIRECT_URI

USERNAME

PASSWORD

SESSION_STATE

REFRESH_EXPIRES_IN

NOT_BEFORE_POLICY

Method Detail

values

valueOf

getName

toHeaderField

toHttpHeaderField