com.unboundid.ldap.sdk.unboundidds
Interface MoveSubtreeListener

All Known Implementing Classes:
MoveSubtree

@Extensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface MoveSubtreeListener

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This interface defines an API that may be implemented by classes which wish to be notified of processing performed in the course of moving a subtree between servers.


Method Summary
 void doPostAddProcessing(ReadOnlyEntry entry)
          Performs any processing which may be needed after the provided entry has been added to the target server.
 void doPostDeleteProcessing(DN entryDN)
          Performs any processing which may be needed after the specified entry has been deleted from the source server.
 ReadOnlyEntry doPreAddProcessing(ReadOnlyEntry entry)
          Performs any processing which may be needed before the provided entry is added to the target server.
 void doPreDeleteProcessing(DN entryDN)
          Performs any processing which may be needed before the specified entry is deleted from the source server.
 

Method Detail

doPreAddProcessing

ReadOnlyEntry doPreAddProcessing(ReadOnlyEntry entry)
Performs any processing which may be needed before the provided entry is added to the target server.

Parameters:
entry - A read-only representation of the entry to be added to the target server.
Returns:
The original entry if the add should proceed without changes, a new entry (which must have the same DN as the provided entry) if the entry should be added with changes, or null if the entry should not be added to the target server (but will still be removed from the source server).

doPostAddProcessing

void doPostAddProcessing(ReadOnlyEntry entry)
Performs any processing which may be needed after the provided entry has been added to the target server.

Parameters:
entry - A read-only representation of the entry that was added to the target server. Note that depending on the algorithm used to perform the move, the entry may not yet be accessible in the target server. Also note that the add may potentially be reverted if move processing encounters an error later in its processing.

doPreDeleteProcessing

void doPreDeleteProcessing(DN entryDN)
Performs any processing which may be needed before the specified entry is deleted from the source server.

Parameters:
entryDN - The DN of the entry that is to be removed from the source server. Note that depending on the algorithm used to perform the move, the entry may already be inaccessible in the source server.

doPostDeleteProcessing

void doPostDeleteProcessing(DN entryDN)
Performs any processing which may be needed after the specified entry has been deleted from the source server.

Parameters:
entryDN - The DN of the entry that has been removed from the source server. Note that the delete may potentially be reverted if move processing encounters an error later in its processing.