Package org.ldaptive
Class ModifyDnRequest
java.lang.Object
org.ldaptive.AbstractRequestMessage
org.ldaptive.ModifyDnRequest
- All Implemented Interfaces:
Request
LDAP modify DN request defined as:
ModifyDNRequest ::= [APPLICATION 12] SEQUENCE { entry LDAPDN, newrdn RelativeLDAPDN, deleteoldrdn BOOLEAN, newSuperior [0] LDAPDN OPTIONAL }
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.ldaptive.AbstractRequestMessage
AbstractRequestMessage.AbstractBuilder<B,
T extends AbstractRequestMessage> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Whether to delete the old RDN attribute.private String
New DN.private String
New superior DN.private String
DN to modify.static final int
BER protocol number.Fields inherited from class org.ldaptive.AbstractRequestMessage
logger
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Default constructor.ModifyDnRequest
(String oldDN, String newRDN, boolean delete) Creates a new modify DN request.ModifyDnRequest
(String oldDN, String newRDN, boolean delete, String newSuperior) Creates a new modify DN request. -
Method Summary
Modifier and TypeMethodDescriptionstatic ModifyDnRequest.Builder
builder()
Creates a builder for this class.Returns the new RDN.Returns the new superior DN.getOldDn()
Returns the old DN.protected DEREncoder[]
getRequestEncoders
(int id) Returns the request encoders for this message.boolean
Whether to delete the old RDN.toString()
Methods inherited from class org.ldaptive.AbstractRequestMessage
encode, getControls, setControls
-
Field Details
-
PROTOCOL_OP
public static final int PROTOCOL_OPBER protocol number.- See Also:
-
oldModifyDn
DN to modify. -
newModifyRDn
New DN. -
deleteOldRDn
private boolean deleteOldRDnWhether to delete the old RDN attribute. -
newSuperiorDn
New superior DN.
-
-
Constructor Details
-
ModifyDnRequest
private ModifyDnRequest()Default constructor. -
ModifyDnRequest
Creates a new modify DN request.- Parameters:
oldDN
- old modify DNnewRDN
- new modify DNdelete
- whether to delete the old RDN attribute
-
ModifyDnRequest
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 Details
-
getOldDn
Returns the old DN.- Returns:
- old DN
-
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
Returns the new superior DN.- Returns:
- new superior DN
-
getRequestEncoders
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
- Overrides:
toString
in classAbstractRequestMessage
-
builder
Creates a builder for this class.- Returns:
- new builder
-