org.refcodes.net.impls

Class ResponseCookieImpl

java.lang.Object

org.refcodes.collection.impls.RelationImpl<String,String>

org.refcodes.collection.impls.PropertyImpl

org.refcodes.net.impls.ResponseCookieImpl

All Implemented Interfaces:

org.refcodes.collection.Property, org.refcodes.collection.Relation<String,String>, org.refcodes.mixin.DomainAccessor, org.refcodes.mixin.DomainAccessor.DomainBuilder<ResponseCookie>, org.refcodes.mixin.DomainAccessor.DomainMutator, org.refcodes.mixin.DomainAccessor.DomainProperty, 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.mixin.PathAccessor, org.refcodes.mixin.PathAccessor.PathBuilder<ResponseCookie>, org.refcodes.mixin.PathAccessor.PathMutator, org.refcodes.mixin.PathAccessor.PathProperty, 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>, Cookie, ResponseCookie

public class ResponseCookieImpl
extends org.refcodes.collection.impls.PropertyImpl
implements ResponseCookie

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.

See Also:

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

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>

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

org.refcodes.mixin.PathAccessor.PathBuilder<B extends org.refcodes.mixin.PathAccessor.PathBuilder<?>>, org.refcodes.mixin.PathAccessor.PathMutator, org.refcodes.mixin.PathAccessor.PathProperty

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

org.refcodes.mixin.DomainAccessor.DomainBuilder<B extends org.refcodes.mixin.DomainAccessor.DomainBuilder<?>>, org.refcodes.mixin.DomainAccessor.DomainMutator, org.refcodes.mixin.DomainAccessor.DomainProperty

Field Summary

Fields inherited from class org.refcodes.collection.impls.RelationImpl

_key, _value

Constructor Summary

Constructors

Constructor and Description
ResponseCookieImpl()
ResponseCookieImpl(Cookie aCookie) Constructs a ResponseCookie.
ResponseCookieImpl(String aHttpCookie) Constructs a ResponseCookie.
ResponseCookieImpl(String aCookieName, String aValue) Constructs a ResponseCookie.
ResponseCookieImpl(String aCookieName, String aValue, Date aExpiresDate, String aDomain, String aPath, boolean isSecure, boolean isHttpOnly) Constructs a ResponseCookie.

Method Summary

Modifier and Type	Method and Description
String	getDomain()
Date	getExpiresDate()
String	getPath()
boolean	isHttpOnly()
boolean	isSecure()
void	setDomain(String aDomain)
void	setExpiresAfter(org.refcodes.time.TimeUnit aTimeUnit, long aTime) Sets the expires date to the current time plus the provided time.
void	setExpiresDate(Date aExpireDate)
void	setHttpOnly(boolean isHttpOnly)
void	setPath(String aPath)
void	setSecure(boolean isSecure)

Methods inherited from class org.refcodes.collection.impls.PropertyImpl

toString, withKey, withValue

Methods inherited from class org.refcodes.collection.impls.RelationImpl

getKey, getValue, setKey, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.net.ResponseCookie

setCookie, toHttpCookie, withDomain, withExpiresAfter, withExpiresDate, withHttpCookie, withHttpOnly, withPath, withSecure

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

Constructor Detail

ResponseCookieImpl

public ResponseCookieImpl()

ResponseCookieImpl

public ResponseCookieImpl(String aCookieName,
                          String aValue)

Constructs a ResponseCookie.

Parameters:

aCookieName - The name of the cookie.

aValue - The value for the cookie.

ResponseCookieImpl

public ResponseCookieImpl(String aHttpCookie)

Constructs a ResponseCookie.

Parameters:

aHttpCookie - The text as being found in the according HTTP header field.

Throws:

ParseException - Thrown in case parsing a value such as a date failed.

ResponseCookieImpl

public ResponseCookieImpl(Cookie aCookie)

Constructs a ResponseCookie.

Parameters:

aCookie - The Cookie from which to take the data.

ResponseCookieImpl

public ResponseCookieImpl(String aCookieName,
                          String aValue,
                          Date aExpiresDate,
                          String aDomain,
                          String aPath,
                          boolean isSecure,
                          boolean isHttpOnly)

Constructs a ResponseCookie.

Parameters:

aCookieName - The name for the cookie

aValue - The value of the cookie

aExpiresDate - The expiration date of the cookie

aDomain - The domain of the cookie

aPath - The path of the cookie

isSecure - The secure flag of the cookie

isHttpOnly - The HTTP-only flog of the cookie

Method Detail

getPath

public String getPath()

Specified by:

getPath in interface org.refcodes.mixin.PathAccessor

setPath

public void setPath(String aPath)

Specified by:

setPath in interface org.refcodes.mixin.PathAccessor.PathMutator

getExpiresDate

public Date getExpiresDate()

Specified by:

getExpiresDate in interface ResponseCookie

setExpiresDate

public void setExpiresDate(Date aExpireDate)

Specified by:

setExpiresDate in interface ResponseCookie

getDomain

public String getDomain()

Specified by:

getDomain in interface org.refcodes.mixin.DomainAccessor

setDomain

public void setDomain(String aDomain)

Specified by:

setDomain in interface org.refcodes.mixin.DomainAccessor.DomainMutator

setSecure

public void setSecure(boolean isSecure)

Specified by:

setSecure in interface ResponseCookie

isSecure

public boolean isSecure()

Specified by:

isSecure in interface ResponseCookie

isHttpOnly

public boolean isHttpOnly()

Specified by:

isHttpOnly in interface ResponseCookie

setHttpOnly

public void setHttpOnly(boolean isHttpOnly)

Specified by:

setHttpOnly in interface ResponseCookie

setExpiresAfter

public void setExpiresAfter(org.refcodes.time.TimeUnit aTimeUnit,
                            long aTime)

Description copied from interface: ResponseCookie

Sets the expires date to the current time plus the provided time. Use ResponseCookie.getExpiresDate() to retrieve the resulting effective Date.

Specified by:

setExpiresAfter in interface ResponseCookie

Parameters:

aTimeUnit - The TimeUnit of the provided time

aTime - The provided time after which to expire