001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.backends.jeb;
028    
029    import org.opends.server.types.Entry;
030    import org.opends.server.types.DirectoryException;
031    import com.sleepycat.je.DatabaseException;
032    
033    import java.io.IOException;
034    
035    /**
036     * The interface that represents a index builder for the import process.
037     */
038    public interface IndexBuilder
039    {
040      /**
041       * This method must be called before this object can process any
042       * entries. It cleans up any temporary files left over from a
043       * previous import.
044       */
045      void startProcessing();
046    
047      /**
048       * Indicates that the index thread should process the provided entry.
049       * @param oldEntry The existing contents of the entry, or null if this is
050       * a new entry.
051       * @param newEntry The new contents of the entry.
052       * @param entryID The entry ID.
053       * @throws com.sleepycat.je.DatabaseException If an error occurs in the JE
054       * database.
055       * @throws java.io.IOException If an I/O error occurs while writing an
056       * intermediate file.
057       * @throws DirectoryException If an error occurs while processing the entry.
058       */
059      void processEntry(Entry oldEntry, Entry newEntry, EntryID entryID)
060          throws DatabaseException, IOException, DirectoryException;
061    
062      /**
063       * Indicates that there will be no more updates.
064       * @throws IOException If an I/O error occurs while writing an intermediate
065       * file.
066       */
067      void stopProcessing() throws IOException;
068    }