1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.server.protocol.shared.store;
21
22
23 import javax.naming.NamingException;
24
25 import org.apache.directory.server.core.CoreSession;
26 import org.apache.directory.shared.ldap.entry.Entry;
27 import org.apache.directory.shared.ldap.name.LdapDN;
28
29 import java.io.File;
30
31
32 /**
33 * A filter interface for the LDIF loader.
34 *
35 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
36 * @version $Rev: 686082 $, $Date: 2008-08-15 01:12:09 +0200 (Fr, 15 Aug 2008) $
37 */
38 public interface LdifLoadFilter
39 {
40 /**
41 * Filters entries loaded from LDIF files by a LdifFileLoader.
42 *
43 * @param file the file being loaded
44 * @param dn the distinguished name of the entry being loaded
45 * @param entry the entry attributes within the LDIF file
46 * @param coreSession session to be used for loading the entry into the DIT
47 * @return true if the entry will be created in the DIT, false if it is to be skipped
48 * @throws NamingException
49 */
50 boolean filter( File file, LdapDN dn, Entry entry, CoreSession coreSession ) throws NamingException;
51 }