@PublicAPI(stability=PRIVATE)

Package org.opends.server.loggers

Contains implementations of Directory Server access, error, and debug loggers.

See:
          Description

Interface Summary
FileNamingPolicy A FileNamingPolicy is used by a MultiFileWriter to generate the sequence of file names to use when writing.
LoggerAlarmHandler This interface describes the handler that is invoked when the logger thread generates an alarm based on a rotation policy condition being met.
PostRotationAction This interface describes the action that needs to be taken at the time of a rotation.
RetentionPolicy<T extends LogRetentionPolicyCfg> This interface describes the retention policy that should be used for the logger.
RotationPolicy<T extends LogRotationPolicyCfg> This interface describes the rotation policy that should be used for the logger.
TextWriter A TextWriter provides a character-based stream used by a Text Publishers as a target for outputting log records.
 

Class Summary
AccessLogger This class defines the wrapper that will invoke all registered access loggers for each type of request received or response sent.
AsyncronousTextWriter A Text Writer which writes log records asynchronously to character-based stream.
EncryptAction This class implements a post rotation action that encrypts the log file.
ErrorLogger This class defines the wrapper that will invoke all registered error loggers for each type of request received or response sent.
FileComparator This class implements a comparator that can compare two files based on the time that they were last modified.
FileNumberRetentionPolicy This class implements a retention policy based on the number of files.
FixedTimeRotationPolicy This class implements a rotation policy based on fixed day/time of day.
FreeDiskSpaceRetentionPolicy This class implements a retention policy based on the free disk space available expressed as a percentage.
GZIPAction This class implements a post rotation action that compresses the file using GZIP compression.
LogCategory The category class defines a set of standard logging types that can be used to control logging output.
LogFileFilter This class defines a filename filter that will be used for log files.
LogLevel The Level class defines a set of standard logging levels that can be used to control logging output.
LogPublisherErrorHandler A LogPublisherErrorHandler is used for notification of exceptions which occur during the publishing of a record.
MultifileTextWriter A MultiFileTextWriter is a specialized TextWriter which supports publishing log records to a set of files.
RotationActionThread This thread is spawned off at the time of file rotation to execute specific actions such as compression, encryption, and signing of the log files.
SignatureAction This class implements a post rotation action that signs the file.
SizeBasedRetentionPolicy This class implements a retention policy based on the amount of space taken by the log files.
SizeBasedRotationPolicy This class implements a rotation policy based on the size of the file.
TextAccessLogPublisher This class provides the implementation of the access logger used by the directory server.
TextAuditLogPublisher This class provides the implementation of the audit logger used by the directory server.
TextErrorLogPublisher This class provides an implementation of an error log publisher.
TextWriter.STDERR A TextWriter implementation which writes to standard error.
TextWriter.STDOUT A TextWriter implementationwhich writes to standard out.
TextWriter.STREAM A TextWriter implementation which writes to a given output stream.
ThreadFilterTextErrorLogPublisher This class provides an implementation of an error logger where only messages generated by a specified thread is actually logged.
TimeLimitRotationPolicy This class implements a fixed time based rotation policy.
TimeStampNaming A file name policy that names files suffixed by the time it was created.
ZIPAction This class implements a post rotation action that compresses the file using ZIP compression.
 

Enum Summary
ActionType This enumeration defines the post rotation actions possible.
 

Package org.opends.server.loggers Description

Contains implementations of Directory Server access, error, and debug loggers. This includes classes with static methods that should be used to trigger the generation of log messages, as well as actual implementations that can write the log contents to various targets.