Package com.unboundid.ldap.sdk.unboundidds.tools

Class JSONLDAPResultWriter

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tools.LDAPResultWriter
com.unboundid.ldap.sdk.unboundidds.tools.JSONLDAPResultWriter
@ThreadSafety(level=NOT_THREADSAFE) public final class JSONLDAPResultWriter extends LDAPResultWriter
This class provides an LDAPResultWriter instance that formats results in JSON.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

  • Constructor Details

    • JSONLDAPResultWriter

      public JSONLDAPResultWriter(@NotNull OutputStream outputStream)
      Creates a new instance of this LDAP result writer.
      Parameters:
      outputStream - The output stream to which output will be written.

  • Method Details

    • writeComment

      public void writeComment(@NotNull String comment)
      Writes the provided comment to the output.
      Specified by:
      writeComment in class LDAPResultWriter
      Parameters:
      comment - The comment to be written. It must not be null.

    • writeHeader

      public void writeHeader()
      Formats and writes a header that describes the way in which the data will be formatted. This will be displayed at the beginning of the output (including at the beginning of each file, if output should be spread across multiple files).
      Specified by:
      writeHeader in class LDAPResultWriter

    • writeSearchResultEntry

      public void writeSearchResultEntry(@NotNull SearchResultEntry entry)
      Formats and writes the provided search result entry.
      Specified by:
      writeSearchResultEntry in class LDAPResultWriter
      Parameters:
      entry - The search result entry to be processed.

    • toJSON

      @NotNull public static JSONObject toJSON(@NotNull Entry entry)
      Encodes the provided entry as a JSON object.
      Parameters:
      entry - The entry to be encoded as a JSON object. It must not be null.
      Returns:
      The JSON object containing the encoded representation of the entry.

    • toJSON

      public static void toJSON(@NotNull Entry entry, @NotNull JSONBuffer jsonBuffer)
      Appends a JSON object representation of the provided entry to the given buffer.
      Parameters:
      entry - The entry to be encoded as a JSON object. It must not be null.
      jsonBuffer - The JSON buffer to which the encoded representation of the entry is to be appended. It must not be null.

    • writeSearchResultReference

      public void writeSearchResultReference(@NotNull SearchResultReference ref)
      Formats and writes the provided search result reference.
      Specified by:
      writeSearchResultReference in class LDAPResultWriter
      Parameters:
      ref - The search result reference to be processed.

    • toJSON

      @NotNull public static JSONObject toJSON(@NotNull SearchResultReference ref)
      Encodes the provided search result reference as a JSON object.
      Parameters:
      ref - The search result reference to be encoded as a JSON object. It must not be null.
      Returns:
      The JSON object containing the encoded representation of the search result reference.

    • toJSON

      public static void toJSON(@NotNull SearchResultReference ref, @NotNull JSONBuffer jsonBuffer)
      Appends a JSON object representation of the provided search result reference to the given buffer.
      Parameters:
      ref - The search result reference to be encoded as a JSON object. It must not be null.
      jsonBuffer - The JSON buffer to which the encoded representation of the reference is to be appended. It must not be null.

    • writeResult

      public void writeResult(@NotNull LDAPResult result)
      Formats and writes the provided LDAP result.
      Specified by:
      writeResult in class LDAPResultWriter
      Parameters:
      result - The LDAP result to be processed. It may or may not be a search result.

    • toJSON

      @NotNull public static JSONObject toJSON(@NotNull LDAPResult result)
      Encodes the provided LDAP result as a JSON object.
      Parameters:
      result - The LDAP result to be encoded as a JSON object. It must not be null.
      Returns:
      The JSON object containing the encoded representation of the LDAP result.

    • toJSON

      public static void toJSON(@NotNull LDAPResult result, @NotNull JSONBuffer jsonBuffer)
      Appends a JSON object representation of the provided entry to the given buffer.
      Parameters:
      result - The LDAP result to be encoded as a JSON object. It must not be null.
      jsonBuffer - The JSON buffer to which the encoded representation of the LDAP result is to be appended. It must not be null.

    • writeUnsolicitedNotification

      public void writeUnsolicitedNotification(@NotNull LDAPConnection connection, @NotNull ExtendedResult notification)
      Formats and writes the provided unsolicited notification.
      Specified by:
      writeUnsolicitedNotification in class LDAPResultWriter
      Parameters:
      connection - The connection on which the unsolicited notification was received.
      notification - The unsolicited notification that was received.