org.opends.server.types.operation
Interface SubordinateModifyDNOperation

All Superinterfaces:

InProgressOperation, PluginOperation

All Known Subinterfaces:

ModifyDNOperation

All Known Implementing Classes:

LocalBackendModifyDNOperation, ModifyDNOperationBasis, ModifyDNOperationWrapper

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public interface SubordinateModifyDNOperation
extends InProgressOperation

This class defines a set of methods that are available for use by subordinate modify DN operation plugins. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.

Method Summary

boolean	deleteOldRDN() Indicates whether the current RDN value should be removed from the entry.
DN	getEntryDN() Retrieves the DN of the entry to rename.
RDN	getNewRDN() Retrieves the new RDN to use for the entry.
DN	getNewSuperior() Retrieves the newSuperior DN for the entry.
Entry	getOriginalEntry() Retrieves the current entry, before it is renamed.
ByteString	getRawEntryDN() Retrieves the raw, unprocessed entry DN as included in the client request.
ByteString	getRawNewRDN() Retrieves the raw, unprocessed newRDN as included in the request from the client.
ByteString	getRawNewSuperior() Retrieves the raw, unprocessed newSuperior from the client request.
Entry	getUpdatedEntry() Retrieves the new entry, as it will appear after it is renamed.

Methods inherited from interface org.opends.server.types.operation.InProgressOperation

addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getAuthorizationDN, getErrorMessage, getMatchedDN, getReferralURLs, getResultCode, removeResponseControl, setAdditionalLogMessage, setErrorMessage, setMatchedDN, setReferralURLs, setResponseData, setResultCode

Methods inherited from interface org.opends.server.types.operation.PluginOperation

checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString

Method Detail

getRawEntryDN

ByteString getRawEntryDN()

Retrieves the raw, unprocessed entry DN as included in the client request. The DN that is returned may or may not be a valid DN, since no validation will have been performed upon it.

Returns:

The raw, unprocessed entry DN as included in the client request.

getEntryDN

DN getEntryDN()

Retrieves the DN of the entry to rename. This should not be called by pre-parse plugins because the processed DN will not be available yet. Instead, they should call the getRawEntryDN method.

Returns:

The DN of the entry to rename, or null if the raw entry DN has not yet been processed.

getRawNewRDN

ByteString getRawNewRDN()

Retrieves the raw, unprocessed newRDN as included in the request from the client. This may or may not contain a valid RDN, as no validation will have been performed on it.

Returns:

The raw, unprocessed newRDN as included in the request from the client.

getNewRDN

RDN getNewRDN()

Retrieves the new RDN to use for the entry. This should not be called by pre-parse plugins, because the processed newRDN will not yet be available. Pre-parse plugins should instead use the getRawNewRDN method.

Returns:

The new RDN to use for the entry, or null if the raw newRDN has not yet been processed.

deleteOldRDN

boolean deleteOldRDN()

Indicates whether the current RDN value should be removed from the entry.

Returns:

true if the current RDN value should be removed from the entry, or false if not.

getRawNewSuperior

ByteString getRawNewSuperior()

Retrieves the raw, unprocessed newSuperior from the client request. This may or may not contain a valid DN, as no validation will have been performed on it.

Returns:

The raw, unprocessed newSuperior from the client request, or null if there is none.

getNewSuperior

DN getNewSuperior()

Retrieves the newSuperior DN for the entry. This should not be called by pre-parse plugins, because the processed DN will not yet be available at that time. Instead, they should use the getRawNewSuperior method.

Returns:

The newSuperior DN for the entry, or null if there is no newSuperior DN for this request or if the raw newSuperior has not yet been processed.

getOriginalEntry

Entry getOriginalEntry()

Retrieves the current entry, before it is renamed. This will not be available to pre-parse plugins or during the conflict resolution portion of the synchronization processing.

Returns:

The current entry, or null if it is not yet available.

getUpdatedEntry

Entry getUpdatedEntry()

Retrieves the new entry, as it will appear after it is renamed. This will not be available to pre-parse plugins or during the conflict resolution portion of the synchronization processing.

Returns:

The updated entry, or null if it is not yet available.