HeaderFields (org.refcodes:refcodes-net 1.1.1 API)

All Superinterfaces:

HttpFields<T>, Map<String,List<String>>

All Known Subinterfaces:

RequestHeaderFields, ResponseHeaderFields

All Known Implementing Classes:

AbstractHeaderFields, RequestHeaderFieldsImpl, ResponseHeaderFieldsImpl
```
public interface HeaderFields<C extends Cookie,T extends HeaderFields<C,T>>
extends HttpFields<T>
```
The HeaderFields reflect the structure of a HTTP header and may be used to represent a HTTP header.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`C`	`addCookie(C aCookie)` Adds an individual server-side cookie to be sent to the client to this `ResponseHeaderFields` instance.
`C`	`addCookie(String aCookieName, String aValue)` Adds an individual server-side cookie to be sent to the client to this `ResponseHeaderFields` instance.
`default void`	`addTo(HeaderField aHeaderField, String aValue)`
`default MediaType[]`	`getAcceptTypes()` Gets the communication partner's expected (supported) kinds of content.
`default HttpMethod[]`	`getAllows()` Gets the HTTP methods allowed for the resource.
`default MediaType`	`getContentType()` Gets the `MediaType` for the HTTP body.
`List<C>`	`getCookie(String aCookieName)` Retrieves an individual cookie sent by the client stored in this `RequestHeaderFields` instance.
`List<C>`	`getCookies()` Retrieves an array of cookies sent by the client stored in this `RequestHeaderFields` instance.
`default String`	`getCorrelationId()` Gets the (interprocess) correlation ID.
`default String`	`getFirst(HeaderField aHeaderField)`
`default String`	`getHost()` Gets the originating host.
`default String`	`getUserAgent()` Gets the originating user agent.
`default void`	`set(HeaderField aHeaderField, String aValue)`
`default void`	`setAcceptTypes(MediaType... aMediaTypes)` Tells the communication partner the expected (supported) kinds of content.
`default void`	`setAllows(HttpMethod... aHttpMethods)` Sets the HTTP methods allowed for the resource.
`default void`	`setContentType(MediaType aMediaType)` Sets the `MediaType` for the HTTP body.
`default void`	`setCorrelationId(String aCorrelationId)` Sets the (interprocess) correlation ID.
`default void`	`setHost(String aHost)` Sets the originating host.
`default void`	`setUserAgent(String aUserAgent)` Sets the originating user agent.
`default String[]`	`toHttpCookies()` Creates a HTTP header field value from the herein stored `Cookie` instances.
`default T`	`withAcceptTypes(MediaType... aMediaTypes)` Tells the communication partner the expected (supported) kinds of content.
`default HeaderFields<C,T>`	`withAddCookie(C aCookie)` Builder method for the `addCookie(Cookie)` method.
`default HeaderFields<C,T>`	`withAddCookie(String aCookieName, String aValue)` Builder method for the `addCookie(String, String)` method.
`default HeaderFields<C,T>`	`withAddTo(HeaderField aHeaderField, String aValue)`
`default T`	`withAllows(HttpMethod... aHttpMethods)` Sets the HTTP methods allowed for the resource.
`default T`	`withContentType(MediaType aMediaType)` Sets the `MediaType` for the HTTP body.
`default T`	`withCorrelationId(String aCorrelationId)` Sets the (interprocess) correlation ID.
`default T`	`withHost(String aHost)` Sets the originating host.
`default HeaderFields<C,T>`	`withSet(HeaderField aHeaderField, String aValue)`
`default HeaderFields<C,T>`	`withSet(String aHeaderField, String aValue)` Builder method for the `HttpFields.set(String, String)` method.
`default T`	`withUserAgent(String aUserAgent)` Sets the originating user agent.

Methods inherited from interface org.refcodes.net.HttpFields
addTo, getFirst, set, withAddTo

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

- Method Detail
  - withAllows
```
default T withAllows(HttpMethod... aHttpMethods)
```
    Sets the HTTP methods allowed for the resource.
    
    Parameters:
    
    aHttpMethods - The HTTP methods allowed for the resource.
    
    Returns:
    
    This object as of the builder pattern.
  - setAllows
```
default void setAllows(HttpMethod... aHttpMethods)
```
    Sets the HTTP methods allowed for the resource.
    
    Parameters:
    
    aHttpMethods - The HTTP methods allowed for the resource.
  - getAllows
```
default HttpMethod[] getAllows()
```
    Gets the HTTP methods allowed for the resource.
    
    Returns:
    
    The HTTP methods allowed for the resource.
  - withContentType
```
default T withContentType(MediaType aMediaType)
```
    Sets the MediaType for the HTTP body.
    
    Parameters:
    
    aMediaType - The media type expected by a client from a server.
    
    Returns:
    
    This object as of the builder pattern.
  - setContentType
```
default void setContentType(MediaType aMediaType)
```
    Sets the MediaType for the HTTP body.
    
    Parameters:
    
    aMediaType - The media type expected by a client from a server.
  - getContentType
```
default MediaType getContentType()
```
    Gets the MediaType for the HTTP body.
    
    Returns:
    
    The media type expected by a client from a server.
  - withAcceptTypes
```
default T withAcceptTypes(MediaType... aMediaTypes)
```
    Tells the communication partner the expected (supported) kinds of content. Sets the expected (supported) kinds of MediaType for the HeaderField.ACCEPT header.
    
    Parameters:
    
    aMediaTypes - The according MediaType.
    
    Returns:
    
    This object as of the builder pattern.
  - setAcceptTypes
```
default void setAcceptTypes(MediaType... aMediaTypes)
```
    Tells the communication partner the expected (supported) kinds of content. Sets the expected (supported) kinds of MediaType for the HeaderField.ACCEPT header.
    
    Parameters:
    
    aMediaTypes - The according MediaType.
  - getAcceptTypes
```
default MediaType[] getAcceptTypes()
```
    Gets the communication partner's expected (supported) kinds of content. Returns the expected (supported) kinds of MediaType as found in the HeaderField.ACCEPT header.
    
    Returns:
    
    The expected (supported) kinds of MediaType.
  - withUserAgent
```
default T withUserAgent(String aUserAgent)
```
    Sets the originating user agent.
    
    Parameters:
    
    aUserAgent - The according user agent.
    
    Returns:
    
    This object as of the builder pattern.
  - setUserAgent
```
default void setUserAgent(String aUserAgent)
```
    Sets the originating user agent.
    
    Parameters:
    
    aUserAgent - The according user agent.
  - getUserAgent
```
default String getUserAgent()
```
    Gets the originating user agent.
    
    Returns:
    
    The according user agent.
  - withHost
```
default T withHost(String aHost)
```
    Sets the originating host.
    
    Parameters:
    
    aHost - The according host.
    
    Returns:
    
    This object as of the builder pattern.
  - setHost
```
default void setHost(String aHost)
```
    Sets the originating host.
    
    Parameters:
    
    aHost - The according host.
  - getHost
```
default String getHost()
```
    Gets the originating host.
    
    Returns:
    
    The according host.
  - withCorrelationId
```
default T withCorrelationId(String aCorrelationId)
```
    Sets the (interprocess) correlation ID.
    
    Parameters:
    
    aCorrelationId - The according correlation ID..
    
    Returns:
    
    This object as of the builder pattern.
  - setCorrelationId
```
default void setCorrelationId(String aCorrelationId)
```
    Sets the (interprocess) correlation ID.
    
    Parameters:
    
    aCorrelationId - The according correlation ID..
  - getCorrelationId
```
default String getCorrelationId()
```
    Gets the (interprocess) correlation ID.
    
    Returns:
    
    The according host.
  - getFirst
```
default String getFirst(HeaderField aHeaderField)
```
    See Also:
    
    HttpFields.getFirst(String)
  - addTo
```
default void addTo(HeaderField aHeaderField,
                   String aValue)
```
    See Also:
    
    HttpFields.addTo(String, String)
  - set
```
default void set(HeaderField aHeaderField,
                 String aValue)
```
    See Also:
    
    HttpFields.set(String, String)
  - withSet
```
default HeaderFields<C,T> withSet(String aHeaderField,
                                  String aValue)
```
    Builder method for the HttpFields.set(String, String) method.
    
    Parameters:
    
    aHeaderField - The header field for which to set a single value.
    
    aValue - The single value to be set for the header field (key).
    
    Returns:
    
    This HeaderFields instance to continue building up the header fields.
  - withSet
```
default HeaderFields<C,T> withSet(HeaderField aHeaderField,
                                  String aValue)
```
    See Also:
    
    withSet(String, String)
  - withAddTo
```
default HeaderFields<C,T> withAddTo(HeaderField aHeaderField,
                                    String aValue)
```
    See Also:
    
    HttpFields.withAddTo(String, String)
  - addCookie
```
C addCookie(String aCookieName,
            String aValue)
```
    Adds an individual server-side cookie to be sent to the client to this ResponseHeaderFields instance. The server-side cookies are retrieved from the #HEADER_SET_FIELD_COOKIE header field. WITH THE METHOD getCookies() and getCookie(String) ONLY THE COOKIES SENT BY THE CLIENT CAN BE RETRIEVED. (E.G. COOKIES RESIDING IN THE HEADER FIELD #HEADER_FIELD_COOKIE). COOKIES SET VIA addCookie(String, String) OR withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE .
    
    Parameters:
    
    aCookieName - The name for the cookie to be added.
    
    aValue - The value of the cookie to be added.
    
    Returns:
    
    The resulting cookie builder being added which can be modified affecting(!) this ResponseHeaderFields instance!
  - addCookie
```
C addCookie(C aCookie)
```
    Adds an individual server-side cookie to be sent to the client to this ResponseHeaderFields instance. The server-side cookies are retrieved from the #HEADER_SET_FIELD_COOKIE header field. WITH THE METHOD getCookies() and getCookie(String) ONLY THE COOKIES SENT BY THE CLIENT CAN BE RETRIEVED. (E.G. COOKIES RESIDING IN THE HEADER FIELD #HEADER_FIELD_COOKIE). COOKIES SET VIA addCookie(String, String) OR withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE .
    
    Parameters:
    
    aCookie - The cookie to be added.
    
    Returns:
    
    The resulting cookie builder being added which can be modified affecting(!) this ResponseHeaderFields instance!
  - withAddCookie
```
default HeaderFields<C,T> withAddCookie(String aCookieName,
                                        String aValue)
```
    Builder method for the addCookie(String, String) method. WITH THE METHOD getCookies() and getCookie(String) ONLY THE COOKIES SENT BY THE CLIENT CAN BE RETRIEVED. (E.G. COOKIES RESIDING IN THE HEADER FIELD #HEADER_FIELD_COOKIE). COOKIES SET VIA addCookie(String, String) OR withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE .
    
    Parameters:
    
    aCookieName - The name for the cookie to be added.
    
    aValue - The value of the cookie to be added.
    
    Returns:
    
    This ResponseHeaderFields instance to continue building up the header fields.
  - withAddCookie
```
default HeaderFields<C,T> withAddCookie(C aCookie)
```
    Builder method for the addCookie(Cookie) method. WITH THE METHOD getCookies() and getCookie(String) ONLY THE COOKIES SENT BY THE CLIENT CAN BE RETRIEVED. (E.G. COOKIES RESIDING IN THE HEADER FIELD #HEADER_FIELD_COOKIE). COOKIES SET VIA addCookie(String, String) OR withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE .
    
    Parameters:
    
    aCookie - The cookie to be added.
    
    Returns:
    
    This ResponseHeaderFields instance to continue building up the header fields.
  - getCookies
```
List<C> getCookies()
```
    Retrieves an array of cookies sent by the client stored in this RequestHeaderFields instance. If no cookie has been found, then an empty array is returned. The client-side cookies are retrieved from the #HEADER_FIELD_COOKIE header field. WITH THE METHOD getCookies() and getCookie(String) ONLY THE COOKIES SENT BY THE CLIENT CAN BE RETRIEVED. (E.G. COOKIES RESIDING IN THE HEADER FIELD #HEADER_FIELD_COOKIE). COOKIES SET VIA addCookie(String, String) OR withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE . According to the Netscape cookie_spec (https://curl.haxx.se/rfc/cookie_spec.html) the entire NAME=VALUE string of a cookie is a sequence of characters excluding semi-colon, comma and white space.
    
    Returns:
    
    An array containing the cookies (key/value) stored in this RequestHeaderFields instance.
  - getCookie
```
List<C> getCookie(String aCookieName)
```
    Retrieves an individual cookie sent by the client stored in this RequestHeaderFields instance. The client-side cookies are retrieved from the #HEADER_FIELD_COOKIE header field. WITH THE METHOD getCookies() and getCookie(String) ONLY THE COOKIES SENT BY THE CLIENT CAN BE RETRIEVED. (E.G. COOKIES RESIDING IN THE HEADER FIELD #HEADER_FIELD_COOKIE). COOKIES SET VIA addCookie(String, String) OR withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE .
    
    Parameters:
    
    aCookieName - The name of the cookie to be retrieved.
    
    Returns:
    
    The values of the cookie found for the according name.
  - toHttpCookies
```
default String[] toHttpCookies()
```
    Creates a HTTP header field value from the herein stored Cookie instances.
    
    Returns:
    
    The text representing the HTTP header field for the herein stored cookies.

Interface HeaderFields<C extends Cookie,T extends HeaderFields<C,T>>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Method Summary

Methods inherited from interface org.refcodes.net.HttpFields

Methods inherited from interface java.util.Map

Method Detail

withAllows

setAllows

getAllows

withContentType

setContentType

getContentType

withAcceptTypes

setAcceptTypes

getAcceptTypes

withUserAgent

setUserAgent

getUserAgent

withHost

setHost

getHost

withCorrelationId

setCorrelationId

getCorrelationId

getFirst

addTo

set

withSet

withSet

withAddTo

addCookie

addCookie

withAddCookie

withAddCookie

getCookies

getCookie

toHttpCookies