Package org.forgerock.http.swagger

Class OpenApiRequestFilter

java.lang.Object

org.forgerock.http.swagger.OpenApiRequestFilter

All Implemented Interfaces:

Filter

public class OpenApiRequestFilter
extends Object
implements Filter

This filter looks for the query parameter {code _api} : if present then it returns the API description of the downstream handlers, otherwise the request is processed as expected.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_PARAMETER	Request parameter for the OpenAPI API Descriptor.

Constructor Summary

Constructors

Constructor	Description
OpenApiRequestFilter()

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.
protected io.swagger.models.Swagger	setUriDetailsIfNotPresent(Request request, Context context, io.swagger.models.Swagger descriptor)	Deduce and set the base URI of the request for the OpenAPI descriptor from the request context.

Methods inherited from class java.lang.Object

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

Field Details

API_PARAMETER

public static final String API_PARAMETER

Request parameter for the OpenAPI API Descriptor.

See Also:

• Constant Field Values

Constructor Details

OpenApiRequestFilter

public OpenApiRequestFilter()

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.

setUriDetailsIfNotPresent

protected io.swagger.models.Swagger setUriDetailsIfNotPresent(Request request,
 Context context,
 io.swagger.models.Swagger descriptor)

Deduce and set the base URI of the request for the OpenAPI descriptor from the request context. This method should set the basePath, schemes and host properties on the descriptor.

Parameters:

request - The CHF request.

context - The CHF request context.

descriptor - The descriptor object.

Returns:

The updated descriptor object.