org.forgerock.openig.handler

Class StaticResponseHandler

java.lang.Object

org.forgerock.openig.handler.StaticResponseHandler

All Implemented Interfaces:

Handler

public class StaticResponseHandler
extends Object
implements Handler

Creates a static HTTP response.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticResponseHandler.Heaplet Creates and initializes a static response handler in a heap environment.

Constructor Summary

Constructors

Constructor and Description
StaticResponseHandler(Status status) Constructor.
StaticResponseHandler(Status status, String version, Expression<String> entity) Constructor.

Method Summary

Modifier and Type	Method and Description
StaticResponseHandler	addHeader(String key, Expression<String> expression) Adds a pair key / expression to the header.
Promise<Response,NeverThrowsException>	handle(Context context, Request request) Returns a Promise representing the asynchronous Response of the given request.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticResponseHandler

public StaticResponseHandler(Status status)

Constructor.

Parameters:

status - The response status to set.

StaticResponseHandler

public StaticResponseHandler(Status status,
                             String version,
                             Expression<String> entity)

Constructor.

Parameters:

status - The response status to set.

version - The protocol version.

entity - The message entity expression.

Method Detail

addHeader

public StaticResponseHandler addHeader(String key,
                                       Expression<String> expression)

Adds a pair key / expression to the header.

Parameters:

key - The header key.

expression - The expression to evaluate.

Returns:

The current static response handler.

handle

public Promise<Response,NeverThrowsException> handle(Context context,
                                                     Request request)

Description copied from interface: Handler

Returns a Promise representing the asynchronous Response of the given request. If any (asynchronous) processing goes wrong, the promise still contains a Response (probably from the 4xx or 5xx status code family).

A handler that doesn't hand-off the processing to another downstream handler is responsible for creating the response.

The returned Promise contains the response returned from the server as-is. This is responsibility of the handler to produce the appropriate error response (404, 500, ...) in case of processing error.

Note: As of Promise 2.0 implementation, it is not permitted to throw any runtime exception here. Doing so produce unexpected behaviour (most likely a server-side hang of the processing thread).

Specified by:

handle in interface Handler

Parameters:

context - The request context.

request - The request.

Returns:

A Promise representing the response to be returned to the caller.