@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class JSONLDAPConnectionLoggerProperties extends java.lang.Object implements java.io.Serializable
JSONLDAPConnectionLogger
.Constructor and Description |
---|
JSONLDAPConnectionLoggerProperties()
Creates a new set of JSON LDAP connection logger properties with the
default settings.
|
JSONLDAPConnectionLoggerProperties(JSONLDAPConnectionLogger logger)
Creates a new set of JSON LDAP connection logger properties using the
configuration for the provided logger.
|
JSONLDAPConnectionLoggerProperties(JSONLDAPConnectionLoggerProperties properties)
Creates a new set of JSON LDAP connection logger properties that is a clone
of the provided set of properties.
|
Modifier and Type | Method and Description |
---|---|
boolean |
flushAfterConnectMessages()
Indicates whether the log handler should be flushed after logging each
successful or failed connection attempt.
|
boolean |
flushAfterDisconnectMessages()
Indicates whether the log handler should be flushed after logging each
disconnect.
|
boolean |
flushAfterFinalResultMessages()
Indicates whether the log handler should be flushed after logging the final
result for each operation.
|
boolean |
flushAfterNonFinalResultMessages()
Indicates whether the log handler should be flushed after logging each
non-final result (including search result entries, search result
references, and intermediate response messages).
|
boolean |
flushAfterRequestMessages()
Indicates whether the log handler should be flushed after logging each
request.
|
java.util.Set<java.lang.String> |
getAttributesToRedact()
Retrieves a set containing the names or OIDs of the attributes whose values
should be redacted from log messages.
|
java.util.Set<OperationType> |
getOperationTypes()
Retrieves the set of operation types for which to log requests and results.
|
Schema |
getSchema()
Retrieves the schema that will be used to identify alternate names and OIDs
for attributes whose values should be redacted.
|
boolean |
includeAddAttributeNames()
Indicates whether log messages about add requests should include the names
of the attributes provided in the request.
|
boolean |
includeAddAttributeValues()
Indicates whether log messages about add requests should include the values
of the attributes provided in the request.
|
boolean |
includeControlOIDs()
Indicates whether request and result log messages should include the OIDs
of any controls included in that request or result.
|
boolean |
includeModifyAttributeNames()
Indicates whether log messages about modify requests should include the
names of the attributes modified in the request.
|
boolean |
includeModifyAttributeValues()
Indicates whether log messages about modify requests should include the
values of the attributes modified in the request.
|
boolean |
includeSearchEntryAttributeNames()
Indicates whether log messages about search result entries should include
the names of the attributes in the returned entry.
|
boolean |
includeSearchEntryAttributeValues()
Indicates whether log messages about search result entries should include
the values of the attributes in the returned entry.
|
boolean |
logConnects()
Indicates whether to log successful and failed connection attempts.
|
boolean |
logDisconnects()
Indicates whether to log disconnects.
|
boolean |
logFinalResults()
Indicates whether to log messages about the final results for operations
included in the set of operation types returned by the
getOperationTypes() method. |
boolean |
logIntermediateResponses()
Indicates whether to log messages about each intermediate response returned
in the course of processing an operation.
|
boolean |
logRequests()
Indicates whether to log messages about requests for operations included
in the set of operation types returned by the
getOperationTypes()
method. |
boolean |
logSearchEntries()
Indicates whether to log messages about each search result entry returned
for search operations.
|
boolean |
logSearchReferences()
Indicates whether to log messages about each search result reference
returned for search operations.
|
void |
setAttributesToRedact(java.util.Collection<java.lang.String> attributesToRedact)
Specifies the names or OIDs of the attributes whose values should be
redacted from log messages.
|
void |
setAttributesToRedact(java.lang.String... attributesToRedact)
Specifies the names or OIDs of the attributes whose values should be
redacted from log messages.
|
void |
setFlushAfterConnectMessages(boolean flushAfterConnectMessages)
Specifies whether the log handler should be flushed after logging each
successful or failed connection attempt.
|
void |
setFlushAfterDisconnectMessages(boolean flushAfterDisconnectMessages)
Specifies whether the log handler should be flushed after logging each
disconnect.
|
void |
setFlushAfterFinalResultMessages(boolean flushAfterFinalResultMessages)
Specifies whether the log handler should be flushed after logging the final
result for each operation.
|
void |
setFlushAfterNonFinalResultMessages(boolean flushAfterNonFinalResultMessages)
Specifies whether the log handler should be flushed after logging each
non-final result (including search result entries, search result
references, and intermediate result messages).
|
void |
setFlushAfterRequestMessages(boolean flushAfterRequestMessages)
Specifies whether the log handler should be flushed after logging each
request.
|
void |
setIncludeAddAttributeNames(boolean includeAddAttributeNames)
Specifies whether log messages about add requests should include the names
of the attributes provided in the request.
|
void |
setIncludeAddAttributeValues(boolean includeAddAttributeValues)
Specifies whether log messages about add requests should include the values
of the attributes provided in the request.
|
void |
setIncludeControlOIDs(boolean includeControlOIDs)
Specifies whether request and result log messages should include the OIDs
of any controls included in that request or result.
|
void |
setIncludeModifyAttributeNames(boolean includeModifyAttributeNames)
Specifies whether log messages about modify requests should include the
names of the attributes modified in the request.
|
void |
setIncludeModifyAttributeValues(boolean includeModifyAttributeValues)
Specifies whether log messages about modify requests should include the
values of the attributes modified in the request.
|
void |
setIncludeSearchEntryAttributeNames(boolean includeSearchEntryAttributeNames)
Specifies whether log messages about search result entries should include
the names of the attributes in the returned entry.
|
void |
setIncludeSearchEntryAttributeValues(boolean includeSearchEntryAttributeValues)
Specifies whether log messages about search result entries should include
the values of the attributes in the returned entry.
|
void |
setLogConnects(boolean logConnects)
Specifies whether to log successful and failed connection attempts.
|
void |
setLogDisconnects(boolean logDisconnects)
Specifies whether to log disconnects.
|
void |
setLogFinalResults(boolean logFinalResults)
Specifies whether to log messages about the final results for operations
included in the set of operation types returned by the
getOperationTypes() method. |
void |
setLogIntermediateResponses(boolean logIntermediateResponses)
Specifies whether to log messages about each intermediate response returned
in the course of processing an operation.
|
void |
setLogRequests(boolean logRequests)
Specifies whether to log messages about requests for operations included
in the set of operation types returned by the
getOperationTypes()
method. |
void |
setLogSearchEntries(boolean logSearchEntries)
Specifies whether to log messages about each search result entry returned
for search operations.
|
void |
setLogSearchReferences(boolean logSearchReferences)
Specifies whether to log messages about each search result reference
returned for search operations.
|
void |
setOperationTypes(java.util.Collection<OperationType> operationTypes)
Specifies the set of operation types for which to log requests and results.
|
void |
setOperationTypes(OperationType... operationTypes)
Specifies the set of operation types for which to log requests and results.
|
void |
setSchema(Schema schema)
Specifies the schema that will be used to identify alternate names and OIDs
for attributes whose values should be redacted.
|
java.lang.String |
toString()
Retrieves a string representation of this
JSONLDAPConnectionLoggerProperties object. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this
JSONLDAPConnectionLoggerProperties object to the provided buffer. |
public JSONLDAPConnectionLoggerProperties()
public JSONLDAPConnectionLoggerProperties(@NotNull JSONLDAPConnectionLoggerProperties properties)
properties
- The set of properties to copy. It must not be
null
.public JSONLDAPConnectionLoggerProperties(@NotNull JSONLDAPConnectionLogger logger)
logger
- The JSON LDAP connection logger whose configuration should
be used to create the set of properties.public boolean logConnects()
true
if connection attempts should be logged, or
false
if not.public void setLogConnects(boolean logConnects)
logConnects
- Indicates whether to log successful and failed
connection attempts.public boolean logDisconnects()
true
if disconnects should be logged, or false
if
not.public void setLogDisconnects(boolean logDisconnects)
logDisconnects
- Indicates whether to log disconnects.public boolean logRequests()
getOperationTypes()
method. Operation requests will be logged by default.true
if operation requests should be logged for
appropriate operation types, or false
if not.public void setLogRequests(boolean logRequests)
getOperationTypes()
method.logRequests
- Indicates whether to log messages about operation
requests.public boolean logFinalResults()
getOperationTypes()
method. Final operation results will be
logged by default.true
if operation requests should be logged for
appropriate operation types, or false
if not.public void setLogFinalResults(boolean logFinalResults)
getOperationTypes()
method.logFinalResults
- Indicates whether to log messages about final
operation results.public boolean logSearchEntries()
getOperationTypes()
method includes
OperationType.SEARCH
. Search result entries will not be logged by
default.true
if search result entries should be logged, or
false
if not.public void setLogSearchEntries(boolean logSearchEntries)
getOperationTypes()
method includes
OperationType.SEARCH
.logSearchEntries
- Indicates whether to log search result entry
messages.public boolean logSearchReferences()
getOperationTypes()
method includes
OperationType.SEARCH
. Search result references will not be logged
by default.true
if search result references should be logged, or
false
if not.public void setLogSearchReferences(boolean logSearchReferences)
getOperationTypes()
method includes
OperationType.SEARCH
.logSearchReferences
- Indicates whether to log search result
reference messages.public boolean logIntermediateResponses()
true
if intermediate response messages should be logged,
or false
if not.public void setLogIntermediateResponses(boolean logIntermediateResponses)
logIntermediateResponses
- Indicates whether to log intermediate
response messages.@NotNull public java.util.Set<OperationType> getOperationTypes()
public void setOperationTypes(@Nullable OperationType... operationTypes)
operationTypes
- The set of operation types for which to log
requests and results. It may be null
or
empty if no operation types should be logged.public void setOperationTypes(@Nullable java.util.Collection<OperationType> operationTypes)
operationTypes
- The set of operation types for which to log
requests and results. It may be null
or
empty if no operation types should be logged.public boolean includeAddAttributeNames()
true
if add attribute names should be logged, or
false
if not.public void setIncludeAddAttributeNames(boolean includeAddAttributeNames)
includeAddAttributeNames
- Indicates whether to include attribute
names in add request log messages.public boolean includeAddAttributeValues()
includeAddAttributeNames
returns true
. Values for
attributes named in the set returned by the
getAttributesToRedact()
method will be replaced with a value of
"[REDACTED]". Add attribute names (but not values) will be logged by
default.true
if add attribute values should be logged, or
false
if not.public void setIncludeAddAttributeValues(boolean includeAddAttributeValues)
includeAddAttributeNames
returns true
. Values for
attributes named in the set returned by the
getAttributesToRedact()
method will be replaced with a value of
"[REDACTED]".includeAddAttributeValues
- Indicates whether to include attribute
values in add request log messages.public boolean includeModifyAttributeNames()
true
if modify attribute names should be logged, or
false
if not.public void setIncludeModifyAttributeNames(boolean includeModifyAttributeNames)
includeModifyAttributeNames
- Indicates whether to include attribute
names in modify request log messages.public boolean includeModifyAttributeValues()
includeModifyAttributeNames
returns true
.
Values for attributes named in the set returned by the
getAttributesToRedact()
method will be replaced with a value of
"[REDACTED]". Modify attribute names (but not values) will be logged by
default.true
if modify attribute values should be logged, or
false
if not.public void setIncludeModifyAttributeValues(boolean includeModifyAttributeValues)
includeModifyAttributeNames
returns true
.
Values for attributes named in the set returned by the
getAttributesToRedact()
method will be replaced with a value of
"[REDACTED]".includeModifyAttributeValues
- Indicates whether to include
attribute values in modify request
log messages.public boolean includeSearchEntryAttributeNames()
true
if search result entry attribute names should be
logged, or false
if not.public void setIncludeSearchEntryAttributeNames(boolean includeSearchEntryAttributeNames)
includeSearchEntryAttributeNames
- Indicates whether to include
attribute names in search result
entry log messages.public boolean includeSearchEntryAttributeValues()
includeSearchEntryAttributeNames
returns
true
. Values for attributes named in the set returned by the
getAttributesToRedact()
method will be replaced with a value of
"[REDACTED]". Entry attribute names (but not values) will be logged by
default.true
if search result entry attribute values should be
logged, or false
if not.public void setIncludeSearchEntryAttributeValues(boolean includeSearchEntryAttributeValues)
includeSearchEntryAttributeNames
returns
true
. Values for attributes named in the set returned by the
getAttributesToRedact()
method will be replaced with a value of
"[REDACTED]".includeSearchEntryAttributeValues
- Indicates whether to include
attribute values in search
result entry log messages.@NotNull public java.util.Set<java.lang.String> getAttributesToRedact()
public void setAttributesToRedact(@Nullable java.lang.String... attributesToRedact)
attributesToRedact
- The names or OIDs of the attributes whose
values should be redacted. It may be
null
or empty if no attribute values
should be redacted.public void setAttributesToRedact(@Nullable java.util.Collection<java.lang.String> attributesToRedact)
attributesToRedact
- The names or OIDs of the attributes whose
values should be redacted. It may be
null
or empty if no attribute values
should be redacted.public boolean includeControlOIDs()
true
if request control OIDs should be logged, or
false
if not.public void setIncludeControlOIDs(boolean includeControlOIDs)
includeControlOIDs
- Indicates whether to include control OIDs in
request and result log messages.public boolean flushAfterConnectMessages()
true
if the log handler should be flushed after logging
each connection attempt, or false
if not.public void setFlushAfterConnectMessages(boolean flushAfterConnectMessages)
flushAfterConnectMessages
- Indicates whether the log handler should
be flushed after logging each connection
attempt.public boolean flushAfterDisconnectMessages()
true
if the log handler should be flushed after logging
each disconnect, or false
if not.public void setFlushAfterDisconnectMessages(boolean flushAfterDisconnectMessages)
flushAfterDisconnectMessages
- Indicates whether the log handler
should be flushed after logging each
disconnect.public boolean flushAfterRequestMessages()
true
if the log handler should be flushed after logging
each request, or false
if not.public void setFlushAfterRequestMessages(boolean flushAfterRequestMessages)
flushAfterRequestMessages
- Indicates whether the log handler should
be flushed after logging each request.public boolean flushAfterNonFinalResultMessages()
true
if the log handler should be flushed after logging
each non-final result, or false
if not.public void setFlushAfterNonFinalResultMessages(boolean flushAfterNonFinalResultMessages)
flushAfterNonFinalResultMessages
- Indicates whether the log
handler should be flushed after
logging each non-final result.public boolean flushAfterFinalResultMessages()
true
if the log handler should be flushed after logging
each final result, or false
if not.public void setFlushAfterFinalResultMessages(boolean flushAfterFinalResultMessages)
flushAfterFinalResultMessages
- Indicates whether the log handler
should be flushed after logging
each final result.@Nullable public Schema getSchema()
null
if no schema should be used.public void setSchema(@Nullable Schema schema)
schema
- The schema that will be used to identify alternate names
and OIDs for attributes whose values should be redacted.
It may be null
if no schema should be used.@NotNull public java.lang.String toString()
JSONLDAPConnectionLoggerProperties
object.toString
in class java.lang.Object
JSONLDAPConnectionLoggerProperties
object.