com.unboundid.ldap.sdk.transformations
Interface EntryTransformation

All Superinterfaces:
LDIFReaderEntryTranslator, LDIFWriterEntryTranslator
All Known Implementing Classes:
AddAttributeTransformation, ExcludeAttributeTransformation, ExcludeEntryTransformation, FlattenSubtreeTransformation, MoveSubtreeTransformation, RedactAttributeTransformation, RenameAttributeTransformation, ReplaceAttributeTransformation, ReplaceWithCounterTransformation, ScrambleAttributeTransformation

@Extensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface EntryTransformation
extends LDIFReaderEntryTranslator, LDIFWriterEntryTranslator

This class defines an API that may be used to apply some kind of transformation to an entry to alter its contents or suppress it from further processing.


Method Summary
 Entry transformEntry(Entry entry)
          Applies an appropriate transformation to the provided entry.
 
Methods inherited from interface com.unboundid.ldif.LDIFReaderEntryTranslator
translate
 
Methods inherited from interface com.unboundid.ldif.LDIFWriterEntryTranslator
translateEntryToWrite
 

Method Detail

transformEntry

Entry transformEntry(Entry entry)
Applies an appropriate transformation to the provided entry.

Parameters:
entry - The entry to transform.
Returns:
A copy of the entry with any appropriate transformation applied, the original entry if no transformations were necessary, or null if the entry should be suppressed.