Package com.unboundid.ldap.protocol
Class ModifyRequestProtocolOp
- java.lang.Object
-
- com.unboundid.ldap.protocol.ModifyRequestProtocolOp
-
- All Implemented Interfaces:
ProtocolOp
,java.io.Serializable
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ModifyRequestProtocolOp extends java.lang.Object implements ProtocolOp
This class provides an implementation of an LDAP modify request protocol op.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ModifyRequestProtocolOp(ModifyRequest request)
Creates a new modify request protocol op from the provided modify request object.ModifyRequestProtocolOp(java.lang.String dn, java.util.List<Modification> modifications)
Creates a new modify request protocol op with the provided information.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModifyRequestProtocolOp
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a modify request protocol op.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 request.java.util.List<Modification>
getModifications()
Retrieves the list of modifications for this modify request.byte
getProtocolOpType()
Retrieves the BER type for this protocol op.ModifyRequest
toModifyRequest(Control... controls)
Creates a modify 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 writer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.
-
-
-
Constructor Detail
-
ModifyRequestProtocolOp
public ModifyRequestProtocolOp(@NotNull java.lang.String dn, @NotNull java.util.List<Modification> modifications)
Creates a new modify request protocol op with the provided information.- Parameters:
dn
- The entry DN for this modify request.modifications
- The list of modifications to include in this modify request.
-
ModifyRequestProtocolOp
public ModifyRequestProtocolOp(@NotNull ModifyRequest request)
Creates a new modify request protocol op from the provided modify request object.- Parameters:
request
- The modify request object to use to create this protocol op.
-
-
Method Detail
-
getDN
@NotNull public java.lang.String getDN()
Retrieves the target entry DN for this modify request.- Returns:
- The target entry DN for this modify request.
-
getModifications
@NotNull public java.util.List<Modification> getModifications()
Retrieves the list of modifications for this modify request.- Returns:
- The list of modifications for this modify request.
-
getProtocolOpType
public byte getProtocolOpType()
Retrieves the BER type for this protocol op.- Specified by:
getProtocolOpType
in interfaceProtocolOp
- Returns:
- The BER type for this protocol op.
-
encodeProtocolOp
@NotNull public ASN1Element encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.- Specified by:
encodeProtocolOp
in interfaceProtocolOp
- Returns:
- The ASN.1 element containing the encoded protocol op.
-
decodeProtocolOp
@NotNull public static ModifyRequestProtocolOp decodeProtocolOp(@NotNull ASN1Element element) throws LDAPException
Decodes the provided ASN.1 element as a modify request protocol op.- Parameters:
element
- The ASN.1 element to be decoded.- Returns:
- The decoded modify request protocol op.
- Throws:
LDAPException
- If the provided ASN.1 element cannot be decoded as a modify request protocol op.
-
writeTo
public void writeTo(@NotNull ASN1Buffer writer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.- Specified by:
writeTo
in interfaceProtocolOp
- Parameters:
writer
- The ASN.1 buffer to which the encoded representation should be written.
-
toModifyRequest
@NotNull public ModifyRequest toModifyRequest(@Nullable Control... controls)
Creates a modify request from this protocol op.- Parameters:
controls
- The set of controls to include in the modify request. It may be empty ornull
if no controls should be included.- Returns:
- The modify request that was created.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this protocol op.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this protocol op.
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Parameters:
buffer
- The buffer to which the string representation should be appended.
-
-