Package org.forgerock.http.swagger
Class OpenApiRequestFilter
- java.lang.Object
-
- org.forgerock.http.swagger.OpenApiRequestFilter
-
-
Field Summary
Fields Modifier and Type Field Description static String
API_PARAMETER
Request parameter for the OpenAPI API Descriptor.
-
Constructor Summary
Constructors Constructor Description OpenApiRequestFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.
-
-
-
Field Detail
-
API_PARAMETER
public static final String API_PARAMETER
Request parameter for the OpenAPI API Descriptor.- See Also:
- Constant Field Values
-
-
Method Detail
-
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 callsnext.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.
-
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 thebasePath
,schemes
andhost
properties on the descriptor.- Parameters:
request
- The CHF request.context
- The CHF request context.descriptor
- The descriptor object.- Returns:
- The updated descriptor object.
-
-