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

Class ExtendedRequestAccessLogMessage

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
com.unboundid.ldap.sdk.unboundidds.logs.ExtendedRequestAccessLogMessage
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ExtendedForwardAccessLogMessage, ExtendedForwardFailedAccessLogMessage, ExtendedResultAccessLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class ExtendedRequestAccessLogMessage extends OperationRequestAccessLogMessage
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an extended request received from a client.
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

    • ExtendedRequestAccessLogMessage

      public ExtendedRequestAccessLogMessage(@NotNull String s) throws LogException
      Creates a new extended request access log message from the provided message string.
      Parameters:
      s - The string to be parsed as an extended request access log message.
      Throws:
      LogException - If the provided string cannot be parsed as a valid log message.

    • ExtendedRequestAccessLogMessage

      public ExtendedRequestAccessLogMessage(@NotNull LogMessage m)
      Creates a new extended request access log message from the provided log message.
      Parameters:
      m - The log message to be parsed as an extended request access log message.

  • Method Details

    • getRequestOID

      @Nullable public final String getRequestOID()
      Retrieves the OID of the extended request.
      Returns:
      The OID of the extended request, or null if it is not included in the log message.

    • getRequestType

      @Nullable public final String getRequestType()
      Retrieves the type of extended operation being processed. This is generally a human-readable name for the operation.
      Returns:
      The type of extended operation, or null if it is not included in the log message.

    • getOperationType

      @NotNull public final AccessLogOperationType getOperationType()
      Retrieves the operation type for the associated operation.
      Specified by:
      getOperationType in class OperationAccessLogMessage
      Returns:
      The operation type for this access log message.