Package org.forgerock.openig.filter

Class SetCookieUpdateFilter

java.lang.Object

org.forgerock.openig.filter.SetCookieUpdateFilter

All Implemented Interfaces:

Filter

public class SetCookieUpdateFilter
extends Object
implements Filter

This filter allows modification of response cookie attribute values for cookies found in the Set-Cookies header.

Configuration:

{
      "type": "SetCookieUpdateFilter",
      "config": {
        "cookies" {          : map                              [REQUIRED]
          <cookieName> {       : Pattern                        [REQUIRED] The cookie name as a {@link Pattern}.
            <attribute-name>     : String                         [REQUIRED] The cookie attribute's name to
                                                                             update. (1)
            <value>              : Runtime expression             [REQUIRED] The new value for this attribute, which
                                       <string|boolean|integer>              may be of string, integer or boolean.
          }
        }
      }
 }
 
 

Example:

{
      "type": "SetCookieUpdateFilter",
      "config": {
        "cookies": {
          "myCookie": {
            "value": "${previous}@ig",
            "secure": "${false}"
            "max_age": "${attributes.maxAge}"
          },
          ".*": {
            "SameSite": "LAX"
          }
        }
      }
 }
 
 

Note: for ${previous} expression use, refer to CookieModification.apply(Cookie, Bindings), where the old attribute value, if any, is stored or null otherwise.

See Also:

• Set-Cookie Syntax (1).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetCookieUpdateFilter.Heaplet	Creates and initializes a SetCookieUpdateFilter in a heap environment.

Constructor Summary

Constructors

Constructor	Description
SetCookieUpdateFilter(List<org.forgerock.openig.filter.CookieModifier> cookiesToUpdate)	Creates a SetCookieUpdateFilter, which updates given attribute values for an existing cookie.

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

SetCookieUpdateFilter

public SetCookieUpdateFilter(List<org.forgerock.openig.filter.CookieModifier> cookiesToUpdate)

Creates a SetCookieUpdateFilter, which updates given attribute values for an existing cookie.

Parameters:

cookiesToUpdate - The List containing the cookie modifications of CookieModifier, not null.

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.