001/* 002 * Copyright 2015-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2015-2020 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) 2015-2020 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.util.Extensible; 041import com.unboundid.util.ThreadSafety; 042import com.unboundid.util.ThreadSafetyLevel; 043 044 045 046/** 047 * This interface is used by the LDIFReader to translate change records read 048 * from the input or filter them out before they are returned via 049 * {@link LDIFReader#readChangeRecord}. 050 */ 051@Extensible() 052@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 053public interface LDIFReaderChangeRecordTranslator 054{ 055 /** 056 * Applies some special transformation or filtering to the original change 057 * record. 058 * 059 * @param original The original change record that was read and 060 * parsed from the input file. 061 * @param firstLineNumber The first line number of the LDIF change record. 062 * This is most useful when throwing an 063 * {@code LDIFException}. 064 * 065 * @return The LDIF change record that should be returned in the call to 066 * {@link LDIFReader#readChangeRecord}. This can be the original 067 * parameter change record, a newly constructed change record, or 068 * {@code null} to signal that the provided change record should be 069 * skipped. 070 * 071 * @throws LDIFException If there is an exception during processing. This 072 * exception will be re-thrown to the caller of 073 * readChangeRecord. 074 */ 075 LDIFChangeRecord translate(LDIFChangeRecord original, long firstLineNumber) 076 throws LDIFException; 077}