ContextAndRequest (OpenIG Project 5.3.2-SNAPSHOT API)

java.lang.Object
- org.forgerock.http.ContextAndRequest

public class ContextAndRequest
extends Object

This a value class to hold a Context and a Request during the processing of a request. It can be used as a parameter in a Function. Example:

 
 public class EnforcementFilter implements Filter {

     private final AsyncFunction<ContextAndRequest, Boolean, Exception> condition;

     public EnforcementFilter(AsyncFunction<ContextAndRequest, Boolean, Exception> condition) {
         this.condition = condition;
     }

     {@literal @}Override
     public Promise<Response, NeverThrowsException> filter(final Context context, final Request request,
             final Handler next) {
         return condition.apply(new ContextAndRequest(context, request))
                         .thenAsync(new AsyncFunction<Boolean, Response, NeverThrowsException>() {
                                        {@literal @}Override
                                        public Promise<? extends Response, ? extends NeverThrowsException> apply(
                                                Boolean condition) throws NeverThrowsException {
                                            if (condition) {
                                                return next.handle(context, request);
                                            }
                                            return newResponsePromise(new Response(Status.FORBIDDEN));
                                        }
                                    },
                                    new AsyncFunction<Exception, Response, NeverThrowsException>() {
                                        {@literal @}Override
                                        public Promise<? extends Response, ? extends NeverThrowsException> apply(
                                                Exception cause) throws NeverThrowsException {
                                            Response response = new Response(Status.INTERNAL_SERVER_ERROR);
                                            response.setCause(cause);
                                            return newResponsePromise(response);
                                        }
                                    });
     }
 }

See Also:: ThrottlingFilter

Constructor Summary

Constructors
Constructor and Description
`ContextAndRequest(org.forgerock.services.context.Context context, org.forgerock.http.protocol.Request request)` Constructs a new ContextAndRequest.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.forgerock.services.context.Context`	`getContext()` Returns the context.
`org.forgerock.http.protocol.Request`	`getRequest()` Returns the request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextAndRequest

public ContextAndRequest(org.forgerock.services.context.Context context,
                         org.forgerock.http.protocol.Request request)

Constructs a new ContextAndRequest.

Parameters:: context - the context; request - the request

Method Detail

getContext

public org.forgerock.services.context.Context getContext()

Returns the context.

Returns:: the context

getRequest

public org.forgerock.http.protocol.Request getRequest()

Returns the request.

Returns:: the request

Class ContextAndRequest