Package org.forgerock.openig.wellknown

Class WellKnownEndpointFilter

java.lang.Object

org.forgerock.openig.wellknown.WellKnownEndpointFilter

All Implemented Interfaces:

Filter

public class WellKnownEndpointFilter
extends Object
implements Filter

Provide a central place to register top-level well-known endpoints.

This is an evolving API, shouldn't be exposed to customers (at least yet).

Constructor Summary

Constructors

Constructor	Description
WellKnownEndpointFilter(WellKnownEndpointManager manager)	Construct a well-known endpoint filter with the given manager.

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

WellKnownEndpointFilter

public WellKnownEndpointFilter(WellKnownEndpointManager manager)

Construct a well-known endpoint filter with the given manager.

Parameters:

manager - the manager to use (never 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.