Class ConditionEnforcementFilter

  • All Implemented Interfaces:
    Filter

    public class ConditionEnforcementFilter
    extends Object
    implements Filter
    An ConditionEnforcementFilter makes sure that the handled Request 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]
     }
     
    
     
    For example:
     
     {
         "type": "ConditionEnforcementFilter",
         "config": {
             "condition"             : "${not empty(attributes.myAttribute)}",
             "failureHandler"        : "ConditionFailed"
         }
     }
     
     
    • 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 calls next.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.

        Specified by:
        filter in interface Filter
        Parameters:
        context - The request context.
        request - The request.
        next - The next filter or handler in the chain to handle the request.
        Returns:
        A Promise representing the response to be returned to the client.