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.protocol.shared.store;
021
022
023import java.io.File;
024
025import org.apache.directory.api.ldap.model.entry.Entry;
026import org.apache.directory.api.ldap.model.exception.LdapException;
027import org.apache.directory.api.ldap.model.name.Dn;
028import org.apache.directory.server.core.api.CoreSession;
029
030
031/**
032 * A filter interface for the LDIF loader.
033 *
034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035 */
036public interface LdifLoadFilter
037{
038    /**
039     * Filters entries loaded from LDIF files by a LdifFileLoader.
040     *
041     * @param file the file being loaded
042     * @param dn the distinguished name of the entry being loaded
043     * @param entry the entry attributes within the LDIF file
044     * @param coreSession session to be used for loading the entry into the DIT
045     * @return true if the entry will be created in the DIT, false if it is to be skipped
046     * @throws LdapException If the filtering failed
047     */
048    boolean filter( File file, Dn dn, Entry entry, CoreSession coreSession ) throws LdapException;
049}