Package org.forgerock.opendj.io

Class LdapWriter

  • public final class LdapWriter
extends Object
    Writes LDAP messages to an underlying ASN.1 writer.

    Methods for creating LdapWriters are provided in the Ldap class.

    • Method Detail

      • getProtocolVersion

        public int getProtocolVersion()
        Returns the protocol version supported by this LdapWriter.
        Returns:
        The protocol version supported by this LdapWriter

      • writeLdapMessage

        public void writeLdapMessage​(LdapMessage ldapMessage)
        Writes the provided LDAP message.
        Parameters:
        ldapMessage - The message to write.

      • writeAbandonRequest

        public void writeAbandonRequest​(int messageID,
                                AbandonRequest request)
        Writes the provided abandon request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeAddRequest

        public void writeAddRequest​(int messageID,
                            AddRequest request)
        Writes the provided add request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeAddResult

        public void writeAddResult​(int messageID,
                           Result result)
        Writes the provided add result.
        Parameters:
        messageID - The LDAP message ID.
        result - The result.

      • writeBindRequest

        public void writeBindRequest​(int messageID,
                             BindRequest request)
        Writes the provided bind request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeBindResult

        public void writeBindResult​(int messageID,
                            Result result)
        Writes the provided bind result.
        Parameters:
        messageID - The LDAP message ID.
        result - The result.

      • writeCompareRequest

        public void writeCompareRequest​(int messageID,
                                CompareRequest request)
        Writes the provided compare request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeCompareResult

        public void writeCompareResult​(int messageID,
                               Result result)
        Writes the provided compare result.
        Parameters:
        messageID - The LDAP message ID.
        result - The result.

      • writeDeleteRequest

        public void writeDeleteRequest​(int messageID,
                               DeleteRequest request)
        Writes the provided delete request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeDeleteResult

        public void writeDeleteResult​(int messageID,
                              Result result)
        Writes the provided delete result.
        Parameters:
        messageID - The LDAP message ID.
        result - The result.

      • writeExtendedRequest

        public void writeExtendedRequest​(int messageID,
                                 ExtendedRequest<?> request)
        Writes the provided extended request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeExtendedResult

        public void writeExtendedResult​(int messageID,
                                Result result)
        Writes the provided extended result.
        Parameters:
        messageID - The LDAP message ID.
        result - The result.

      • writeIntermediateResponse

        public void writeIntermediateResponse​(int messageID,
                                      IntermediateResponse response)
        Writes the provided intermediate response.
        Parameters:
        messageID - The LDAP message ID.
        response - The response.

      • writeModifyDnRequest

        public void writeModifyDnRequest​(int messageID,
                                 ModifyDnRequest request)
        Writes the provided modify DN request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeModifyDnResult

        public void writeModifyDnResult​(int messageID,
                                Result result)
        Writes the provided modify DN result.
        Parameters:
        messageID - The LDAP message ID.
        result - The result.

      • writeModifyRequest

        public void writeModifyRequest​(int messageID,
                               ModifyRequest request)
        Writes the provided modify request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeModifyResult

        public void writeModifyResult​(int messageID,
                              Result result)
        Writes the provided extended result.
        Parameters:
        messageID - The LDAP message ID.
        result - The result.

      • writeSearchRequest

        public void writeSearchRequest​(int messageID,
                               SearchRequest request)
        Writes the provided search request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeSearchResult

        public void writeSearchResult​(int messageID,
                              Result result)
        Writes the provided search result.
        Parameters:
        messageID - The LDAP message ID.
        result - The result.

      • writeSearchResultEntry

        public void writeSearchResultEntry​(int messageID,
                                   SearchResultEntry entry)
        Writes the provided search result entry.
        Parameters:
        messageID - The LDAP message ID.
        entry - The entry.

      • writeSearchResultReference

        public void writeSearchResultReference​(int messageID,
                                       SearchResultReference reference)
        Writes the provided search result reference.
        Parameters:
        messageID - The LDAP message ID.
        reference - The reference.

      • writeUnbindRequest

        public void writeUnbindRequest​(int messageID,
                               UnbindRequest request)
        Writes the provided unbind request.
        Parameters:
        messageID - The LDAP message ID.
        request - The request.

      • writeUnknownRequest

        public void writeUnknownRequest​(int messageID,
                                UnknownRequest unknownRequest)
        Writes the provided unknown request.
        Parameters:
        messageID - The LDAP message ID.
        unknownRequest - The request.