Package net.officefloor.server.http

Interface HttpResponseCookies

All Superinterfaces:

java.lang.Iterable<HttpResponseCookie>

All Known Implementing Classes:

ProcessAwareHttpResponseCookies

public interface HttpResponseCookies
extends java.lang.Iterable<HttpResponseCookie>

HttpResponseCookie instances for the HttpResponse.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
HttpResponseCookie	getCookie(java.lang.String name)	Obtains the HttpResponseCookie by name.
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 interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

setCookie

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

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.

Parameters:

name - Name.

value - Value.

Returns:

HttpRequestCookie.

setCookie

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

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.

Parameters:

name - Name.

value - Value.

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

Returns:

HttpResponseCookie.

setCookie

HttpResponseCookie setCookie(HttpRequestCookie cookie)

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.

Parameters:

cookie - HttpRequestCookie.

Returns:

HttpResponseCookie.

setCookie

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

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.

Parameters:

cookie - HttpRequestCookie

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

Returns:

HttpResponseCookie.

removeCookie

boolean removeCookie(HttpResponseCookie cookie)

Removes the HttpResponseCookie.

Parameters:

cookie - HttpResponseCookie.

Returns:

true if the HttpResponseCookie was removed.

getCookie

HttpResponseCookie getCookie(java.lang.String name)

Obtains the HttpResponseCookie by name.

Parameters:

name - Name of the HttpResponseCookie.

Returns:

HttpResponseCookie or null if no HttpResponseCookie by the name.