Package org.forgerock.openig.filter

Class DateHeaderFilter

java.lang.Object

org.forgerock.openig.filter.DateHeaderFilter

All Implemented Interfaces:

Filter

public final class DateHeaderFilter
extends Object
implements Filter

This filter inserts a Date header into the response if it is not present.

See Also:

• RFC7231#section-7.1.1.2
• OpenID Financial API - Protected resources provisions

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name of this header.

Constructor Summary

Constructors

Constructor	Description
DateHeaderFilter(Clock clock)	Creates a DateHeaderFilter.

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

Field Details

NAME

public static final String NAME

The name of this header.

See Also:

• Constant Field Values

Constructor Details

DateHeaderFilter

public DateHeaderFilter(Clock clock)

Creates a DateHeaderFilter.

Parameters:

clock - the clock to use to get the timestamp.

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.