001/* 002 * Copyright 2016-2017 UnboundID Corp. 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright (C) 2016-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.ldap.sdk.transformations; 022 023 024 025import com.unboundid.ldap.sdk.Entry; 026import com.unboundid.ldif.LDIFReaderEntryTranslator; 027import com.unboundid.ldif.LDIFWriterEntryTranslator; 028import com.unboundid.util.Extensible; 029import com.unboundid.util.ThreadSafety; 030import com.unboundid.util.ThreadSafetyLevel; 031 032 033 034/** 035 * This class defines an API that may be used to apply some kind of 036 * transformation to an entry to alter its contents or suppress it from further 037 * processing. 038 */ 039@Extensible() 040@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 041public interface EntryTransformation 042 extends LDIFReaderEntryTranslator, LDIFWriterEntryTranslator 043{ 044 /** 045 * Applies an appropriate transformation to the provided entry. 046 * 047 * @param entry The entry to transform. 048 * 049 * @return A copy of the entry with any appropriate transformation applied, 050 * the original entry if no transformations were necessary, or 051 * {@code null} if the entry should be suppressed. 052 */ 053 Entry transformEntry(final Entry entry); 054}