Package org.forgerock.openig.filter
Class UriPathRewriteFilter
java.lang.Object
org.forgerock.openig.filter.UriPathRewriteFilter
- All Implemented Interfaces:
Filter
Filter
supporting URL path rewriting. Configuration enables mapping from a given "from path" to a "to path"
and the reverse. Given a request URI path, the most specific mapping is selected to use to rewrite the URI. The
mapping's corresponding "to path" is used to rewrite response URI paths (e.g. LocationHeader
URI paths).
{
"type": "UriPathRewriteFilter",
"config": {
"mappings" : object [REQUIRED - Bi-directional path mappings.]
{
"<fromPath>": "<toPath>" : expressions [REQUIRED - Mapped paths. Cannot be empty.]
}
"failureHandler : Handler [OPTIONAL - Defaults to response with status 500.]
}
}
Example mapping configurations:
{
"name": "UriRewrite",
"type": "UriPathRewriteFilter",
"config": {
"mappings": {
"/fromPath1": "/toPath1",
"${env['fromPath']}": "${system['toPath']}"
}
}
}
Duplicate "from path" values will be removed without warning due to constraints in the JSON specification
(RFC 7159 section 4).-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Create aUriPathRewriteFilter
in a heap environment. -
Method Summary
-
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 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.
-