Class AddRequestProtocolOp

    • Constructor Summary

      Constructors 
      Constructor Description
      AddRequestProtocolOp​(AddRequest request)
      Creates a new add request protocol op from the provided add request object.
      AddRequestProtocolOp​(java.lang.String dn, java.util.List<Attribute> attributes)
      Creates a new add request protocol op with the provided information.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AddRequestProtocolOp decodeProtocolOp​(ASN1Element element)
      Decodes the provided ASN.1 element as an add request protocol op.
      ASN1Element encodeProtocolOp()
      Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
      java.util.List<Attribute> getAttributes()
      Retrieves the list of attributes for this add request.
      java.lang.String getDN()
      Retrieves the target entry DN for this add request.
      byte getProtocolOpType()
      Retrieves the BER type for this protocol op.
      AddRequest toAddRequest​(Control... controls)
      Creates an add 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 buffer)
      Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AddRequestProtocolOp

        public AddRequestProtocolOp​(java.lang.String dn,
                                    java.util.List<Attribute> attributes)
        Creates a new add request protocol op with the provided information.
        Parameters:
        dn - The entry DN for this add request.
        attributes - The list of attributes to include in this add request.
      • AddRequestProtocolOp

        public AddRequestProtocolOp​(AddRequest request)
        Creates a new add request protocol op from the provided add request object.
        Parameters:
        request - The add request object to use to create this protocol op.
    • Method Detail

      • getDN

        public java.lang.String getDN()
        Retrieves the target entry DN for this add request.
        Returns:
        The target entry DN for this add request.
      • getAttributes

        public java.util.List<AttributegetAttributes()
        Retrieves the list of attributes for this add request.
        Returns:
        The list of attributes for this add request.
      • encodeProtocolOp

        public ASN1Element encodeProtocolOp()
        Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
        Specified by:
        encodeProtocolOp in interface ProtocolOp
        Returns:
        The ASN.1 element containing the encoded protocol op.
      • decodeProtocolOp

        public static AddRequestProtocolOp decodeProtocolOp​(ASN1Element element)
                                                     throws LDAPException
        Decodes the provided ASN.1 element as an add request protocol op.
        Parameters:
        element - The ASN.1 element to be decoded.
        Returns:
        The decoded add request protocol op.
        Throws:
        LDAPException - If the provided ASN.1 element cannot be decoded as an add request protocol op.
      • writeTo

        public void writeTo​(ASN1Buffer buffer)
        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 interface ProtocolOp
        Parameters:
        buffer - The ASN.1 buffer to which the encoded representation should be written.
      • toAddRequest

        public AddRequest toAddRequest​(Control... controls)
        Creates an add request from this protocol op.
        Parameters:
        controls - The set of controls to include in the add request. It may be empty or null if no controls should be included.
        Returns:
        The add request that was created.
      • toString

        public java.lang.String toString()
        Retrieves a string representation of this protocol op.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this protocol op.
      • toString

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