StaticResponseHandler
Prev Handlers Next

Name

StaticResponseHandler — create static response in HTTP exchange

Description

Creates a static response in an HTTP exchange.

Usage

{
     "name": string,
     "type": "StaticResponseHandler",
     "config": {
         "status": number,
         "reason": string,
         "version": string,
         "headers": {
             name: [ expression, ... ], ...
         },
         "entity": string
     }
}

Properties

"status": number, required

The response status code (for example, 200).

"reason": string, optional

The response status reason (for example, "OK").

"version": string, optional

Protocol version. Default: "HTTP/1.1".

"headers": array of objects, required

Header fields to set in the response. The name specifies the header name, with an associated array of expressions to evaluate as values.

"entity": string, optional

The message entity to write in the response. Conforms to the set Content-Type header and sets Content-Length.

Example

{
     "name": "ErrorHandler",
     "type":"StaticResponseHandler",
     "config": {
        "status": 500,
        "reason": "Error",
        "entity":"<html><h2>Epic #FAIL</h2></html>" 
     }
}

Javadoc

org.forgerock.openig.handler.StaticResponseHandler

Prev Up Next
SequenceHandler Home Filters