org.refcodes.net.impls

Class AbstractHeaderFields<C extends Cookie,T extends HeaderFields<C,T>>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,List<String>>

org.refcodes.net.impls.AbstractHeaderFields<C,T>

All Implemented Interfaces:

Serializable, Cloneable, Map<String,List<String>>, HeaderFields<C,T>, HttpFields<T>

Direct Known Subclasses:

RequestHeaderFieldsImpl, ResponseHeaderFieldsImpl

public abstract class AbstractHeaderFields<C extends Cookie,T extends HeaderFields<C,T>>
extends HashMap<String,List<String>>
implements HeaderFields<C,T>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AbstractHeaderFields()
AbstractHeaderFields(Map<String,List<String>> aFromHeaderFields)

Method Summary

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.
void	addTo(String aHeaderField, String aValue) Adds a value to the list of values associated with the given header field (key),
protected abstract C	createCookie(String aHttpCookie) Creates a Cookie from the given HTTP cookie String as retrieved from the according header field.
protected abstract C	createCookie(String aCookieName, String aValue) Creates a plain Cookie with the given name and value.
List<String>	get(Object aKey)
List<C>	getCookie(String aCookieName) Retrieves an individual cookie sent by the client stored in this RequestHeaderFields instance.
protected abstract String	getCookieFieldName() The header field name for the Cookie elements.
List<C>	getCookies() Retrieves an array of cookies sent by the client stored in this RequestHeaderFields instance.
List<String>	put(String key, List<String> value)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.net.HeaderFields

addTo, getAcceptTypes, getAllows, getContentType, getCorrelationId, getFirst, getHost, getUserAgent, set, setAcceptTypes, setAllows, setContentType, setCorrelationId, setHost, setUserAgent, toHttpCookies, withAcceptTypes, withAddCookie, withAddCookie, withAddTo, withAllows, withContentType, withCorrelationId, withHost, withSet, withSet, withUserAgent

Methods inherited from interface org.refcodes.net.HttpFields

getFirst, set, withAddTo

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

AbstractHeaderFields

public AbstractHeaderFields()

AbstractHeaderFields

public AbstractHeaderFields(Map<String,List<String>> aFromHeaderFields)

Method Detail

get

public List<String> get(Object aKey)

Specified by:

get in interface Map<String,List<String>>

Overrides:

get in class HashMap<String,List<String>>

put

public List<String> put(String key,
                        List<String> value)

Specified by:

put in interface Map<String,List<String>>

Overrides:

put in class HashMap<String,List<String>>

addTo

public void addTo(String aHeaderField,
                  String aValue)

Description copied from interface: HttpFields

Adds a value to the list of values associated with the given header field (key),

Specified by:

addTo in interface HttpFields<T extends HeaderFields<C,T>>

Parameters:

aHeaderField - The header field (key) of which's list of values a value is to be added.

aValue - The value to be added to the list of values associated to the given header field (key).

addCookie

public C addCookie(C aCookie)

Description copied from interface: HeaderFields

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 HeaderFields.getCookies() and HeaderFields.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 HeaderFields.addCookie(String, String) OR HeaderFields.withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE .

Specified by:

addCookie in interface HeaderFields<C extends Cookie,T extends HeaderFields<C,T>>

Parameters:

aCookie - The cookie to be added.

Returns:

The resulting cookie builder being added which can be modified affecting(!) this ResponseHeaderFields instance!

getCookies

public List<C> getCookies()

Description copied from interface: HeaderFields

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 HeaderFields.getCookies() and HeaderFields.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 HeaderFields.addCookie(String, String) OR HeaderFields.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.

Specified by:

getCookies in interface HeaderFields<C extends Cookie,T extends HeaderFields<C,T>>

Returns:

An array containing the cookies (key/value) stored in this RequestHeaderFields instance.

addCookie

public C addCookie(String aCookieName,
                   String aValue)

Description copied from interface: HeaderFields

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 HeaderFields.getCookies() and HeaderFields.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 HeaderFields.addCookie(String, String) OR HeaderFields.withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE .

Specified by:

addCookie in interface HeaderFields<C extends Cookie,T extends HeaderFields<C,T>>

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!

getCookie

public List<C> getCookie(String aCookieName)

Description copied from interface: HeaderFields

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 HeaderFields.getCookies() and HeaderFields.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 HeaderFields.addCookie(String, String) OR HeaderFields.withAddCookie(String, String) CANNOT BE RETRIEVED, AS THE COOKIES BEING SET SERVER-SIDE ARE PUT IN THE #HEADER_FIELD_COOKIE .

Specified by:

getCookie in interface HeaderFields<C extends Cookie,T extends HeaderFields<C,T>>

Parameters:

aCookieName - The name of the cookie to be retrieved.

Returns:

The values of the cookie found for the according name.

getCookieFieldName

protected abstract String getCookieFieldName()

The header field name for the Cookie elements. The header field name differs from the context, e.g. when setting a Cookie server-side or when retrieving a Cookie client-side.

Returns:

The header field where the Cookie elements are stored.

createCookie

protected abstract C createCookie(String aCookieName,
                                  String aValue)

Creates a plain Cookie with the given name and value.

Parameters:

aCookieName - The name of the Cookie.

aValue - The value for the Cookie

Returns:

The Cookie with the given name and value.

createCookie

protected abstract C createCookie(String aHttpCookie)

Creates a Cookie from the given HTTP cookie String as retrieved from the according header field.

Parameters:

aHttpCookie - The text of the header field for the cookie to be created.

Returns:

The Cookie with the given cookie properties.