Package com.unboundid.ldap.sdk.unboundidds.logs.v2.json

Class JSONAccessLogMessage

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONLogMessage
com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONAccessLogMessage
All Implemented Interfaces:
AccessLogMessage, LogMessage, Serializable
Direct Known Subclasses:
JSONClientCertificateAccessLogMessage, JSONConnectAccessLogMessage, JSONDisconnectAccessLogMessage, JSONEntryRebalancingRequestAccessLogMessage, JSONRequestAccessLogMessage, JSONSecurityNegotiationAccessLogMessage
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class JSONAccessLogMessage extends JSONLogMessage implements AccessLogMessage
This class provides a data structure that holds information about a JSON-formatted access log message.
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.
See Also:

  • Constructor Details

    • JSONAccessLogMessage

      protected JSONAccessLogMessage(@NotNull JSONObject jsonObject) throws LogException
      Creates a new JSON access log message from the provided JSON object.
      Parameters:
      jsonObject - The JSON object that contains an encoded representation of this log message. It must not be null.
      Throws:
      LogException - If the provided JSON object cannot be parsed as a valid log message.

  • Method Details

    • getProductName

      @Nullable public final String getProductName()
      Retrieves the server product name for this access log message.
      Specified by:
      getProductName in interface AccessLogMessage
      Returns:
      The server product name for this access log message, or null if it is not included in the log message.

    • getInstanceName

      @Nullable public final String getInstanceName()
      Retrieves the Directory Server instance name for this access log message.
      Specified by:
      getInstanceName in interface AccessLogMessage
      Returns:
      The Directory Server instance name for this access log message, or null if it is not included in the log message.

    • getStartupID

      @Nullable public final String getStartupID()
      Retrieves the Directory Server startup ID for this access log message.
      Specified by:
      getStartupID in interface AccessLogMessage
      Returns:
      The Directory Server startup ID for this access log message, or null if it is not included in the log message.

    • getThreadID

      @Nullable public final Long getThreadID()
      Retrieves the thread ID for the server thread that generated this access log message.
      Specified by:
      getThreadID in interface AccessLogMessage
      Returns:
      The Directory Server thread ID for this access log message, or null if it is not included in the log message.

    • getConnectionID

      @Nullable public final Long getConnectionID()
      Retrieves the connection ID for the connection with which this access log message is associated.
      Specified by:
      getConnectionID in interface AccessLogMessage
      Returns:
      The connection ID for the connection with which this access log message is associated, or null if it is not included in the log message.