Package org.opends.server.protocols.ldap

Class SearchResultReferenceProtocolOp

  • public class SearchResultReferenceProtocolOp
extends ProtocolOp
    This class defines the structures and methods for an LDAP search result reference protocol op, which is used to indicate to the client that an alternate location or server may hold more matching entries.

    • Constructor Detail

      • SearchResultReferenceProtocolOp

        public SearchResultReferenceProtocolOp​(List<String> referralURLs)
        Creates a new search result reference protocol op with the provided set of referral URLs.
        Parameters:
        referralURLs - The set of URLs for this search result reference.

      • SearchResultReferenceProtocolOp

        public SearchResultReferenceProtocolOp​(SearchResultReference searchReference)
        Creates a new search result reference protocol op from the provided search result reference object.
        Parameters:
        searchReference - The search result reference object to use to create this search result reference protocol op.

    • Method Detail

      • getReferralURLs

        public List<String> getReferralURLs()
        Retrieves the set of referral URLs for this search result reference protocol op. The returned list may be altered by the caller.
        Returns:
        The set of referral URLs for this search result reference protocol op.

      • 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.