|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.protocols.ldap.ProtocolOp
org.opends.server.protocols.ldap.ModifyDNRequestProtocolOp
public class ModifyDNRequestProtocolOp
This class defines the structures and methods for an LDAP modify DN request protocol op, which is used to move or rename an entry or subtree within the Directory Server.
Constructor Summary | |
---|---|
ModifyDNRequestProtocolOp(ASN1OctetString entryDN,
ASN1OctetString newRDN,
boolean deleteOldRDN)
Creates a new modify DN request protocol op with the provided information. |
|
ModifyDNRequestProtocolOp(ASN1OctetString entryDN,
ASN1OctetString newRDN,
boolean deleteOldRDN,
ASN1OctetString newSuperior)
Creates a new modify DN request protocol op with the provided information. |
Method Summary | |
---|---|
static ModifyDNRequestProtocolOp |
decodeModifyDNRequest(ASN1Element element)
Decodes the provided ASN.1 element as a modify DN request protocol op. |
boolean |
deleteOldRDN()
Indicates whether the current RDN value(s) should be deleted. |
ASN1Element |
encode()
Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message. |
ASN1OctetString |
getEntryDN()
Retrieves the current entry DN for this modify DN request. |
ASN1OctetString |
getNewRDN()
Retrieves the new RDN for this modify DN request. |
ASN1OctetString |
getNewSuperior()
Retrieves the new superior DN for this modify DN request. |
java.lang.String |
getProtocolOpName()
Retrieves the name for this protocol op type. |
byte |
getType()
Retrieves the BER type for this protocol op. |
void |
setDeleteOldRDN(boolean deleteOldRDN)
Specifies whether the current RDN value(s) should be deleted. |
void |
setEntryDN(ASN1OctetString entryDN)
Specifies the current entry DN for this modify DN request. |
void |
setNewRDN(ASN1OctetString newRDN)
Specifies the new RDN for this modify DN request. |
void |
setNewSuperior(ASN1OctetString newSuperior)
Specifies the new superior DN for this modify DN request. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer. |
void |
toString(java.lang.StringBuilder buffer,
int indent)
Appends a multi-line string representation of this LDAP protocol op to the provided buffer. |
Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp |
---|
decode, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ModifyDNRequestProtocolOp(ASN1OctetString entryDN, ASN1OctetString newRDN, boolean deleteOldRDN)
entryDN
- The current entry DN for this modify DN request.newRDN
- The new RDN for this modify DN request.deleteOldRDN
- Indicates whether to delete the current RDN value(s).public ModifyDNRequestProtocolOp(ASN1OctetString entryDN, ASN1OctetString newRDN, boolean deleteOldRDN, ASN1OctetString newSuperior)
entryDN
- The current entry DN for this modify DN request.newRDN
- The new RDN for this modify DN request.deleteOldRDN
- Indicates whether to delete the current RDN value(s).newSuperior
- The new superior DN for this modify DN request.Method Detail |
---|
public ASN1OctetString getEntryDN()
public void setEntryDN(ASN1OctetString entryDN)
entryDN
- The current entry DN for this modify DN request.public ASN1OctetString getNewRDN()
public void setNewRDN(ASN1OctetString newRDN)
newRDN
- The new RDN for this modify DN request.public boolean deleteOldRDN()
true
if the current RDN value(s) should be deleted,
or false
if not.public void setDeleteOldRDN(boolean deleteOldRDN)
deleteOldRDN
- Specifies whether the current RDN value(s) should be
deleted.public ASN1OctetString getNewSuperior()
null
if none was provided.public void setNewSuperior(ASN1OctetString newSuperior)
newSuperior
- The new superior DN for this modify DN request.public byte getType()
getType
in class ProtocolOp
public java.lang.String getProtocolOpName()
getProtocolOpName
in class ProtocolOp
public ASN1Element encode()
encode
in class ProtocolOp
public static ModifyDNRequestProtocolOp decodeModifyDNRequest(ASN1Element element) throws LDAPException
element
- The ASN.1 element to decode.
LDAPException
- If a problem occurs while trying to decode the
provided ASN.1 element as an LDAP modify DN request
protocol op.public void toString(java.lang.StringBuilder buffer)
toString
in class ProtocolOp
buffer
- The buffer to which the string should be appended.public void toString(java.lang.StringBuilder buffer, int indent)
toString
in class ProtocolOp
buffer
- The buffer to which the information should be appended.indent
- The number of spaces from the margin that the lines should
be indented.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |