Class SearchResultEntryProtocolOp

    • Constructor Detail

      • SearchResultEntryProtocolOp

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

        public SearchResultEntryProtocolOp​(Entry entry)
        Creates a new search result entry protocol op from the provided entry.
        Parameters:
        entry - The entry to use to create this protocol op.
    • Method Detail

      • getDN

        public java.lang.String getDN()
        Retrieves the DN for this search result entry.
        Returns:
        The DN for this search result entry.
      • getAttributes

        public java.util.List<AttributegetAttributes()
        Retrieves the list of attributes for this search result entry.
        Returns:
        The list of attributes for this search result entry.
      • 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 SearchResultEntryProtocolOp decodeProtocolOp​(ASN1Element element)
                                                            throws LDAPException
        Decodes the provided ASN.1 element as a search result entry protocol op.
        Parameters:
        element - The ASN.1 element to be decoded.
        Returns:
        The decoded search result entry protocol op.
        Throws:
        LDAPException - If the provided ASN.1 element cannot be decoded as a search result entry 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.
      • toSearchResultEntry

        public SearchResultEntry toSearchResultEntry​(Control... controls)
        Creates a search result entry from this protocol op.
        Parameters:
        controls - The set of controls to include in the search result entry. It may be empty or null if no controls should be included.
        Returns:
        The search result entry 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.