org.refcodes.net

Interface RequestCookie

All Superinterfaces:

Cookie, org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.KeyAccessor.KeyBuilder<String,org.refcodes.collection.Relation<String,String>>, org.refcodes.mixin.KeyAccessor.KeyMutator<String>, org.refcodes.mixin.KeyAccessor.KeyProperty<String>, org.refcodes.collection.Property, org.refcodes.collection.Relation<String,String>, org.refcodes.mixin.ValueAccessor<String>, org.refcodes.mixin.ValueAccessor.ValueBuilder<String,org.refcodes.collection.Relation<String,String>>, org.refcodes.mixin.ValueAccessor.ValueMutator<String>, org.refcodes.mixin.ValueAccessor.ValueProperty<String>

All Known Implementing Classes:

RequestCookieImpl

public interface RequestCookie
extends Cookie

The RequestCookie represents a request cookie.

Nested Class Summary

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

org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B extends org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B>>, org.refcodes.mixin.KeyAccessor.KeyMutator<K>, org.refcodes.mixin.KeyAccessor.KeyProperty<K>

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

org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V>, org.refcodes.mixin.ValueAccessor.ValueProperty<V>

Method Summary

Modifier and Type	Method and Description
default void	setCookie(String aCookie) Sets the cookie according to the provided HTP cookie text.
default String	toHttpCookie() Returns the cookie to be assigned to a cookie header field to be sent by a server to a client.
default RequestCookie	withHttpCookie(String aCookie) Sets the cookie according to the provided HTP cookie text.

Methods inherited from interface org.refcodes.collection.Property

withKey, withValue

Methods inherited from interface org.refcodes.mixin.KeyAccessor

getKey

Methods inherited from interface org.refcodes.mixin.KeyAccessor.KeyMutator

setKey

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValue

Methods inherited from interface org.refcodes.mixin.ValueAccessor.ValueMutator

setValue

Method Detail

setCookie

default void setCookie(String aCookie)

Description copied from interface: Cookie

Sets the cookie according to the provided HTP cookie text.

Specified by:

setCookie in interface Cookie

Parameters:

aCookie - The HTTP cookie text.

withHttpCookie

default RequestCookie withHttpCookie(String aCookie)

Description copied from interface: Cookie

Sets the cookie according to the provided HTP cookie text.

Specified by:

withHttpCookie in interface Cookie

Parameters:

aCookie - The HTTP cookie text.

Returns:

A Cookie instance as of the builder pattern.

toHttpCookie

default String toHttpCookie()

Description copied from interface: Cookie

Returns the cookie to be assigned to a cookie header field to be sent by a server to a client. As of "HTTP cookies explained - NCZOnline": "... There is some confusion over encoding of a cookie value. The commonly held belief is that cookie values must be URL-encoded, but this is a fallacy even though it is the de facto implementation. The original specification indicates that only three types of characters must be encoded: semicolon, comma, and white space. The specification indicates that URL encoding may be used but stops short of requiring it. The RFC makes no mention of encoding whatsoever. Still, almost all implementations perform some sort of URL encoding on cookie values. In the case of name=value formats, the name and value are typically encoded separately while the equals sign is left as is. ..." Therefore we use URL encoding to make life easier and not fall into the trap of unescaped values.

Specified by:

toHttpCookie in interface Cookie

Returns:

The cookie value for a header field.

See Also:

"https://www.nczonline.net/blog/2009/05/05/http-cookies-explained"