@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ModifyDNRequestProtocolOp extends java.lang.Object implements ProtocolOp
Modifier and Type | Field and Description |
---|---|
static byte |
TYPE_NEW_SUPERIOR
The BER type for the newSuperior element.
|
Constructor and Description |
---|
ModifyDNRequestProtocolOp(ModifyDNRequest request)
Creates a new modify DN request protocol op from the provided modify DN
request object.
|
ModifyDNRequestProtocolOp(java.lang.String dn,
java.lang.String newRDN,
boolean deleteOldRDN,
java.lang.String newSuperiorDN)
Creates a new modify DN request protocol op with the provided information.
|
Modifier and Type | Method and Description |
---|---|
static ModifyDNRequestProtocolOp |
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a modify DN request protocol op.
|
boolean |
deleteOldRDN()
Indicates whether to delete the old RDN values from the target entry.
|
ASN1Element |
encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an
encoded LDAP message.
|
java.lang.String |
getDN()
Retrieves the target entry DN for this modify DN request.
|
java.lang.String |
getNewRDN()
Retrieves the new RDN for this modify DN request.
|
java.lang.String |
getNewSuperiorDN()
Retrieves the new superior DN for this modify DN request, if any.
|
byte |
getProtocolOpType()
Retrieves the BER type for this protocol op.
|
ModifyDNRequest |
toModifyDNRequest(Control... controls)
Creates a modify DN request from this protocol op.
|
java.lang.String |
toString()
Retrieves a string representation of this protocol op.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided
buffer.
|
void |
writeTo(ASN1Buffer buffer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the
provided ASN.1 buffer.
|
public static final byte TYPE_NEW_SUPERIOR
public ModifyDNRequestProtocolOp(java.lang.String dn, java.lang.String newRDN, boolean deleteOldRDN, java.lang.String newSuperiorDN)
dn
- The entry DN for this modify DN request.newRDN
- The new RDN for this modify DN request.deleteOldRDN
- Indicates whether to delete the old RDN values.newSuperiorDN
- The new superior DN for this modify DN request, or
null
if there is none.public ModifyDNRequestProtocolOp(ModifyDNRequest request)
request
- The modify DN request object to use to create this
protocol op.public java.lang.String getDN()
public java.lang.String getNewRDN()
public boolean deleteOldRDN()
true
if the old RDN values should be removed from the
entry, or false
if not.public java.lang.String getNewSuperiorDN()
null
if
there is none.public byte getProtocolOpType()
getProtocolOpType
in interface ProtocolOp
public ASN1Element encodeProtocolOp()
encodeProtocolOp
in interface ProtocolOp
public static ModifyDNRequestProtocolOp decodeProtocolOp(ASN1Element element) throws LDAPException
element
- The ASN.1 element to be decoded.LDAPException
- If the provided ASN.1 element cannot be decoded as
a modify DN request protocol op.public void writeTo(ASN1Buffer buffer)
writeTo
in interface ProtocolOp
buffer
- The ASN.1 buffer to which the encoded representation should
be written.public ModifyDNRequest toModifyDNRequest(Control... controls)
controls
- The set of controls to include in the modify DN request.
It may be empty or null
if no controls should be
included.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
buffer
- The buffer to which the string representation should be
appended.