@PublicAPI(stability=PRIVATE)

Package org.opends.server.loggers

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

See: Description

Interface Summary

Interface	Description
CommonAudit.HttpLogger	Represents a ForgeRock common audit based logger which can be used to log HTTP access audit events.
HTTPRequestInfo	Contains the information required for logging the HTTP request.
LogPublisher<T extends LogPublisherCfg>	This class defines the set of methods and structures that must be implemented for a Directory Server log publisher.
RetentionPolicy<T extends LogRetentionPolicyCfg>	This interface describes the retention policy that should be used for the logger.
RotatableLogFile	Represents a file that can be rotated based on size or on time.
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

Class	Description
AbstractLogger<P extends LogPublisher<C>,C extends LogPublisherCfg>	This class defines the wrapper that will invoke all registered loggers for each type of request received or response sent.
AccessLogger	This class defines the wrapper that will invoke all registered access loggers for each type of request received or response sent.
AccessLogPublisher<T extends AccessLogPublisherCfg>	This class defines the set of methods and structures that must be implemented for a Directory Server access log publisher.
CommonAudit	Entry point for the common audit facility.
ConsoleDebugLogPublisher	The debug log publisher implementation that writes debug messages in a friendly for console output.
DebugLogger	A logger for debug and trace logging.
DebugLogPublisher<T extends DebugLogPublisherCfg>	This class defines the set of methods and structures that must be implemented for a Directory Server debug log publisher.
DebugTracer	Class for source-code tracing at the method level.
ErrorLogger	This class defines the wrapper that will invoke all registered error loggers for each type of request received or response sent.
ErrorLogPublisher<T extends ErrorLogPublisherCfg>	This class defines the set of methods and structures that must be implemented for a Directory Server error log publisher.
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.
HTTPAccessLogger	This class defines the wrapper that will invoke all registered HTTP access loggers for each type of request received or response sent.
HTTPAccessLogPublisher<T extends HttpAccessLogPublisherCfg>	This class defines the set of methods and structures that must be implemented for a Directory Server HTTP access log publisher.
MeteredStream	A metered stream is a subclass of OutputStream that (a) forwards all its output to a target stream (b) keeps track of how many bytes have been written.
ReactiveFilterAccessLog	Implements Access Logging as a Reactive Filter.
ServerLoggingCategoryNames	Provides mapping from opendj server class names to simple category names used for logging.
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.
TextDebugLogPublisher	The debug log publisher implementation that writes debug messages to files on disk.
TextErrorLogPublisher	This class provides an implementation of an error log publisher.
TextHTTPAccessLogPublisher	This class provides the implementation of the HTTP access logger used by the directory server.
TextWriter.STDERR	A TextWriter implementation which writes to standard error.
TextWriter.STDOUT	A TextWriter implementation which 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.
TraceSettings	This class encapsulates the trace settings in effect at a given tracing scope.

Package org.opends.server.loggers Description

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