001/* 002 * Copyright 2008-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2008-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) 2008-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.ldap.sdk.Entry; 041import com.unboundid.util.Extensible; 042import com.unboundid.util.ThreadSafety; 043import com.unboundid.util.ThreadSafetyLevel; 044 045 046 047/** 048 * This interface is used by the LDIFWriter to translate or exclude entries 049 * before they are written. 050 */ 051@Extensible() 052@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 053public interface LDIFWriterEntryTranslator 054{ 055 /** 056 * Applies some special transformation or filtering to the original Entry. 057 * 058 * @param original The original Entry that was to be written. 059 * 060 * @return The Entry that should be written. This can be the original 061 * parameter Entry, a newly-constructed Entry, or {@code null} to 062 * signal that this Entry should not be written. Note, however, that 063 * if the original entry provided as a parameter is altered, then 064 * the change will be visible to anything that references that entry. 065 * If you are not sure about whether changes to the original entry 066 * are acceptable, it is recommended that you use the 067 * {@code duplicate()} method to create a copy of the original and 068 * make the necessary changes to that duplicate. 069 */ 070 Entry translateEntryToWrite(Entry original); 071}