001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.server.core.authz.support; 021 022 023import java.util.Collection; 024 025import org.apache.directory.api.ldap.aci.ACITuple; 026import org.apache.directory.api.ldap.model.constants.Loggers; 027import org.apache.directory.api.ldap.model.entry.Entry; 028import org.apache.directory.api.ldap.model.exception.LdapException; 029import org.slf4j.Logger; 030import org.slf4j.LoggerFactory; 031 032 033/** 034 * An interface that filters the specified collection of tuples using the 035 * specified extra information. 036 * 037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 038 * 039 */ 040public interface ACITupleFilter 041{ 042 /** the dedicated logger for ACI */ 043 Logger ACI_LOG = LoggerFactory.getLogger( Loggers.ACI_LOG.getName() ); 044 045 046 /** 047 * Returns the collection of the filtered tuples using the specified 048 * extra information. 049 * 050 * @param aciContext the container for ACI items 051 * @param scope the scope of the operation to be performed 052 * @param userEntry the {@link org.apache.directory.api.ldap.model.entry.Entry} of the current user entry in the DIT 053 * @return the collection of filtered tuples 054 * @throws org.apache.directory.api.ldap.model.exception.LdapException if failed to filter the specific tuples 055 */ 056 Collection<ACITuple> filter( AciContext aciContext, OperationScope scope, Entry userEntry ) throws LdapException; 057}