001/*
002 * Copyright 2008-2017 UnboundID Corp.
003 * All Rights Reserved.
004 */
005/*
006 * Copyright (C) 2008-2017 UnboundID Corp.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU General Public License (GPLv2 only)
010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011 * as published by the Free Software Foundation.
012 *
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Public License for more details.
017 *
018 * You should have received a copy of the GNU General Public License
019 * along with this program; if not, see <http://www.gnu.org/licenses>.
020 */
021package com.unboundid.ldif;
022
023
024
025import com.unboundid.ldap.sdk.Entry;
026import com.unboundid.util.Extensible;
027import com.unboundid.util.ThreadSafety;
028import com.unboundid.util.ThreadSafetyLevel;
029
030
031
032/**
033 * This interface is used by the LDIFReader to translate entries read from the
034 * input or filter them out before they are returned via
035 * {@link LDIFReader#readEntry}.
036 */
037@Extensible()
038@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
039public interface LDIFReaderEntryTranslator
040{
041  /**
042   * Applies some special transformation or filtering to the original Entry.
043   *
044   * @param  original         The original Entry that was read and parsed from
045   *                          the input file.
046   * @param  firstLineNumber  The first line number of the LDIF record
047   *                          corresponding to the read Entry.  This is most
048   *                          useful when throwing an LDIFException.
049   *
050   * @return  The Entry that should be returned in the call to
051   *          {@link LDIFReader#readEntry}. This can be the original parameter
052   *          Entry, a newly constructed Entry, or {@code null} to signal that
053   *          the provided Entry should be skipped.
054   *
055   * @throws  LDIFException  If there is an exception during processing.  This
056   *                         exception will be re-thrown to the caller of
057   *                         readEntry.
058   */
059  Entry translate(Entry original, long firstLineNumber)
060       throws LDIFException;
061}