Package org.forgerock.openig.filter
Class ConditionEnforcementFilter
- java.lang.Object
-
- org.forgerock.openig.filter.ConditionEnforcementFilter
-
- All Implemented Interfaces:
Filter
public class ConditionEnforcementFilter extends Object implements Filter
AnConditionEnforcementFilter
makes sure that the handledRequest
verifies a condition. If the condition is verified, the chain of execution continues. If the condition is not verified, it returns a 403 Forbidden response by default, that actually stops the chain or could refer to a failure handler.Configuration options:
{ "condition" : expression, [REQUIRED] "failureHandler : handler [OPTIONAL - default to 403] }
{ "type": "ConditionEnforcementFilter", "config": { "condition" : "${not empty(attributes.myAttribute)}", "failureHandler" : "ConditionFailed" } }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ConditionEnforcementFilter.Heaplet
Creates and initializes an ConditionEnforcementFilter in a heap environment.
-
Constructor Summary
Constructors Constructor Description ConditionEnforcementFilter(Expression<Boolean> condition)
Creates a newConditionEnforcementFilter
.ConditionEnforcementFilter(Expression<Boolean> condition, Handler failureHandler)
Creates a newConditionEnforcementFilter
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Promise<Response,NeverThrowsException>
filter(Context context, Request request, Handler next)
Filters the request and/or response of an exchange.
-
-
-
Constructor Detail
-
ConditionEnforcementFilter
public ConditionEnforcementFilter(Expression<Boolean> condition)
Creates a newConditionEnforcementFilter
. If the condition fails, defaultHandlers.FORBIDDEN
will be used.- Parameters:
condition
-Expression
that needs to evaluates to true to continue the chain of execution.
-
ConditionEnforcementFilter
public ConditionEnforcementFilter(Expression<Boolean> condition, Handler failureHandler)
Creates a newConditionEnforcementFilter
.- Parameters:
condition
-Expression
that needs to evaluates to true to continue the chain of execution.failureHandler
- The handler which will be invoked when condition fails.
-
-
Method Detail
-
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 callsnext.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.
-
-