Package net.officefloor.server.http.impl

Class ProcessAwareHttpResponseCookies

java.lang.Object

net.officefloor.server.http.impl.ProcessAwareHttpResponseCookies

All Implemented Interfaces:

java.lang.Iterable<HttpResponseCookie>, HttpResponseCookies

public class ProcessAwareHttpResponseCookies
extends java.lang.Object
implements HttpResponseCookies

ProcessState aware HttpResponseCookies.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ProcessAwareHttpResponseCookies(ManagedObjectContext context)	Instantiate.

Method Summary

Modifier and Type	Method	Description
HttpResponseCookie	getCookie(java.lang.String name)	Obtains the HttpResponseCookie by name.
WritableHttpCookie	getWritableHttpCookie()	Obtains the head WritableHttpCookie to the linked list of WritableHttpCookie instances for the HttpResponseWriter.
java.util.Iterator<HttpResponseCookie>	iterator()
boolean	removeCookie(HttpResponseCookie cookie)	Removes the HttpResponseCookie.
HttpResponseCookie	setCookie(java.lang.String name, java.lang.String value)	Sets a HttpResponseCookie.
HttpResponseCookie	setCookie(java.lang.String name, java.lang.String value, java.util.function.Consumer<HttpResponseCookie> initialiser)	Sets a HttpResponseCookie.
HttpResponseCookie	setCookie(HttpRequestCookie cookie)	Sets a HttpResponseCookie from a HttpRequestCookie.
HttpResponseCookie	setCookie(HttpRequestCookie cookie, java.util.function.Consumer<HttpResponseCookie> initialiser)	Sets a HttpResponseCookie from a HttpRequestCookie.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ProcessAwareHttpResponseCookies

public ProcessAwareHttpResponseCookies(ManagedObjectContext context)

Instantiate.

Parameters:

context - ManagedObjectContext.

Method Detail

getWritableHttpCookie

public WritableHttpCookie getWritableHttpCookie()

Obtains the head WritableHttpCookie to the linked list of WritableHttpCookie instances for the HttpResponseWriter.

Returns:

Head WritableHttpCookie to the linked list of WritableHttpCookie instances for the HttpResponseWriter. May be null.

iterator

public java.util.Iterator<HttpResponseCookie> iterator()

Specified by:

iterator in interface java.lang.Iterable<HttpResponseCookie>

setCookie

public HttpResponseCookie setCookie(java.lang.String name,
                                    java.lang.String value)

Description copied from interface: HttpResponseCookies

Sets a HttpResponseCookie.

If a HttpResponseCookie already exists by the name, it is updated to the value and returned. Otherwise a new HttpResponseCookie is added for the name.

Specified by:

setCookie in interface HttpResponseCookies

Parameters:

name - Name.

value - Value.

Returns:

HttpRequestCookie.

setCookie

public HttpResponseCookie setCookie(java.lang.String name,
                                    java.lang.String value,
                                    java.util.function.Consumer<HttpResponseCookie> initialiser)

Description copied from interface: HttpResponseCookies

Sets a HttpResponseCookie.

If a HttpResponseCookie already exists by the name, it is updated to the value and returned. Otherwise a new HttpResponseCookie is added for the name.

Specified by:

setCookie in interface HttpResponseCookies

Parameters:

name - Name.

value - Value.

initialiser - Enables initialising the attributes of the HttpResponseCookie. This reduces locking in setting multiple attributes.

Returns:

HttpResponseCookie.

setCookie

public HttpResponseCookie setCookie(HttpRequestCookie cookie)

Description copied from interface: HttpResponseCookies

Sets a HttpResponseCookie from a HttpRequestCookie.

If a HttpResponseCookie already exists by the name, it is updated to the value and returned. Otherwise a new HttpResponseCookie is added for the name.

This is typically used to update the Cookie with the client. For example, expiring the Cookie to no longer be sent.

Specified by:

setCookie in interface HttpResponseCookies

Parameters:

cookie - HttpRequestCookie.

Returns:

HttpResponseCookie.

setCookie

public HttpResponseCookie setCookie(HttpRequestCookie cookie,
                                    java.util.function.Consumer<HttpResponseCookie> initialiser)

Description copied from interface: HttpResponseCookies

Sets a HttpResponseCookie from a HttpRequestCookie.

If a HttpResponseCookie already exists by the name, it is updated to the value and returned. Otherwise a new HttpResponseCookie is added for the name.

Specified by:

setCookie in interface HttpResponseCookies

Parameters:

cookie - HttpRequestCookie

initialiser - Enables initialising the attributes of the HttpResponseCookie. This reduces locking in setting multiple attributes.

Returns:

HttpResponseCookie.

removeCookie

public boolean removeCookie(HttpResponseCookie cookie)

Description copied from interface: HttpResponseCookies

Removes the HttpResponseCookie.

Specified by:

removeCookie in interface HttpResponseCookies

Parameters:

cookie - HttpResponseCookie.

Returns:

true if the HttpResponseCookie was removed.

getCookie

public HttpResponseCookie getCookie(java.lang.String name)

Description copied from interface: HttpResponseCookies

Obtains the HttpResponseCookie by name.

Specified by:

getCookie in interface HttpResponseCookies

Parameters:

name - Name of the HttpResponseCookie.

Returns:

HttpResponseCookie or null if no HttpResponseCookie by the name.