Package org.forgerock.openig.handler

Class StaticResponseHandler

  • All Implemented Interfaces:
    Handler
    public class StaticResponseHandler
extends Object
implements Handler
    Creates a static HTTP response.

    • Constructor Detail

      • StaticResponseHandler

        public StaticResponseHandler​(Status status)
        Constructor.
        Parameters:
        status - The response status to set.

      • StaticResponseHandler

        public StaticResponseHandler​(Status status,
                             Expression<String> entity)
        Constructor.
        Parameters:
        status - The response status to set.
        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.

      • addTrailer

        public StaticResponseHandler addTrailer​(String key,
                                        Expression<String> expression)
        Adds a pair key / expression to the trailer.
        Parameters:
        key - The trailer 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.