001/*
002 * Copyright 2008-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2008-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2008-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldif;
037
038
039
040import com.unboundid.ldap.sdk.Entry;
041import com.unboundid.util.Extensible;
042import com.unboundid.util.NotNull;
043import com.unboundid.util.Nullable;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This interface is used by the LDIFReader to translate entries read from the
051 * input or filter them out before they are returned via
052 * {@link LDIFReader#readEntry}.
053 */
054@Extensible()
055@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
056public interface LDIFReaderEntryTranslator
057{
058  /**
059   * Applies some special transformation or filtering to the original Entry.
060   *
061   * @param  original         The original Entry that was read and parsed from
062   *                          the input file.
063   * @param  firstLineNumber  The first line number of the LDIF record
064   *                          corresponding to the read Entry.  This is most
065   *                          useful when throwing an LDIFException.
066   *
067   * @return  The Entry that should be returned in the call to
068   *          {@link LDIFReader#readEntry}. This can be the original parameter
069   *          Entry, a newly constructed Entry, or {@code null} to signal that
070   *          the provided Entry should be skipped.
071   *
072   * @throws  LDIFException  If there is an exception during processing.  This
073   *                         exception will be re-thrown to the caller of
074   *                         readEntry.
075   */
076  @Nullable()
077  Entry translate(@NotNull Entry original, long firstLineNumber)
078       throws LDIFException;
079}