Class CookieCache

java.lang.Object

java.util.AbstractCollection<HttpCookie>

java.util.AbstractList<HttpCookie>

org.eclipse.jetty.server.CookieCache

All Implemented Interfaces:

Iterable<HttpCookie>, Collection<HttpCookie>, List<HttpCookie>, SequencedCollection<HttpCookie>, ComplianceViolation.Listener, CookieParser.Handler

public class CookieCache
extends AbstractList<HttpCookie>
implements CookieParser.Handler, ComplianceViolation.Listener

Cookie parser

Optimized stateful cookie parser. If the added fields are identical to those last added (as strings), then the cookies are not re-parsed.

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<String>	_rawFields
protected static final org.slf4j.Logger	LOG

Fields inherited from class AbstractList

modCount

Fields inherited from interface ComplianceViolation.Listener

NOOP

Constructor Summary

Constructors

Constructor	Description
CookieCache()
CookieCache(CookieCompliance compliance)

Method Summary

Modifier and Type	Method	Description
void	addCookie(String cookieName, String cookieValue, int cookieVersion, String cookieDomain, String cookiePath, String cookieComment)
HttpCookie	get(int index)
<C> C[]	getApiCookies(Class<C> apiClass, Function<HttpCookie, C> convertor)
static <C> C[]	getApiCookies(Request request, Class<C> cookieClass, Function<HttpCookie, C> convertor)	Get the API specific cookies for a request.
static List<HttpCookie>	getCookies(Request request)	Get the core HttpCookies for a request.
void	onComplianceViolation(ComplianceViolation.Event event)	The compliance violation event.
void	parseCookies(HttpFields headers, ComplianceViolation.Listener complianceViolationListener)
int	size()

Methods inherited from class AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface ComplianceViolation.Listener

initialize, onComplianceViolation, onRequestBegin, onRequestEnd

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

addAll, addFirst, addLast, contains, containsAll, getFirst, getLast, isEmpty, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, sort, spliterator, toArray, toArray

Field Details

LOG

protected static final org.slf4j.Logger LOG

_rawFields

protected final List<String> _rawFields

Constructor Details

CookieCache

public CookieCache()

CookieCache

public CookieCache(CookieCompliance compliance)

Method Details

getCookies

public static List<HttpCookie> getCookies(Request request)

Get the core HttpCookies for a request. Cookies may be cached as a request attribute, failing that they may be cached in the Component cache, in which case they will be checked to see if they have changed since a previous request. Otherwise, they are parsed from the request headers and both caches updated.

Parameters:

request - The request to obtain cookies from

Returns:

A list of core HttpCookies from the request.

See Also:

• getApiCookies(Request, Class, Function)

getApiCookies

public static <C> C[] getApiCookies(Request request,
 Class<C> cookieClass,
 Function<HttpCookie, C> convertor)

Get the API specific cookies for a request. Internally the same caching/parsing is done as by getCookies(Request) and the core HttpCookies are obtained. The passed convertor function is used to covert the core HttpCookies to API specific cookies and the results cached along with the core HttpCookies

Type Parameters:

C - The class of the cookie API

Parameters:

request - The request to get the cookies from.

cookieClass - The class of the cookie API

convertor - A function to convert from a HttpCookie to an API cookie of type cookieClass. The function may return null if the cookie is not compliant with the API.

Returns:

An array of API specific cookies.

get

public HttpCookie get(int index)

Specified by:

get in interface List<HttpCookie>

Specified by:

get in class AbstractList<HttpCookie>

size

public int size()

Specified by:

size in interface Collection<HttpCookie>

Specified by:

size in interface List<HttpCookie>

Specified by:

size in class AbstractCollection<HttpCookie>

onComplianceViolation

public void onComplianceViolation(ComplianceViolation.Event event)

Description copied from interface: ComplianceViolation.Listener

The compliance violation event.

Specified by:

onComplianceViolation in interface ComplianceViolation.Listener

Parameters:

event - the compliance violation event

addCookie

public void addCookie(String cookieName,
 String cookieValue,
 int cookieVersion,
 String cookieDomain,
 String cookiePath,
 String cookieComment)

Specified by:

addCookie in interface CookieParser.Handler

parseCookies

public void parseCookies(HttpFields headers,
 ComplianceViolation.Listener complianceViolationListener)

getApiCookies

public <C> C[] getApiCookies(Class<C> apiClass,
 Function<HttpCookie, C> convertor)