Mercurial > hg > release > thermostat-0.13
view web/server/src/main/java/com/redhat/thermostat/web/server/auth/StatementFilter.java @ 1212:5107ada6cee5
Implement ACL based filters for queries.
Reviewed-by: ebaron
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-August/007739.html
PR1461
author | Severin Gehwolf <sgehwolf@redhat.com> |
---|---|
date | Thu, 25 Jul 2013 17:45:33 +0200 |
parents | |
children |
line wrap: on
line source
/* * Copyright 2012, 2013 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation; either version 2, or (at your * option) any later version. * * Thermostat is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.web.server.auth; import com.redhat.thermostat.storage.core.PreparedStatement; import com.redhat.thermostat.storage.core.StatementDescriptor; import com.redhat.thermostat.storage.core.auth.DescriptorMetadata; import com.redhat.thermostat.storage.model.Pojo; import com.redhat.thermostat.storage.query.Expression; /** * A filter suitable to get applied to {@link PreparedStatement}s before they * are executed. * */ interface StatementFilter<T extends Pojo> { /** * Applies this filter. Note that filters may be chained. * * @param desc * The statement descriptor to apply the filter to. * @param metaData * Metadata pertaining to the given descriptor. * @param parentExpression * The Expression as constructed by the previous Filter. May be * null. * @return A filtered result with the Expression set to use for filtering if * result type was QUERY_EXPRESSION. */ FilterResult applyFilter(StatementDescriptor<T> desc, DescriptorMetadata metaData, Expression parentExpression); }