Package org.forgerock.openig.filter

Class StaticRequestFilter

java.lang.Object

org.forgerock.openig.filter.StaticRequestFilter

All Implemented Interfaces:

Filter

public class StaticRequestFilter
extends Object
implements Filter

Creates a new request and send it down the next handler (effectively replacing the previous request). The request can include a form, specified in the form field, which is included in an entity encoded in application/x-www-form-urlencoded format if request method is POST, or otherwise as (additional) query parameters in the URI.

 
 {
      "method"                     : string            [REQUIRED]
      "uri"                        : expression        [REQUIRED]
      "entity"                     : expression        [OPTIONAL - cannot be used simultaneously
                                                                   with a form in POST mode* ]
      "form"                       : object            [OPTIONAL]
      "headers"                    : object            [OPTIONAL]
      "version"                    : string            [OPTIONAL]
 }
 
 

*Note: When method is set to POST, the entity and the form CANNOT be used together in the heaplet because they both determine the request entity. They still can used programmatically together but the form will override any entity content.

Example of use:

 
 {
      "name": "customRequestFilter",
      "type": "StaticRequestFilter",
      "config": {
          "method": "POST",
          "uri": "http://10.10.0.2:8080/wp-login.php",
          "entity": "{\"auth\":{\"passwordCredentials\":
                     {\"username\":\"${attributes.username}\",
                      \"password\":\"${attributes.password}\"}}}"
          "headers": {
              "Warning": [ "199 Miscellaneous warning" ]
          }
      }
 }
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StaticRequestFilter.Heaplet	Creates and initializes a request filter in a heap environment.

Constructor Summary

Constructors

Constructor	Description
StaticRequestFilter(String method)	Builds a new StaticRequestFilter that will uses the given HTTP method on the resource.

Method Summary

Modifier and Type	Method	Description
StaticRequestFilter	addFormParameter(String name, Expression<String> value)	Adds a new form parameter using the given key with the given Expression.
StaticRequestFilter	addHeaderValue(String key, Expression<String> value)	Adds a new header value using the given key with the given Expression.
Promise<Response,NeverThrowsException>	filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.
void	setEntity(Expression<String> entity)	Sets the message entity expression.
void	setUri(Expression<String> uri)	Sets the target URI as an expression to allow dynamic URI construction.
void	setVersion(String version)	Sets the new request message's version.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticRequestFilter

public StaticRequestFilter(String method)

Builds a new StaticRequestFilter that will uses the given HTTP method on the resource.

Parameters:

method - The HTTP method to be performed on the resource

Method Detail

setEntity

public void setEntity(Expression<String> entity)

Sets the message entity expression.

Parameters:

entity - The message entity expression.

setUri

public void setUri(Expression<String> uri)

Sets the target URI as an expression to allow dynamic URI construction.

Parameters:

uri - target URI expression

setVersion

public void setVersion(String version)

Sets the new request message's version.

Parameters:

version - Protocol version (e.g. "HTTP/1.1").

addHeaderValue

public StaticRequestFilter addHeaderValue(String key,
                                          Expression<String> value)

Adds a new header value using the given key with the given Expression. As headers are multi-valued objects, it's perfectly legal to call this method multiple times with the same key.

Parameters:

key - Header name

value - Expression that represents the value of the new header

Returns:

this object for fluent usage

addFormParameter

public StaticRequestFilter addFormParameter(String name,
                                            Expression<String> value)

Adds a new form parameter using the given key with the given Expression. As form parameters are multi-valued objects, it's perfectly legal to call this method multiple times with the same key.

Parameters:

name - Form parameter name

value - Expression that represents the value of the parameter

Returns:

this object for fluent usage

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.