Package org.forgerock.openig.filter

Class LocationHeaderFilter

java.lang.Object

org.forgerock.openig.filter.LocationHeaderFilter

All Implemented Interfaces:

Filter

public class LocationHeaderFilter
extends Object
implements Filter

Rewrites Location headers on responses that generate a redirect that would take the user directly to the application being proxied rather than taking the user through the Identity Gateway. Options:

 
 {
   "baseURI"                     : expression        [OPTIONAL - default to the original URI
                                                                 of the request ]
 }
 
 

Example:

 
 {
      "name": "LocationRewriter",
      "type": "LocationHeaderFilter",
      "config": {
          "baseURI": "https://proxy.example.com:443/"
       }
 }
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocationHeaderFilter.Heaplet	Creates and initializes a LocationHeaderFilter in a heap environment.

Constructor Summary

Constructors

Constructor	Description
LocationHeaderFilter()

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.
void	setBaseURI(Expression<String> baseURI)	Sets the base URI used to rewrite Location headers.

Methods inherited from class java.lang.Object

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

Constructor Details

LocationHeaderFilter

public LocationHeaderFilter()

Method Details

setBaseURI

public void setBaseURI(Expression<String> baseURI)

Sets the base URI used to rewrite Location headers.

Parameters:

baseURI - expression that, when evaluated, will represents the base URI of this IG instance

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.