Package com.unboundid.ldap.sdk.experimental

Class DraftChuLDAPLogSchema00Entry

java.lang.Object
com.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.experimental.DraftChuLDAPLogSchema00Entry
All Implemented Interfaces:
LDIFRecord, Serializable
Direct Known Subclasses:
DraftChuLDAPLogSchema00AbandonEntry, DraftChuLDAPLogSchema00AddEntry, DraftChuLDAPLogSchema00BindEntry, DraftChuLDAPLogSchema00CompareEntry, DraftChuLDAPLogSchema00DeleteEntry, DraftChuLDAPLogSchema00ExtendedEntry, DraftChuLDAPLogSchema00ModifyDNEntry, DraftChuLDAPLogSchema00ModifyEntry, DraftChuLDAPLogSchema00SearchEntry, DraftChuLDAPLogSchema00UnbindEntry
@NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public abstract class DraftChuLDAPLogSchema00Entry extends ReadOnlyEntry
This class serves as the base class for entries that hold information about operations processed by an LDAP server, much like LDAP-accessible access log messages. The format for the entries used in this implementation is described in draft-chu-ldap-logschema-00.
See Also:

  • Field Details

  • Method Details

    • getOperationType

      @NotNull public final OperationType getOperationType()
      Retrieves the type of operation represented by this access log entry.
      Returns:
      The type of operation represented by this access log entry.

    • getTargetEntryDN

      @Nullable public final String getTargetEntryDN()
      Retrieves the DN of the entry targeted by by the operation represented by this access log entry, if available. Some types of operations, like abandon and extended operations, will not have a target entry DN. For a search operation, this will be the base DN for the search request. For a modify DN operation, this will be the DN of the entry before any processing was performed.
      Returns:
      The DN of the entry targeted by the operation represented by this access log entry, or null if no DN is available.

    • getProcessingStartTimeString

      @NotNull public final String getProcessingStartTimeString()
      Retrieves the string representation of the time that the server started processing the operation represented by this access log entry. Note that the string representation of this start time may have a different precision than the parsed start time returned by the getProcessingStartTimeDate() method.
      Returns:
      The string representation of the time that the server started processing the operation represented by this access log entry.

    • getProcessingStartTimeDate

      @NotNull public final Date getProcessingStartTimeDate()
      Retrieves a parsed representation of the time that the server started processing the operation represented by this access log entry. Note that this parsed representation may have a different precision than the start time string returned by the getProcessingStartTimeString() method.
      Returns:
      A parsed representation of the time that the server started processing the operation represented by this access log entry.

    • getProcessingEndTimeString

      @Nullable public final String getProcessingEndTimeString()
      Retrieves the string representation of the time that the server completed processing the operation represented by this access log entry, if available. Note that the string representation of this end time may have a different precision than the parsed end time returned by the getProcessingEndTimeDate() method.
      Returns:
      The string representation of the time that the server completed processing the operation represented by this access log entry, or null if no end time is available.

    • getProcessingEndTimeDate

      @Nullable public final Date getProcessingEndTimeDate()
      Retrieves a parsed representation of the time that the server completed processing the operation represented by this access log entry, if available. Note that this parsed representation may have a different precision than the end time string returned by the getProcessingEndTimeString() method.
      Returns:
      A parsed representation of the time that the server completed processing the operation represented by this access log entry.

    • getSessionID

      @NotNull public final String getSessionID()
      Retrieves the session identifier that the server assigned to the operation represented by this access log entry and can be used to correlate that operation with other operations requested on the same client connection. The server will assign a unique session identifier to each client connection, and all requests received on that connection will share the same session ID.
      Returns:
      The session identifier that the server assigned to the operation represented by this access log entry.

    • getRequestControls

      @NotNull public final List<Control> getRequestControls()
      Retrieves a list of the request controls for the operation represented by this access log entry, if any.
      Returns:
      A list of the request controls for the operation represented by this access log entry, or an empty list if there were no request controls included in the access log entry.

    • getResultCode

      @Nullable public final ResultCode getResultCode()
      Retrieves the result code for the operation represented by this access log entry, if any.
      Returns:
      The result code for the operation represented by this access log entry, or null if no result code was included in the access log entry.

    • getDiagnosticMessage

      @Nullable public final String getDiagnosticMessage()
      Retrieves the diagnostic message for the operation represented by this access log entry, if any.
      Returns:
      The diagnostic message for the operation represented by this access log entry, or null if no result code was included in the access log entry.

    • getReferralURLs

      @NotNull public final List<String> getReferralURLs()
      Retrieves the list of referral URLs for the operation represented by this access log entry, if any.
      Returns:
      The list of referral URLs for the operation represented by this access log entry, or an empty list if no referral URLs were included in the access log entry.

    • getResponseControls

      @NotNull public final List<Control> getResponseControls()
      Retrieves a list of the response controls for the operation represented by this access log entry, if any.
      Returns:
      A list of the response controls for the operation represented by this access log entry, or an empty list if there were no response controls included in the access log entry.

    • getAuthorizationIdentityDN

      @Nullable public final String getAuthorizationIdentityDN()
      Retrieves the DN of the account that served as the authorization identity for the operation represented by this access log entry, if any.
      Returns:
      The DN of the account that served as the authorization identity for the operation represented by this access log entry, or null if the authorization identity is not available.

    • toLDAPResult

      @Nullable public final LDAPResult toLDAPResult()
      Retrieves an LDAPResult object that represents the server response described by this access log entry, if any. Note that for some types of operations, like abandon and unbind operations, the server will not return a result to the client.
      Returns:
      An LDAPResult object that represents the server response described by this access log entry, or null if no response information is available.

    • decode

      @NotNull public static DraftChuLDAPLogSchema00Entry decode(@NotNull Entry entry) throws LDAPException
      Decodes the provided entry as an access log entry of the appropriate type.
      Parameters:
      entry - The entry to decode as an access log entry. It must not be null.
      Returns:
      The decoded access log entry.
      Throws:
      LDAPException - If the provided entry cannot be decoded as a valid access log entry as per the specification contained in draft-chu-ldap-logschema-00.