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

Class TextFormattedAccessLogFields

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogFields
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TextFormattedAccessLogFields extends Object
This class defines a number of constants that represent fields that may appear in text-formatted access log messages.
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:

  • Field Details

    • ABANDON_MESSAGE_ID

      @NotNull public static final LogField ABANDON_MESSAGE_ID
      A field that holds the message ID for an operation to be abandoned. This field may appear in access log messages for abandon operations.

    • ADD_ATTRIBUTES

      @NotNull public static final LogField ADD_ATTRIBUTES
      A field that holds a comma-delimited list of the names of the attributes to be added. This field may appear in access log messages for add operations.

    • ADD_ENTRY_DN

      @NotNull public static final LogField ADD_ENTRY_DN
      A field that holds the DN of the entry to be added. This field may appear in access log messages for add operations.

    • ADD_UNDELETE_FROM_DN

      @NotNull public static final LogField ADD_UNDELETE_FROM_DN
      A field that holds the DN of the soft-deleted entry being undeleted. This field may appear in access log messages for add operations.

    • ADDITIONAL_INFO

      @NotNull public static final LogField ADDITIONAL_INFO
      A field that holds a message with additional information about the server's processing for an operation. This message will not be returned to the client. This field may appear in all types of operation result access log messages.

    • ADMINISTRATIVE_OPERATION

      @NotNull public static final LogField ADMINISTRATIVE_OPERATION
      A field that indicates that the associated operation includes an administrative operation request control. The value of the field is the message (if any) contained in that control. This field may appear in all types of access log messages that are associated with an operation.

    • ASSURANCE_TIMEOUT_MILLIS

      @NotNull public static final LogField ASSURANCE_TIMEOUT_MILLIS
      A field that holds the requested replication assurance timeout, in milliseconds. This field may appear in all types of operation result access log messages.

    • AUTHORIZATION_DN

      @NotNull public static final LogField AUTHORIZATION_DN
      A field that holds the DN that was used as the alternative authorization identity for the operation. This field may appear in all types of operation result access log messages.

    • AUTO_AUTHENTICATED_AS

      @NotNull public static final LogField AUTO_AUTHENTICATED_AS
      A field that holds the DN of the user that was automatically authenticated to the server based on the certificate chain the client presented during security negotiation. This field may appear in SECURITY-NEGOTIATION access log messages.

    • BIND_AUTHENTICATION_DN

      @NotNull public static final LogField BIND_AUTHENTICATION_DN
      A field that holds the DN of the user that was authenticated in a bind operation. This field may appear in bind result access log messages.

    • BIND_AUTHENTICATION_FAILURE_ID

      @NotNull public static final LogField BIND_AUTHENTICATION_FAILURE_ID
      A field that holds a numeric identifier that is associated with the general reason for the authentication failure. This field may appear in bind result access log messages.

    • BIND_AUTHENTICATION_FAILURE_NAME

      @NotNull public static final LogField BIND_AUTHENTICATION_FAILURE_NAME
      A field that holds a numeric identifier that is associated with the general reason for the authentication failure. This field may appear in bind result access log messages.

    • BIND_AUTHENTICATION_FAILURE_REASON

      @NotNull public static final LogField BIND_AUTHENTICATION_FAILURE_REASON
      A field that holds a message providing a reason for a failed authentication attempt. This field may appear in bind result access log messages.

    • BIND_AUTHENTICATION_TYPE

      @NotNull public static final LogField BIND_AUTHENTICATION_TYPE
      A field that holds the authentication type for a bind request. This field may appear in access log messages for bind operations.

    • BIND_AUTHORIZATION_DN

      @NotNull public static final LogField BIND_AUTHORIZATION_DN
      A field that holds the DN of the authorization identity resulting from a bind operation. This field may appear in bind result access log messages.

    • BIND_DN

      @NotNull public static final LogField BIND_DN
      A field that holds the bind DN for a bind request. This field may appear in access log messages for bind operations.

    • BIND_PROTOCOL_VERSION

      @NotNull public static final LogField BIND_PROTOCOL_VERSION
      A field that holds the protocol version for a bind request. This field may appear in access log messages for bind operations.

    • BIND_RETIRED_PASSWORD_USED

      @NotNull public static final LogField BIND_RETIRED_PASSWORD_USED
      A field that indicates whether a retired password was used in the course of processing a bind operation. This field may appear in bind result access log messages.

    • BIND_SASL_MECHANISM

      @NotNull public static final LogField BIND_SASL_MECHANISM
      A field that holds the name of the SASL mechanism used for a bind request. This field may appear in access log messages for bind operations.

    • CHANGE_TO_SOFT_DELETED_ENTRY

      @NotNull public static final LogField CHANGE_TO_SOFT_DELETED_ENTRY
      A field that indicates whether the associated operation updated or removed a soft-deleted entry. This field may appear in access log messages for modify and delete operations.

    • CIPHER

      @NotNull public static final LogField CIPHER
      A field that holds the name of the cipher algorithm that was negotiated for the client connection. This field may appear in SECURITY-NEGOTIATION access log messages.

    • CLIENT_CONNECTION_POLICY

      @NotNull public static final LogField CLIENT_CONNECTION_POLICY
      A field that holds the name of the client connection policy that has been assigned to the associated connection. This field may appear in CONNECT access log messages, as well as in result access log messages for operations that may cause a new client connection policy to be assigned to the connection (including bind and StartTLS).

    • COMPARE_ASSERTION_VALUE

      @NotNull public static final LogField COMPARE_ASSERTION_VALUE
      A field that holds the assertion value included in a compare operation. This field may appear in access log messages for compare operations.

    • COMPARE_ATTRIBUTE_NAME

      @NotNull public static final LogField COMPARE_ATTRIBUTE_NAME
      A field that holds the name of the attribute targeted by a compare operation. This field may appear in access log messages for compare operations.

    • COMPARE_ENTRY_DN

      @NotNull public static final LogField COMPARE_ENTRY_DN
      A field that holds the DN of the entry targeted by a compare operation. This field may appear in access log messages for compare operations.

    • CONNECT_FROM_ADDRESS

      @NotNull public static final LogField CONNECT_FROM_ADDRESS
      A field that holds the address of the client from which a connection has been established. This field may appear in CONNECT access log messages.

    • CONNECT_FROM_PORT

      @NotNull public static final LogField CONNECT_FROM_PORT
      A field that holds the remote port for a client connection that has been established. This field may appear in CONNECT access log messages.

    • CONNECT_TO_ADDRESS

      @NotNull public static final LogField CONNECT_TO_ADDRESS
      A field that holds the server address to which a connection has been established. This field may appear in CONNECT access log messages.

    • CONNECT_TO_PORT

      @NotNull public static final LogField CONNECT_TO_PORT
      A field that holds the server port to which a connection has been established. This field may appear in CONNECT access log messages.

    • CONNECTION_ID

      @NotNull public static final LogField CONNECTION_ID
      A field that holds a numeric identifier for the associated client connection. All access log messages associated with a given connection will share the same connection ID, so this field may be used to identify messages associated with that connection. Note, however, that the connection ID counter is reset when the server is restarted, so the STARTUP_ID field may also be necessary to further distinguish between connections across restarts. Further, connection ID values may be reused across instances, so the INSTANCE_NAME field may also be needed to distinguish between connections to different instances. This field may appear in all types of access log messages.

    • DELETE_ENTRY_DN

      @NotNull public static final LogField DELETE_ENTRY_DN
      A field that holds the DN of the entry targeted by a delete operation. This field may appear in access log messages for delete operations.

    • DELETE_SOFT_DELETED_ENTRY_DN

      @NotNull public static final LogField DELETE_SOFT_DELETED_ENTRY_DN
      A field that holds the DN of a soft-deleted entry resulting from a delete operation. This field may appear in access log messages for delete operations.

    • DIAGNOSTIC_MESSAGE

      @NotNull public static final LogField DIAGNOSTIC_MESSAGE
      A field that holds the diagnostic message for an operation, which is a message that is returned to the client. This field may appear in all types of operation result access log messages.

    • DISCONNECT_MESSAGE

      @NotNull public static final LogField DISCONNECT_MESSAGE
      A field that holds an additional message for a connection closure, which may provide additional details about the disconnect. This field may appear in DISCONNECT access log messages.

    • DISCONNECT_REASON

      @NotNull public static final LogField DISCONNECT_REASON
      A field that holds a reason for a connection closure. This field may appear in DISCONNECT access log messages.

    • ENTRY_REBALANCING_ADMIN_ACTION_MESSAGE

      @NotNull public static final LogField ENTRY_REBALANCING_ADMIN_ACTION_MESSAGE
      A field that holds a message about any administrative action that may be required after an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_BASE_DN

      @NotNull public static final LogField ENTRY_REBALANCING_BASE_DN
      A field that holds the base DN for an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_ENTRIES_ADDED_TO_TARGET

      @NotNull public static final LogField ENTRY_REBALANCING_ENTRIES_ADDED_TO_TARGET
      A field that holds the number of entries added to the target server in the course of processing an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_ENTRIES_DELETED_FROM_SOURCE

      @NotNull public static final LogField ENTRY_REBALANCING_ENTRIES_DELETED_FROM_SOURCE
      A field that holds the number of entries deleted from the source server in the course of processing an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_ENTRIES_READ_FROM_SOURCE

      @NotNull public static final LogField ENTRY_REBALANCING_ENTRIES_READ_FROM_SOURCE
      A field that holds the number of entries read from the source server in the course of processing an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_ERROR_MESSAGE

      @NotNull public static final LogField ENTRY_REBALANCING_ERROR_MESSAGE
      A field that holds an error message for an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_OPERATION_ID

      @NotNull public static final LogField ENTRY_REBALANCING_OPERATION_ID
      A field that holds the operation ID for an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_SIZE_LIMIT

      @NotNull public static final LogField ENTRY_REBALANCING_SIZE_LIMIT
      A field that holds the size limit for an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_SOURCE_BACKEND_SET

      @NotNull public static final LogField ENTRY_REBALANCING_SOURCE_BACKEND_SET
      A field that holds the name of the source backend set for an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_SOURCE_SERVER

      @NotNull public static final LogField ENTRY_REBALANCING_SOURCE_SERVER
      A field that holds the address and port of the source server for an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_SOURCE_SERVER_ALTERED

      @NotNull public static final LogField ENTRY_REBALANCING_SOURCE_SERVER_ALTERED
      A field that indicates whether the source server was altered in the course of processing an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_TARGET_BACKEND_SET

      @NotNull public static final LogField ENTRY_REBALANCING_TARGET_BACKEND_SET
      A field that holds the name of the target backend set for an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_TARGET_SERVER

      @NotNull public static final LogField ENTRY_REBALANCING_TARGET_SERVER
      A field that holds the address and port of the target server for an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • ENTRY_REBALANCING_TARGET_SERVER_ALTERED

      @NotNull public static final LogField ENTRY_REBALANCING_TARGET_SERVER_ALTERED
      A field that indicates whether the target server was altered in the course of processing an entry rebalancing operation. This field may appear in entry rebalancing access log messages.

    • EXTENDED_REQUEST_OID

      @NotNull public static final LogField EXTENDED_REQUEST_OID
      A field that holds the request OID for an extended operation. This field may appear in access log messages for extended operations.

    • EXTENDED_REQUEST_TYPE

      @NotNull public static final LogField EXTENDED_REQUEST_TYPE
      A field that holds the name for an extended request. This field may appear in access log messages for extended operations.

    • EXTENDED_RESPONSE_OID

      @NotNull public static final LogField EXTENDED_RESPONSE_OID
      A field that holds the response OID for an extended operation. This field may appear in access log messages for extended operations.

    • EXTENDED_RESPONSE_TYPE

      @NotNull public static final LogField EXTENDED_RESPONSE_TYPE
      A field that holds the name for an extended response. This field may appear in access log messages for extended operations.

    • INDEXES_WITH_KEYS_ACCESSED_EXCEEDING_ENTRY_LIMIT

      @NotNull public static final LogField INDEXES_WITH_KEYS_ACCESSED_EXCEEDING_ENTRY_LIMIT
      A field that holds a comma-delimited list of the names of any indexes accessed in the course of processing operation that had exceeded the index entry limit. This field may appear operation result access log messages.

    • INDEXES_WITH_KEYS_ACCESSED_NEAR_ENTRY_LIMIT

      @NotNull public static final LogField INDEXES_WITH_KEYS_ACCESSED_NEAR_ENTRY_LIMIT
      A field that holds a comma-delimited list of the names of any indexes accessed in the course of processing operation that were near the index entry limit. This field may appear operation result access log messages.

    • INSTANCE_NAME

      @NotNull public static final LogField INSTANCE_NAME
      A field that holds the name of the server instance that logged the message. This field may appear in all types of access log messages.

    • INTER_SERVER_COMPONENT

      @NotNull public static final LogField INTER_SERVER_COMPONENT
      A field that holds the name of the name of the component that generated an inter-server request control. This field amy appear in all types of access log messages that are associated with operations.

    • INTER_SERVER_PROPERTIES

      @NotNull public static final LogField INTER_SERVER_PROPERTIES
      A field that holds a string representation of the properties included in an inter-server request control. This field amy appear in all types of access log messages that are associated with operations.

    • INTER_SERVER_OPERATION_PURPOSE

      @NotNull public static final LogField INTER_SERVER_OPERATION_PURPOSE
      A field that holds the operation purpose string included in an inter-server request control. This field amy appear in all types of access log messages that are associated with operations.

    • INTERMEDIATE_CLIENT_REQUEST

      @NotNull public static final LogField INTERMEDIATE_CLIENT_REQUEST
      A field that holds a string representation of any intermediate client request control included in the operation. This field may appear in all types of access log messages that are associated with operations.

    • INTERMEDIATE_CLIENT_RESULT

      @NotNull public static final LogField INTERMEDIATE_CLIENT_RESULT
      A field that holds a string representation of any intermediate client response control returned to the client. This field may appear in all types of operation result access log messages.

    • INTERMEDIATE_RESPONSE_NAME

      @NotNull public static final LogField INTERMEDIATE_RESPONSE_NAME
      A field that holds the name for an intermediate response returned to the client. This field may appear in intermediate response access log messages.

    • INTERMEDIATE_RESPONSE_OID

      @NotNull public static final LogField INTERMEDIATE_RESPONSE_OID
      A field that holds the OID for an intermediate response returned to the client. This field may appear in intermediate response access log messages.

    • INTERMEDIATE_RESPONSE_VALUE

      @NotNull public static final LogField INTERMEDIATE_RESPONSE_VALUE
      A field that holds a string representation of the value for an intermediate response returned to the client. This field may appear in intermediate response access log messages.

    • INTERMEDIATE_RESPONSES_RETURNED

      @NotNull public static final LogField INTERMEDIATE_RESPONSES_RETURNED
      A field that holds the number of intermediate response messages returned to the client in the course of processing the operation. This field may appear in all types of operation result access log messages.

    • ISSUER_CERTIFICATE_SUBJECT_DN

      @NotNull public static final LogField ISSUER_CERTIFICATE_SUBJECT_DN
      A field that holds the subject DN for an issuer certificate presented in the client certificate chain during security negotiation. This field may appear in CLIENT-CERTIFICATE access log messages, and it may appear multiple times if the presented certificate chain included three or more certificates.

    • LOCAL_ASSURANCE_LEVEL

      @NotNull public static final LogField LOCAL_ASSURANCE_LEVEL
      A field that holds the name of the requested local replication assurance level for the operation. This field may appear in all types of operation result access log messages.

    • LOCAL_ASSURANCE_SATISFIED

      @NotNull public static final LogField LOCAL_ASSURANCE_SATISFIED
      A field that indicates whether the requested local assurance level was satisfied in the course of processing the operation. This field may appear in assurance completed access log messages.

    • MATCHED_DN

      @NotNull public static final LogField MATCHED_DN
      A field that holds the matched DN for the operation, which is the DN for the closest ancestor of an entry that does not exist. This field may appear in all types of operation result access log messages.

    • MESSAGE_ID

      @NotNull public static final LogField MESSAGE_ID
      A field that holds the numeric message ID for the associated operation on the client connection. For LDAP operations, this is the message ID included in the LDAP request and response messages for that operation. This field may appear in all types of access log messages that are associated with operations.

    • MISSING_PRIVILEGES

      @NotNull public static final LogField MISSING_PRIVILEGES
      A field that holds a comma-delimited list of the names of any privileges that were required for the processing the operation that the requester did not have. This field may appear in all types of operation result access log messages.

    • MODDN_DELETE_OLD_RDN

      @NotNull public static final LogField MODDN_DELETE_OLD_RDN
      A field that indicates whether old RDN attribute values should be removed from the entry. This field may appear in access log messages for modify DN operations.

    • MODDN_ENTRY_DN

      @NotNull public static final LogField MODDN_ENTRY_DN
      A field that holds the DN of the entry to be renamed. This field may appear in access log messages for modify DN operations.

    • MODDN_NEW_RDN

      @NotNull public static final LogField MODDN_NEW_RDN
      A field that holds the new RDN to use for the entry to be renamed. This field may appear in access log messages for modify DN operations.

    • MODDN_NEW_SUPERIOR_DN

      @NotNull public static final LogField MODDN_NEW_SUPERIOR_DN
      A field that holds the new superior entry DN to use for the entry to be renamed. This field may appear in access log messages for modify DN operations.

    • MODIFY_ATTRIBUTES

      @NotNull public static final LogField MODIFY_ATTRIBUTES
      A field that holds a comma-delimited list of the names of the attributes to be modified. This field may appear in access log messages for modify operations.

    • MODIFY_ENTRY_DN

      @NotNull public static final LogField MODIFY_ENTRY_DN
      A field that holds the DN of the entry to be modified. This field may appear in access log messages for modify operations.

    • OPERATION_ID

      @NotNull public static final LogField OPERATION_ID
      A field that holds a numeric identifier for the associated operation on the client connection. If there are multiple access log messages for a given operation (for example, if both request and response messages should be logged), then each of those log messages will have the same connection ID and operation ID values, so those fields may be used to identify messages for that operation. Note, however, that the connection ID counter is reset when the server is restarted, so the STARTUP_ID field may also be necessary to further distinguish between connections across restarts. Further, connection ID values may be reused across instances, so the INSTANCE_NAME field may also be needed to distinguish between connections to different instances. This field may appear in all types of access log messages that are associated with operations.

    • OPERATION_PURPOSE

      @NotNull public static final LogField OPERATION_PURPOSE
      A field that holds a string representation of an operation purpose request control included in the operation. This field may appear in all types of access log messages that are associated with operations.

    • ORIGIN

      @NotNull public static final LogField ORIGIN
      A field that holds information about the origin of the associated operation. This is especially common for things like internal operations or operations processed by the replication subsystem. This field may appear in all types of access log messages that are associated with operations.

    • PEER_CERTIFICATE_SUBJECT_DN

      @NotNull public static final LogField PEER_CERTIFICATE_SUBJECT_DN
      A field that holds the subject DN for the peer certificate presented in the client certificate chain during security negotiation. This field may appear in CLIENT-CERTIFICATE access log messages.

    • PRE_AUTHORIZATION_USED_PRIVILEGES

      @NotNull public static final LogField PRE_AUTHORIZATION_USED_PRIVILEGES
      A field whose value is a comma-delimited list of the names of any privileges used prior to processing a control that applies an alternative authorization identity to the operation. This field may appear in all types of operation result access log messages.

    • PROCESSING_TIME_MILLIS

      @NotNull public static final LogField PROCESSING_TIME_MILLIS
      A field that holds the length of time (in milliseconds) that a worker thread spent processing the operation. This field may appear in all types of operation result access log messages.

    • PRODUCT_NAME

      @NotNull public static final LogField PRODUCT_NAME
      A field that holds the name of the product that logged the message. This field may appear in all types of access log messages.

    • PROTOCOL

      @NotNull public static final LogField PROTOCOL
      A field that holds the name of the protocol a client is using to communicate with the server. This field may appear in CONNECT and SECURITY-NEGOTIATION access log messages.

    • REFERRAL_URLS

      @NotNull public static final LogField REFERRAL_URLS
      A field that holds a comma-delimited list of referral URLs for an operation, which indicate that the requested operation should be attempted elsewhere. This field may appear in all types of operation result access log messages.

    • REMOTE_ASSURANCE_LEVEL

      @NotNull public static final LogField REMOTE_ASSURANCE_LEVEL
      A field that holds the name of the requested remote replication assurance level for the operation. This field may appear in all types of operation result access log messages.

    • REMOTE_ASSURANCE_SATISFIED

      @NotNull public static final LogField REMOTE_ASSURANCE_SATISFIED
      A field that indicates whether the requested remote assurance level was satisfied in the course of processing the operation. This field may appear in assurance completed access log messages.

    • REPLICATION_CHANGE_ID

      @NotNull public static final LogField REPLICATION_CHANGE_ID
      A field that holds the replication change ID for a replicated operation. This field may appear in all types of operation result access log messages.

    • REQUEST_CONTROL_OIDS

      @NotNull public static final LogField REQUEST_CONTROL_OIDS
      A field that holds a comma-delimited list of the OIDs of any controls included in the request. This field may appear in all types of access log messages that are associated with operations.

    • REQUESTER_DN

      @NotNull public static final LogField REQUESTER_DN
      A field that holds the DN of the user that requested the associated operation. This field may appear in all types of access log messages that are associated with operations.

    • REQUESTER_IP_ADDRESS

      @NotNull public static final LogField REQUESTER_IP_ADDRESS
      A field that holds the IP address of the client that requested the associated operation. This field may appear in all types of access log messages that are associated with operations.

    • RESPONSE_CONTROL_OIDS

      @NotNull public static final LogField RESPONSE_CONTROL_OIDS
      A field that holds a comma-delimited list of the OIDs of any controls included in the response. This field may appear in all types of operation result access log messages.

    • RESPONSE_DELAYED_BY_ASSURANCE

      @NotNull public static final LogField RESPONSE_DELAYED_BY_ASSURANCE
      A field that indicates whether the response to the operation was delayed by replication assurance processing. This field may appear in all types of operation result access log messages.

    • RESULT_CODE_NAME

      @NotNull public static final LogField RESULT_CODE_NAME
      A field that holds the name of the result code for the associated operation. This field may appear in all types of operation result access log messages.

    • RESULT_CODE_VALUE

      @NotNull public static final LogField RESULT_CODE_VALUE
      A field that holds the numeric value of the result code for the associated operation. This field may appear in all types of operation result access log messages.

    • SEARCH_BASE_DN

      @NotNull public static final LogField SEARCH_BASE_DN
      A field that holds the base DN for a search operation. This field may appear in access log messages for search operations.

    • SEARCH_DEREF_POLICY

      @NotNull public static final LogField SEARCH_DEREF_POLICY
      A field that holds the name of the policy to use for dereferencing aliases for a search operation. This field may appear in access log messages for search operations.

    • SEARCH_ENTRIES_RETURNED

      @NotNull public static final LogField SEARCH_ENTRIES_RETURNED
      A field that holds the number of search result entries that were returned to the client. This field may appear in search result access log messages.

    • SEARCH_FILTER

      @NotNull public static final LogField SEARCH_FILTER
      A field that holds a string representation of the filter for a search operation. This field may appear in access log messages for search operations.

    • SEARCH_REQUESTED_ATTRIBUTES

      @NotNull public static final LogField SEARCH_REQUESTED_ATTRIBUTES
      A field that holds a comma-delimited list of the names of the attributes requested to be included in search result entries. This field may appear in access log messages for search operations.

    • SEARCH_RESULT_ENTRY_DN

      @NotNull public static final LogField SEARCH_RESULT_ENTRY_DN
      A field that holds the DN for a search result entry. This field may appear in access log messages for search result entries.

    • SEARCH_RESULT_ENTRY_ATTRIBUTES

      @NotNull public static final LogField SEARCH_RESULT_ENTRY_ATTRIBUTES
      A field whose value is a comma-delimited list of the names of the attributes returned to the client in a search result entry. This field may appear in access log messages for search operations.

    • SEARCH_SCOPE_VALUE

      @NotNull public static final LogField SEARCH_SCOPE_VALUE
      A field that holds the numeric value of the scope for a search operation. This field may appear in access log messages for search operations.

    • SEARCH_SIZE_LIMIT

      @NotNull public static final LogField SEARCH_SIZE_LIMIT
      A field that holds the requested size limit for a search operation. This field may appear in access log messages for search operations.

    • SEARCH_TIME_LIMIT_SECONDS

      @NotNull public static final LogField SEARCH_TIME_LIMIT_SECONDS
      A field that holds the requested time limit (in seconds) for a search operation. This field may appear in access log messages for search operations.

    • SEARCH_TYPES_ONLY

      @NotNull public static final LogField SEARCH_TYPES_ONLY
      A field that indicates whether search result entries should only include attribute types or both types and values. This field may appear in access log messages for search operations.

    • SEARCH_UNINDEXED

      @NotNull public static final LogField SEARCH_UNINDEXED
      A field that indicates whether the search operation was considered unindexed. This field may appear in search result access log messages.

    • SERVER_ASSURANCE_RESULTS

      @NotNull public static final LogField SERVER_ASSURANCE_RESULTS
      A field that holds a comma-delimited list of the assurance results from each of the servers. This field may appear in assurance completed access log messages.

    • SERVERS_ACCESSED

      @NotNull public static final LogField SERVERS_ACCESSED
      A field that holds a comma-delimited list of the external servers accessed during the course of processing the operation. Each server in the list will consist of the name or IP address, a colon, and the port number. This field may appear in all types of operation result access log messages.

    • STARTUP_ID

      @NotNull public static final LogField STARTUP_ID
      A field that holds a unique value generated when the server started. This can help differentiate messages with the same connection ID and operation ID (if applicable) because those values are reset upon a server restart. This field may appear in all types of access log messages.

    • TARGET_HOST

      @NotNull public static final LogField TARGET_HOST
      A field that holds the address of a server to which the operation was forwarded for processing. This field may appear in access log messages for operations that were forwarded to a remote system.

    • TARGET_PORT

      @NotNull public static final LogField TARGET_PORT
      A field that holds the port of a server to which the operation was forwarded for processing. This field may appear in access log messages for operations that were forwarded to a remote system.

    • TARGET_PROTOCOL

      @NotNull public static final LogField TARGET_PROTOCOL
      A field that holds the protocol used to communicate with a remote server for an operation that was forwarded for processing. This field may appear in access log messages for operations that were forwarded to a remote system.

    • THREAD_ID

      @NotNull public static final LogField THREAD_ID
      A field that holds a numeric identifier for the thread that generated the log message, which is also likely the thread that performed the associated processing for the connection or operation). This field may appear in all types of access log messages.

    • TRIGGERED_BY_CONNECTION_ID

      @NotNull public static final LogField TRIGGERED_BY_CONNECTION_ID
      A field that holds the connection ID for another operation that triggered the associated operation. This field may appear in all types of access log messages that are associated with operations.

    • TRIGGERED_BY_OPERATION_ID

      @NotNull public static final LogField TRIGGERED_BY_OPERATION_ID
      A field that holds the operation ID for another operation that triggered the associated operation. This field may appear in all types of access log messages that are associated with operations.

    • UNCACHED_DATA_ACCESSED

      @NotNull public static final LogField UNCACHED_DATA_ACCESSED
      A field that indicates whether the server accessed any uncached data in the course of processing the operation. This field may appear in all types of operation result access log messages.

    • USED_PRIVILEGES

      @NotNull public static final LogField USED_PRIVILEGES
      A field that holds a comma-delimited list of the names of any privileges used in the course of processing the operation. This field may appear in all types of operation result access log messages.

    • USING_ADMIN_SESSION_WORKER_THREAD

      @NotNull public static final LogField USING_ADMIN_SESSION_WORKER_THREAD
      A field that indicates whether the associated operation is being processed using a worker thread from a thread pool dedicated to processing administrative operations. This field may appear in all types of access log messages that are associated with operations.

    • WORK_QUEUE_WAIT_TIME_MILLIS

      @NotNull public static final LogField WORK_QUEUE_WAIT_TIME_MILLIS
      A field that holds the length of time (in milliseconds) that the operation had to wait in the work queue before being picked up for processing. This field may appear in all types of operation result access log messages.

  • Method Details

    • getDefinedFields

      @NotNull public static Map<String,LogField> getDefinedFields()
      Retrieves a map of all predefined fields, indexed by the name of the constant in which the field is defined.
      Returns:
      A map of all predefined fields.

    • getFieldForConstantName

      @Nullable public static LogField getFieldForConstantName(@NotNull String constantName)
      Retrieves the predefined log field instance that is defined in the specified constants.
      Parameters:
      constantName - The name of the constant in which the desired field is defined. It must not be null.
      Returns:
      The log field instance defined in the specified constant, or null if there is no such constant.