Package org.ldaptive
Class ModifyDnRequest
- java.lang.Object
-
- org.ldaptive.AbstractRequestMessage
-
- org.ldaptive.ModifyDnRequest
-
- All Implemented Interfaces:
Request
public class ModifyDnRequest extends AbstractRequestMessage
LDAP modify DN request defined as:ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { entry LDAPDN, newrdn RelativeLDAPDN, deleteoldrdn BOOLEAN, newSuperior [0] LDAPDN OPTIONAL }
- Author:
- Middleware Services
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ModifyDnRequest.Builder
Modify DN request builder.-
Nested classes/interfaces inherited from class org.ldaptive.AbstractRequestMessage
AbstractRequestMessage.AbstractBuilder<B,T extends AbstractRequestMessage>
-
-
Field Summary
Fields Modifier and Type Field Description static int
PROTOCOL_OP
BER protocol number.-
Fields inherited from class org.ldaptive.AbstractRequestMessage
logger
-
-
Constructor Summary
Constructors Constructor Description ModifyDnRequest(java.lang.String oldDN, java.lang.String newRDN, boolean delete)
Creates a new modify DN request.ModifyDnRequest(java.lang.String oldDN, java.lang.String newRDN, boolean delete, java.lang.String newSuperior)
Creates a new modify DN request.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModifyDnRequest.Builder
builder()
Creates a builder for this class.java.lang.String
getNewRDn()
Returns the new RDN.java.lang.String
getNewSuperiorDn()
Returns the new superior DN.java.lang.String
getOldDn()
Returns the old DN.protected DEREncoder[]
getRequestEncoders(int id)
Returns the request encoders for this message.boolean
isDeleteOldRDn()
Whether to delete the old RDN.java.lang.String
toString()
-
Methods inherited from class org.ldaptive.AbstractRequestMessage
encode, getControls, setControls
-
-
-
-
Field Detail
-
PROTOCOL_OP
public static final int PROTOCOL_OP
BER protocol number.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ModifyDnRequest
public ModifyDnRequest(java.lang.String oldDN, java.lang.String newRDN, boolean delete)
Creates a new modify DN request.- Parameters:
oldDN
- old modify DNnewRDN
- new modify DNdelete
- whether to delete the old RDN attribute
-
ModifyDnRequest
public ModifyDnRequest(java.lang.String oldDN, java.lang.String newRDN, boolean delete, java.lang.String newSuperior)
Creates a new modify DN request.- Parameters:
oldDN
- old modify DNnewRDN
- new modify DNdelete
- whether to delete the old RDN attributenewSuperior
- new superior DN
-
-
Method Detail
-
getOldDn
public java.lang.String getOldDn()
Returns the old DN.- Returns:
- old DN
-
getNewRDn
public java.lang.String getNewRDn()
Returns the new RDN.- Returns:
- new RDN
-
isDeleteOldRDn
public boolean isDeleteOldRDn()
Whether to delete the old RDN.- Returns:
- whether to delete the old RDN
-
getNewSuperiorDn
public java.lang.String getNewSuperiorDn()
Returns the new superior DN.- Returns:
- new superior DN
-
getRequestEncoders
protected DEREncoder[] getRequestEncoders(int id)
Description copied from class:AbstractRequestMessage
Returns the request encoders for this message.- Specified by:
getRequestEncoders
in classAbstractRequestMessage
- Parameters:
id
- message ID- Returns:
- request encoders
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractRequestMessage
-
builder
public static ModifyDnRequest.Builder builder()
Creates a builder for this class.- Returns:
- new builder
-
-