Class JSONLDAPConnectionLoggerProperties

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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.lang.String... attributesToRedact)
      Specifies the names or OIDs of the attributes whose values should be redacted from log messages.
      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 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​(OperationType... operationTypes)
      Specifies the set of operation types for which to log requests and results.
      void setOperationTypes​(java.util.Collection<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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • logConnects

        public boolean logConnects()
        Indicates whether to log successful and failed connection attempts. Connection attempts will be logged by default.
        Returns:
        true if connection attempts should be logged, or false if not.
      • setLogConnects

        public void setLogConnects​(boolean logConnects)
        Specifies whether to log successful and failed connection attempts.
        Parameters:
        logConnects - Indicates whether to log successful and failed connection attempts.
      • logDisconnects

        public boolean logDisconnects()
        Indicates whether to log disconnects. Disconnects will be logged by default.
        Returns:
        true if disconnects should be logged, or false if not.
      • setLogDisconnects

        public void setLogDisconnects​(boolean logDisconnects)
        Specifies whether to log disconnects. Disconnects will be logged by default.
        Parameters:
        logDisconnects - Indicates whether to log disconnects.
      • logRequests

        public boolean logRequests()
        Indicates whether to log messages about requests for operations included in the set of operation types returned by the getOperationTypes() method. Operation requests will be logged by default.
        Returns:
        true if operation requests should be logged for appropriate operation types, or false if not.
      • setLogRequests

        public 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.
        Parameters:
        logRequests - Indicates whether to log messages about operation requests.
      • logFinalResults

        public 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. Final operation results will be logged by default.
        Returns:
        true if operation requests should be logged for appropriate operation types, or false if not.
      • setLogFinalResults

        public 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.
        Parameters:
        logFinalResults - Indicates whether to log messages about final operation results.
      • logSearchEntries

        public boolean logSearchEntries()
        Indicates whether to log messages about each search result entry returned for search operations. This property will only be used if the set returned by the getOperationTypes() method includes OperationType.SEARCH. Search result entries will not be logged by default.
        Returns:
        true if search result entries should be logged, or false if not.
      • setLogSearchEntries

        public void setLogSearchEntries​(boolean logSearchEntries)
        Specifies whether to log messages about each search result entry returned for search operations. This property will only be used if the set returned by the getOperationTypes() method includes OperationType.SEARCH.
        Parameters:
        logSearchEntries - Indicates whether to log search result entry messages.
      • logSearchReferences

        public boolean logSearchReferences()
        Indicates whether to log messages about each search result reference returned for search operations. This property will only be used if the set returned by the getOperationTypes() method includes OperationType.SEARCH. Search result references will not be logged by default.
        Returns:
        true if search result references should be logged, or false if not.
      • setLogSearchReferences

        public void setLogSearchReferences​(boolean logSearchReferences)
        Specifies whether to log messages about each search result reference returned for search operations. This property will only be used if the set returned by the getOperationTypes() method includes OperationType.SEARCH.
        Parameters:
        logSearchReferences - Indicates whether to log search result reference messages.
      • logIntermediateResponses

        public boolean logIntermediateResponses()
        Indicates whether to log messages about each intermediate response returned in the course of processing an operation. Intermediate response messages will be logged by default.
        Returns:
        true if intermediate response messages should be logged, or false if not.
      • setLogIntermediateResponses

        public void setLogIntermediateResponses​(boolean logIntermediateResponses)
        Specifies whether to log messages about each intermediate response returned in the course of processing an operation.
        Parameters:
        logIntermediateResponses - Indicates whether to log intermediate response messages.
      • getOperationTypes

        @NotNull
        public java.util.Set<OperationTypegetOperationTypes()
        Retrieves the set of operation types for which to log requests and results. All operation types will be logged by default.
        Returns:
        The set of operation types for which to log requests and results.
      • setOperationTypes

        public void setOperationTypes​(@Nullable
                                      OperationType... operationTypes)
        Specifies the set of operation types for which to log requests and results.
        Parameters:
        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.
      • setOperationTypes

        public void setOperationTypes​(@Nullable
                                      java.util.Collection<OperationType> operationTypes)
        Specifies the set of operation types for which to log requests and results.
        Parameters:
        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.
      • includeAddAttributeNames

        public boolean includeAddAttributeNames()
        Indicates whether log messages about add requests should include the names of the attributes provided in the request. Add attribute names (but not values) will be logged by default.
        Returns:
        true if add attribute names should be logged, or false if not.
      • setIncludeAddAttributeNames

        public void setIncludeAddAttributeNames​(boolean includeAddAttributeNames)
        Specifies whether log messages about add requests should include the names of the attributes provided in the request.
        Parameters:
        includeAddAttributeNames - Indicates whether to include attribute names in add request log messages.
      • includeAddAttributeValues

        public boolean includeAddAttributeValues()
        Indicates whether log messages about add requests should include the values of the attributes provided in the request. This property will only be used if 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.
        Returns:
        true if add attribute values should be logged, or false if not.
      • setIncludeAddAttributeValues

        public void setIncludeAddAttributeValues​(boolean includeAddAttributeValues)
        Specifies whether log messages about add requests should include the values of the attributes provided in the request. This property will only be used if includeAddAttributeNames returns true. Values for attributes named in the set returned by the getAttributesToRedact() method will be replaced with a value of "[REDACTED]".
        Parameters:
        includeAddAttributeValues - Indicates whether to include attribute values in add request log messages.
      • includeModifyAttributeNames

        public boolean includeModifyAttributeNames()
        Indicates whether log messages about modify requests should include the names of the attributes modified in the request. Modified attribute names (but not values) will be logged by default.
        Returns:
        true if modify attribute names should be logged, or false if not.
      • setIncludeModifyAttributeNames

        public void setIncludeModifyAttributeNames​(boolean includeModifyAttributeNames)
        Specifies whether log messages about modify requests should include the names of the attributes modified in the request.
        Parameters:
        includeModifyAttributeNames - Indicates whether to include attribute names in modify request log messages.
      • includeModifyAttributeValues

        public boolean includeModifyAttributeValues()
        Indicates whether log messages about modify requests should include the values of the attributes modified in the request. This property will only be used if 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.
        Returns:
        true if modify attribute values should be logged, or false if not.
      • setIncludeModifyAttributeValues

        public void setIncludeModifyAttributeValues​(boolean includeModifyAttributeValues)
        Specifies whether log messages about modify requests should include the values of the attributes modified in the request. This property will only be used if includeModifyAttributeNames returns true. Values for attributes named in the set returned by the getAttributesToRedact() method will be replaced with a value of "[REDACTED]".
        Parameters:
        includeModifyAttributeValues - Indicates whether to include attribute values in modify request log messages.
      • includeSearchEntryAttributeNames

        public boolean includeSearchEntryAttributeNames()
        Indicates whether log messages about search result entries should include the names of the attributes in the returned entry. Entry attribute names (but not values) will be logged by default.
        Returns:
        true if search result entry attribute names should be logged, or false if not.
      • setIncludeSearchEntryAttributeNames

        public void setIncludeSearchEntryAttributeNames​(boolean includeSearchEntryAttributeNames)
        Specifies whether log messages about search result entries should include the names of the attributes in the returned entry.
        Parameters:
        includeSearchEntryAttributeNames - Indicates whether to include attribute names in search result entry log messages.
      • includeSearchEntryAttributeValues

        public boolean includeSearchEntryAttributeValues()
        Indicates whether log messages about search result entries should include the values of the attributes in the returned entry. This property will only be used if 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.
        Returns:
        true if search result entry attribute values should be logged, or false if not.
      • setIncludeSearchEntryAttributeValues

        public void setIncludeSearchEntryAttributeValues​(boolean includeSearchEntryAttributeValues)
        Specifies whether log messages about search result entries should include the values of the attributes in the returned entry. This property will only be used if includeSearchEntryAttributeNames returns true. Values for attributes named in the set returned by the getAttributesToRedact() method will be replaced with a value of "[REDACTED]".
        Parameters:
        includeSearchEntryAttributeValues - Indicates whether to include attribute values in search result entry log messages.
      • getAttributesToRedact

        @NotNull
        public 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. Values of the userPassword, authPassword, and unicodePWD attributes will be redacted by default.
        Returns:
        A set containing the names or OIDs of the attributes whose values should be redacted from log messages, or an empty set if no attribute values should be redacted.
      • setAttributesToRedact

        public void setAttributesToRedact​(@Nullable
                                          java.lang.String... attributesToRedact)
        Specifies the names or OIDs of the attributes whose values should be redacted from log messages.
        Parameters:
        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.
      • setAttributesToRedact

        public void setAttributesToRedact​(@Nullable
                                          java.util.Collection<java.lang.String> attributesToRedact)
        Specifies the names or OIDs of the attributes whose values should be redacted from log messages.
        Parameters:
        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.
      • includeControlOIDs

        public boolean includeControlOIDs()
        Indicates whether request and result log messages should include the OIDs of any controls included in that request or result. Control OIDs will be logged by default.
        Returns:
        true if request control OIDs should be logged, or false if not.
      • setIncludeControlOIDs

        public void setIncludeControlOIDs​(boolean includeControlOIDs)
        Specifies whether request and result log messages should include the OIDs of any controls included in that request or result.
        Parameters:
        includeControlOIDs - Indicates whether to include control OIDs in request and result log messages.
      • flushAfterConnectMessages

        public boolean flushAfterConnectMessages()
        Indicates whether the log handler should be flushed after logging each successful or failed connection attempt. By default, the handler will be flushed after logging each connection attempt.
        Returns:
        true if the log handler should be flushed after logging each connection attempt, or false if not.
      • setFlushAfterConnectMessages

        public void setFlushAfterConnectMessages​(boolean flushAfterConnectMessages)
        Specifies whether the log handler should be flushed after logging each successful or failed connection attempt.
        Parameters:
        flushAfterConnectMessages - Indicates whether the log handler should be flushed after logging each connection attempt.
      • flushAfterDisconnectMessages

        public boolean flushAfterDisconnectMessages()
        Indicates whether the log handler should be flushed after logging each disconnect. By default, the handler will be flushed after logging each disconnect.
        Returns:
        true if the log handler should be flushed after logging each disconnect, or false if not.
      • setFlushAfterDisconnectMessages

        public void setFlushAfterDisconnectMessages​(boolean flushAfterDisconnectMessages)
        Specifies whether the log handler should be flushed after logging each disconnect.
        Parameters:
        flushAfterDisconnectMessages - Indicates whether the log handler should be flushed after logging each disconnect.
      • flushAfterRequestMessages

        public boolean flushAfterRequestMessages()
        Indicates whether the log handler should be flushed after logging each request. By default, the handler will be flushed after logging each final result, but not after logging requests or non-final results.
        Returns:
        true if the log handler should be flushed after logging each request, or false if not.
      • setFlushAfterRequestMessages

        public void setFlushAfterRequestMessages​(boolean flushAfterRequestMessages)
        Specifies whether the log handler should be flushed after logging each request.
        Parameters:
        flushAfterRequestMessages - Indicates whether the log handler should be flushed after logging each request.
      • flushAfterNonFinalResultMessages

        public 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). By default, the handler will be flushed after logging each final result, but not after logging requests or non-final results.
        Returns:
        true if the log handler should be flushed after logging each non-final result, or false if not.
      • setFlushAfterNonFinalResultMessages

        public 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).
        Parameters:
        flushAfterNonFinalResultMessages - Indicates whether the log handler should be flushed after logging each non-final result.
      • flushAfterFinalResultMessages

        public boolean flushAfterFinalResultMessages()
        Indicates whether the log handler should be flushed after logging the final result for each operation. By default, the handler will be flushed after logging each final result, but not after logging requests or non-final results.
        Returns:
        true if the log handler should be flushed after logging each final result, or false if not.
      • setFlushAfterFinalResultMessages

        public void setFlushAfterFinalResultMessages​(boolean flushAfterFinalResultMessages)
        Specifies whether the log handler should be flushed after logging the final result for each operation.
        Parameters:
        flushAfterFinalResultMessages - Indicates whether the log handler should be flushed after logging each final result.
      • getSchema

        @Nullable
        public Schema getSchema()
        Retrieves the schema that will be used to identify alternate names and OIDs for attributes whose values should be redacted. The LDAP SDK's default standard schema will be used by default.
        Returns:
        The schema that will be used to identify alternate names and OIDs for attributes whose values should be redacted, or null if no schema should be used.
      • setSchema

        public void setSchema​(@Nullable
                              Schema schema)
        Specifies the schema that will be used to identify alternate names and OIDs for attributes whose values should be redacted.
        Parameters:
        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.
      • toString

        @NotNull
        public java.lang.String toString()
        Retrieves a string representation of this JSONLDAPConnectionLoggerProperties object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this JSONLDAPConnectionLoggerProperties object.
      • toString

        public void toString​(@NotNull
                             java.lang.StringBuilder buffer)
        Appends a string representation of this JSONLDAPConnectionLoggerProperties object to the provided buffer.
        Parameters:
        buffer - The buffer to which the information should be appended. It must not be null.