Package org.forgerock.openig.filter

Class UriPathRewriteFilter

java.lang.Object

org.forgerock.openig.filter.UriPathRewriteFilter

All Implemented Interfaces:

Filter

public class UriPathRewriteFilter
extends Object
implements 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).

See Also:

RFC 3986 section 3.3 URI path specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UriPathRewriteFilter.Heaplet	Create a UriPathRewriteFilter in a heap environment.

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

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 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.