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 */ 020 package org.apache.directory.server.protocol.shared.store; 021 022 023 import javax.naming.NamingException; 024 025 import org.apache.directory.server.core.CoreSession; 026 import org.apache.directory.shared.ldap.entry.Entry; 027 import org.apache.directory.shared.ldap.name.DN; 028 029 import java.io.File; 030 031 032 /** 033 * A filter interface for the LDIF loader. 034 * 035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 036 * @version $Rev: 918774 $, $Date: 2010-03-04 00:33:13 +0100 (Thu, 04 Mar 2010) $ 037 */ 038 public interface LdifLoadFilter 039 { 040 /** 041 * Filters entries loaded from LDIF files by a LdifFileLoader. 042 * 043 * @param file the file being loaded 044 * @param dn the distinguished name of the entry being loaded 045 * @param entry the entry attributes within the LDIF file 046 * @param coreSession session to be used for loading the entry into the DIT 047 * @return true if the entry will be created in the DIT, false if it is to be skipped 048 * @throws NamingException 049 */ 050 boolean filter( File file, DN dn, Entry entry, CoreSession coreSession ) throws NamingException; 051 }