Package org.opends.server.protocols.ldap

Class ModifyRequestProtocolOp

  • public class ModifyRequestProtocolOp
extends ProtocolOp
    This class defines the structures and methods for an LDAP modify request protocol op, which is used to alter the contents of an entry in the Directory Server.

    • Constructor Detail

      • ModifyRequestProtocolOp

        public ModifyRequestProtocolOp​(ByteString dn)
        Creates a new LDAP modify request protocol op with the specified DN and no modifications.
        Parameters:
        dn - The DN for this modify request.

      • ModifyRequestProtocolOp

        public ModifyRequestProtocolOp​(ByteString dn,
                               List<RawModification> modifications)
        Creates a new LDAP modify request protocol op with the specified DN and set of modifications.
        Parameters:
        dn - The DN for this modify request.
        modifications - The set of modifications for this modify request.

    • Method Detail

      • getDN

        public ByteString getDN()
        Retrieves the DN for this modify request.
        Returns:
        The DN for this modify request.

      • getModifications

        public List<RawModification> getModifications()
        Retrieves the set of modifications for this modify request. The returned list may be altered by the caller.
        Returns:
        The set of modifications for this modify request.

      • getType

        public byte getType()
        Retrieves the BER type for this protocol op.
        Specified by:
        getType in class ProtocolOp
        Returns:
        The BER type for this protocol op.

      • getProtocolOpName

        public String getProtocolOpName()
        Retrieves the name for this protocol op type.
        Specified by:
        getProtocolOpName in class ProtocolOp
        Returns:
        The name for this protocol op type.

      • write

        public void write​(ASN1Writer stream)
           throws IOException
        Writes this protocol op to an ASN.1 output stream.
        Specified by:
        write in class ProtocolOp
        Parameters:
        stream - The ASN.1 output stream to write to.
        Throws:
        IOException - If a problem occurs while writing to the stream.

      • toString

        public void toString​(StringBuilder buffer)
        Appends a string representation of this LDAP protocol op to the provided buffer.
        Specified by:
        toString in class ProtocolOp
        Parameters:
        buffer - The buffer to which the string should be appended.

      • toString

        public void toString​(StringBuilder buffer,
                     int indent)
        Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
        Specified by:
        toString in class ProtocolOp
        Parameters:
        buffer - The buffer to which the information should be appended.
        indent - The number of spaces from the margin that the lines should be indented.