001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2013-2015 ForgeRock AS. 015 */ 016 017package org.forgerock.json.resource; 018 019import org.forgerock.services.context.Context; 020 021/** 022 * A condition which controls whether or not a filter will be invoked or not. 023 * 024 * @see Filters#conditionalFilter(FilterCondition, Filter) 025 */ 026public interface FilterCondition { 027 028 /** 029 * Returns {@code true} if the conditional filter should be invoked, or 030 * {@code false} if processing should continue directly to the next filter 031 * in the filter chain. 032 * 033 * @param context 034 * The filter chain context. 035 * @param request 036 * The request to be filtered. 037 * @return {@code true} if the conditional filter should be invoked. 038 */ 039 boolean matches(Context context, Request request); 040}