Package org.ldaptive
Class ModifyRequest
java.lang.Object
org.ldaptive.AbstractRequestMessage
org.ldaptive.ModifyRequest
- All Implemented Interfaces:
Request
LDAP modify request defined as:
ModifyRequest ::= [APPLICATION 6] SEQUENCE { object LDAPDN, changes SEQUENCE OF change SEQUENCE { operation ENUMERATED { add (0), delete (1), replace (2), ... }, modification PartialAttribute } } PartialAttribute ::= SEQUENCE { type AttributeDescription, vals SET OF value AttributeValue } Attribute ::= PartialAttribute(WITH COMPONENTS { ..., vals (SIZE(1..MAX))})
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.ldaptive.AbstractRequestMessage
AbstractRequestMessage.AbstractBuilder<B,
T extends AbstractRequestMessage> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final byte[]
Empty byte.private String
LDAP DN to modify.private AttributeModification[]
Modifications to perform.static final int
BER protocol number.Fields inherited from class org.ldaptive.AbstractRequestMessage
logger
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Default constructor.ModifyRequest
(String entry, AttributeModification... mod) Creates a new modify request. -
Method Summary
Modifier and TypeMethodDescriptionstatic ModifyRequest.Builder
builder()
Creates a builder for this class.private DEREncoder[]
getAttributeValueEncoders
(Collection<byte[]> values) Returns attribute value encoders for the supplied values.getDn()
Returns the DN.Returns the attribute modifications.protected DEREncoder[]
getRequestEncoders
(int id) Returns the request encoders for this message.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:
-
EMPTY_BYTE
private static final byte[] EMPTY_BYTEEmpty byte. -
ldapDn
LDAP DN to modify. -
modifications
Modifications to perform.
-
-
Constructor Details
-
ModifyRequest
private ModifyRequest()Default constructor. -
ModifyRequest
Creates a new modify request.- Parameters:
entry
- DN to modifymod
- to make on the object
-
-
Method Details
-
getDn
Returns the DN.- Returns:
- DN
-
getModifications
Returns the attribute modifications.- Returns:
- attributes modifications
-
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
-
getAttributeValueEncoders
Returns attribute value encoders for the supplied values.- Parameters:
values
- to create encoders for- Returns:
- attribute value encoders
-
toString
- Overrides:
toString
in classAbstractRequestMessage
-
builder
Creates a builder for this class.- Returns:
- new builder
-