Package org.forgerock.openig.filter

Class SplitCookieFilter

java.lang.Object

org.forgerock.openig.filter.SplitCookieFilter

All Implemented Interfaces:

Filter

public final class SplitCookieFilter
extends Object
implements Filter

Split a target cookie when it is bigger than 4Kb (see RFC 6265) in smaller cookies.

If the split tracked cookie is found in the request, it will be reassembled transparently.

If the cookie name maps multiple cookies, only the first one will be taken into account.

if the tracked cookie is too big, the cookie will be replaced by several cookies named [originalCookieName][partNumber].

For example, if the tracked cookie is named "myCookie" and is 10Kb long, then it will be split into 3 cookies named : "myCookie0", "myCookie1" and "myCookie2", the 2 first weighting 4Kb and the last 2Kb.

Constructor Summary

Constructors

Constructor	Description
SplitCookieFilter(String cookieName)	Create a new SplitCookieFilter.

Method Summary

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.

Methods inherited from class java.lang.Object

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

Constructor Details

SplitCookieFilter

public SplitCookieFilter(String cookieName)

Create a new SplitCookieFilter.

Parameters:

cookieName - the name of the cookie to look for

Method Details

filter

public Promise<Response,NeverThrowsException> filter(Context context,
 Request request,
 Handler next)

Description copied from interface: Filter

Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter calls next.handle(context, request).

This method may elect not to pass the request to the next filter or handler, and instead handle the request itself. It can achieve this by merely avoiding a call to next.handle(context, request) and creating its own response object. The filter is also at liberty to replace a response with another of its own by intercepting the response returned by the next handler.

Specified by:

filter in interface Filter

Parameters:

context - The request context.

request - The request.

next - The next filter or handler in the chain to handle the request.

Returns:

A Promise representing the response to be returned to the client.