org.apache.directory.shared.ldap.extras.controls
Interface SyncModifyDn

All Superinterfaces:

Control

All Known Implementing Classes:

SyncModifyDnImpl

public interface SyncModifyDn
extends Control

A SyncModifyDnControl object, to send the parameters used in a MODIFYDN operation that was carried out on a syncrepl provider server. The consumer will use the values present in this control to perform the same operation on its local data, which helps in avoiding huge number of updates to the consumer. NOTE: syncrepl, defined in RFC 4533, doesn't mention about this approach, this is a special extension provided by Apache Directory Server

Author:

Apache Directory Project

Field Summary

static String

OID This control OID

Method Summary

String	getEntryDn()
SyncModifyDnType	getModDnType()
String	getNewRdn()
String	getNewSuperiorDn()
boolean	isDeleteOldRdn()
void	setDeleteOldRdn(boolean deleteOldRdn)
void	setEntryDn(String entryDn)
void	setModDnType(SyncModifyDnType modDnType)
void	setNewRdn(String newRdn)
void	setNewSuperiorDn(String newSuperiorDn)

Methods inherited from interface org.apache.directory.shared.ldap.model.message.Control

getOid, isCritical, setCritical

Field Detail

OID

static final String OID

This control OID

See Also:

Constant Field Values

Method Detail

getEntryDn

String getEntryDn()

Returns:

the current entry DN

setEntryDn

void setEntryDn(String entryDn)

Parameters:

entryDn - The Entry DN

getNewSuperiorDn

String getNewSuperiorDn()

Returns:

The new superior DN if it's a Move or a Move@Rename operation

setNewSuperiorDn

void setNewSuperiorDn(String newSuperiorDn)

Parameters:

newSuperiorDn - Sets the new Superior DN

getNewRdn

String getNewRdn()

Returns:

The new name if it's a Rename or Move&Rename opertion

setNewRdn

void setNewRdn(String newRdn)

Parameters:

newRdn - Sets the new name

isDeleteOldRdn

boolean isDeleteOldRdn()

Returns:

true if the attribute associated with the old name is to be removed (rename operation)

setDeleteOldRdn

void setDeleteOldRdn(boolean deleteOldRdn)

Parameters:

deleteOldRdn - The flag to tell the server to remove the attribute assoicated with the old name

getModDnType

SyncModifyDnType getModDnType()

Returns:

The MODDN operation type

setModDnType

void setModDnType(SyncModifyDnType modDnType)

Parameters:

modDnType - The MODDN operation type