|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.transformations.MoveSubtreeTransformation
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class MoveSubtreeTransformation
This class provides an implementation of an entry and LDIF change record transformation that will alter DNs at or below a specified base DN to replace that base DN with a different base DN. This replacement will be applied to the DNs of entries that are transformed, as well as in any attribute values that represent DNs at or below the specified base DN.
Constructor Summary | |
---|---|
MoveSubtreeTransformation(DN sourceDN,
DN targetDN)
Creates a new move subtree transformation with the provided information. |
Method Summary | |
---|---|
LDIFChangeRecord |
transformChangeRecord(LDIFChangeRecord r)
Applies an appropriate transformation to the provided LDIF change record. |
Entry |
transformEntry(Entry e)
Applies an appropriate transformation to the provided entry. |
Entry |
translate(Entry original,
long firstLineNumber)
Applies some special transformation or filtering to the original Entry. |
LDIFChangeRecord |
translate(LDIFChangeRecord original,
long firstLineNumber)
Applies some special transformation or filtering to the original change record. |
LDIFChangeRecord |
translateChangeRecordToWrite(LDIFChangeRecord original)
Applies some special transformation or filtering to the original change record. |
Entry |
translateEntryToWrite(Entry original)
Applies some special transformation or filtering to the original Entry. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MoveSubtreeTransformation(DN sourceDN, DN targetDN)
sourceDN
- The source base DN to be replaced with the target base
DN. It must not be null
.targetDN
- The target base DN to use to replace the source base DN.
It must not be null
.Method Detail |
---|
public Entry transformEntry(Entry e)
transformEntry
in interface EntryTransformation
e
- The entry to transform.
null
if the entry should be suppressed.public LDIFChangeRecord transformChangeRecord(LDIFChangeRecord r)
transformChangeRecord
in interface LDIFChangeRecordTransformation
r
- The LDIF change record to transform.
null
if the change record should be
suppressed.public Entry translate(Entry original, long firstLineNumber)
translate
in interface LDIFReaderEntryTranslator
original
- The original Entry that was read and parsed from
the input file.firstLineNumber
- The first line number of the LDIF record
corresponding to the read Entry. This is most
useful when throwing an LDIFException.
LDIFReader.readEntry()
. This can be the original parameter
Entry, a newly constructed Entry, or null
to signal that
the provided Entry should be skipped.public LDIFChangeRecord translate(LDIFChangeRecord original, long firstLineNumber)
translate
in interface LDIFReaderChangeRecordTranslator
original
- The original change record that was read and
parsed from the input file.firstLineNumber
- The first line number of the LDIF change record.
This is most useful when throwing an
LDIFException
.
LDIFReader.readChangeRecord()
. This can be the original
parameter change record, a newly constructed change record, or
null
to signal that the provided change record should be
skipped.public Entry translateEntryToWrite(Entry original)
translateEntryToWrite
in interface LDIFWriterEntryTranslator
original
- The original Entry that was to be written.
null
to
signal that this Entry should not be written. Note, however, that
if the original entry provided as a parameter is altered, then
the change will be visible to anything that references that entry.
If you are not sure about whether changes to the original entry
are acceptable, it is recommended that you use the
duplicate()
method to create a copy of the original and
make the necessary changes to that duplicate.public LDIFChangeRecord translateChangeRecordToWrite(LDIFChangeRecord original)
translateChangeRecordToWrite
in interface LDIFWriterChangeRecordTranslator
original
- The original change record that was to be written.
null
to signal that the change record should
not be written. Note, however, that if the original record
provided as a parameter is altered, then the change will be
visible to anything that references that change record. If you
are not sure about whether changes to the original change record
are acceptable, it is recommended that you use the
duplicate()
method to create a copy of the original and
make the necessary changes to that duplicate.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |