All Classes and Interfaces
Class
Description
An abstract implementation of the ComponentTracker interface.
Base implementation of
Discriminator that provides basic lifecycle
managementThis is the super class for module specific ServerSocketAppender
implementations can derive from.
An abstract base for module specific
SocketAppender implementations
in other logback modules.An abstract base for module specific
SSLSocketAppender
implementations located in other logback modules.Most of the work for configuring logback is done by Actions.
By throwing an exception an action can signal the Interpreter to skip
processing of all the nested (child) elements of the element associated with
the action causing the exception.
Various utility methods for computing the
AggregationType of a given property or
the class name of a property given implicit rules.AggregationType classifies how one object is contained within another object.
This implementation is intended for use in
FileNamePattern.Contract for components responsible for delivering logging events to their
final destination (console, file, remote server, etc.).
Interface for attaching appenders to objects.
A
COWArrayList based implementation of the AppenderAttachable
interface.Sets a skeleton implementation for appenders.
Created with IntelliJ IDEA.
Builds new appenders dynamically by running SiftingJoranConfigurator instance,
a custom configurator tailored for the contents of the sift element.
Track appenders by key.
Given a date remove older archived log files.
This appender and derived classes, log events asynchronously.
Automatically flushes the underlying
ObjectOutputStream
immediately after calling it's
ObjectOutputStream.writeObject(Object) method.A very simple
SequenceNumberGenerator based on an AtomicLong
variable.Lightweight pendant to the java.beans.BeanInfo class.
Cache for
BeanDescription instances.Encapsulates creation of
BeanDescription instances.Encapsulates utility methods associated with standard java beans.
Encloses a given set of converter output in black using the appropriate ANSI
escape codes.
Encloses a given set of converter output in blue using the appropriate ANSI
escape codes.
Encloses a given set of converter output in bold blue using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold cyan using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold green using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold magenta using the
appropriate ANSI escape codes.
Encloses a given set of converter output in bold red using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold white using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold yellow using the appropriate
ANSI escape codes.
A CAS implementation of DateTimeFormatter (previously SimpleDateFormat) which
caches results for the duration of a millisecond.
A client of a
ServerRunner.A visitor for a
Client.Static utility method for
Closeable objects.Abstract representation of configuration elements which have class names and are instantiated.
Interface for tracking various components by key.
This interface was introduced in order to support for pluggable
compression methods.
The
Compression class implements ZIP and GZ file
compression/decompression methods.A concurrent
ServerRunner.A condition evaluated during Joran conditional processing.
An
SSLServerSocketFactory that configures SSL parameters (those
specified in SSLParametersConfiguration) on each newly created socket.An
SSLSocketFactory that configures SSL parameters (those covered by
SSLParameters) on each newly created socket.This class configuration events which can be of various types such as
CHANGE_DETECTED, CONFIGURATION_STARTED and CONFIGURATION_ENDED.
A listener of
configuration events.This class manages the list of files and/or urls that are watched for changes.
A thin layer on top of
ConfigurationWatchList.ConsoleAppender appends log events to
System.out or
System.err using a layout specified by the user.The set of console output targets.
Various utility methods for processing strings representing context types.
A context is the main anchorage point of all logback components.
An object which has a context and add methods for updating internal status
messages.
A helper class that implements ContextAware methods.
A helper class that implements ContextAware methods.
An interface extending both
PropertyContainer and ContextAwareA minimal converter which sets up the general interface for derived classes.
Implements the
Supplier interface in order to cater for legacy code using the class name
of a converter.A GC-free lock-free thread-safe implementation of the
List interface
for use cases where iterations over the list vastly out-number modifications
on the list.Encloses a given set of converter output in cyan using the appropriate ANSI
escape codes.
CyclicBuffer holds values in a cyclic array.
CyclicBufferAppender stores events in a cyclic buffer of user-specified size.
CyclicBufferTracker tracks
CyclicBuffer instances.This class is concerned with computing a regex corresponding to a date
pattern (in
SimpleDateFormat format).Returns a date formatted by SimpleDateFormatter.
This class serves as a gateway for invocations of a "costly" operation on a
critical execution path.
A registry which maps a property in a host class to a default class.
DefaultProcessor traverses the Model produced at an earlier step and performs actual
configuration of logback according to the handlers it was given.
ShutdownHook implementation that stops the Logback context after a
specified delay.
Default implementation of
SocketConnector.Default implementation of
TimeBasedFileNamingAndTriggeringPolicy
interface extending TimeBasedFileNamingAndTriggeringPolicyBase.Instantiate class for define property value.
Creates
DefineModel instance and populate its name, className and
scope.A strategy for computing a delay.
Defines the relation between a dependee (Model) and a dependency (String).
This is a utility class for writing json logs.
Implement this interface in order to compute a discriminating value for a
given event of type <E>.
Duration instances represent a lapse of time.
As the name suggests, a DynamicConverter performs a conversion based on the parameter E
given to the
method.
invalid reference
#convert(E)
Echos the incoming object adding a line separator character(s) at the end.
An element path characterizes a traversal path in an XML document.
ElementSelector extends
ElementPath with matching operations such as
ElementSelector.fullPathMatch(ElementPath),
ElementSelector.getPrefixMatchLength(ElementPath) and
ElementSelector.getTailMatchLength(ElementPath).Encoders are responsible for transform an incoming event into a byte array
This exception wraps exceptions thrown while evaluating events.
The value of the
AbstractMatcherFilter.onMatch and AbstractMatcherFilter.onMismatch attributes is set
to FilterReply.NEUTRAL, so that a badly configured evaluator filter
does not disturb the functioning of the filter chain.Evaluates whether a given an event matches user-specified criteria.
Static utility methods for manipulating an
ExecutorService.FileAppender appends log events to a file.
In conjunction with
PropertyAction
sets the named variable to "true" if the file specified by
path property exists, to "false" otherwise.After parsing file name patterns, given a number or a date, instances of this
class can be used to compute a file name according to the file name pattern
and the current date or integer.
Instances of this class represent the size of a file.
A utility class using functionality available since JDK 1.7.
Users should extend this class to implement customized event filtering.
Interface for attaching filters to objects.
Implementation of FilterAttachable.
This enum represents the possible replies that a filtering component in
logback can return.
A default
DelayStrategy that implements a simple fixed delay.When rolling over,
FixedWindowRollingPolicy renames files
according to a fixed window algorithm.Base class for all foreground color setting composite converters.
FormattingInfo instances contain the information obtained when parsing
formatting modifiers in conversion modifiers.
Encloses a given set of converter output in gray using the appropriate ANSI
escape codes.
Encloses a given set of converter output in green using the appropriate ANSI
escape codes.
HardenedObjectInputStream restricts the set of classes that can be
deserialized to a set of explicitly whitelisted classes.
A 2-tuple (a double) consisting of a Class and a String.
This class is a base class for HTMLLayout classes part of other logback
modules such as logback-classic and logback-access.
Lump together several fields for use by
ImcplicitActionDataForBasicProperty.Action dealing with elements corresponding to implicit rules.
Lump together several fields for use by implicit action and co.
Lump together several fields for use by
ImplicitModelHandler.Populates
ImportModel based on XML input.Build an
IncludeModel instance from SAX events.When asked to convert an integer,
IntegerTokenConverter the
string value of that integer.Allows masking of interrupt flag if previously the flag is already set.
Checks whether a named property is defined in the
context (e.g.
A simple utility class to create and use a JNDI Context.
A JoranConfiguratorBase lays most of the groundwork for concrete
configurators derived from it.
This class contains constants used by Joran components.
A factory bean for a JSSE
KeyManagerFactory.A factory bean for a JCA
KeyStore.Components supporting start/stop implement this interface.
An object that manages a collection of components that implement the
LifeCycle interface.Load resources (or images) from various sources.
A static utility method that converts a string that describes the location of
a resource into a
URL object.This class just makes it easier to identify locks associated with logback
when analysing thread dumps.
Used by SMTPAppender for authentication purposes.
Encloses a given set of converter output in magenta using the appropriate
ANSI escape codes.
Abstract representation of configuration elements
For a given DefaultProcessor instance link a
Model class to
a ModelHandler instance in logback-core.Converters which can deal only with one type should implement this interface.
If a type (a class) has this annotation, then it will not be automatically
started by Joran at configuration time.
Compiles a previously parsed Node chain into a String.
No operation (NOP) action that does strictly nothing.
A no-operation (nop) StatusListener
Writes objects to an output.
Factory for
ObjectWriter instances.Print all new incoming status messages on the console (System.out).
Print all new incoming status messages on the error console (System.err).
Print all new incoming status messages on the designated PrintStream.
OutputStreamAppender appends events to a
OutputStream.Each tuple represents the association of a parentTag, tag, and a className
which corresponds to default class name rules.
Parse a token list returning a node chain.
Implements this to perform post compile processing for a PatternLayout.
PreSerializationTransformer instances have the responsibility to transform
object into a presumably equivalent serializable representation.
An enumeration of processing phases.
This class serves to build a model for properties which are to the ANT
<property> task which add/set properties of a given object.
Interface for evaluating conditions based on properties during the conditional processing
of Logback configuration files.
Abstract base class provides some scaffolding.
A skeleton implementation for property definers so that they derive from
ContextAwareBase.Condition that evaluates to
true when a property
equals a specified expected value.Given a
PropertyModel offers methods to inject properties into a PropertyContainer.General purpose Object property setter.
Thrown when an error is encountered whilst attempting to set a property using
the
PropertySetter utility class.Factory for
Queue instances.An interface for monitoring new failures and recoveries related to
ResilientOutputStreamBase.Encloses a given set of converter output in red using the appropriate ANSI
escape codes.
Guard used to prevent re-entrant (recursive) appender invocations on a per-thread basis.
No-op implementation that never locks.
Default per-thread implementation backed by a
ThreadLocal<Boolean>.Factory that creates
ReentryGuard instances according to a requested type.Types of guards that can be produced by this factory.
This implementation is intended for use in PatternLayout.
Utility class to help solving problems encountered while renaming files.
An action which builds subclass instances of
ResourceModel.In conjunction with
PropertyAction
sets the named variable to "true" if the resource specified by the user is available on the class path, "false"
otherwise.This implementation is intended for use in PatternLayout.
RollingCalendar is a helper class to
TimeBasedRollingPolicy or similar
timed-based rolling policies.RollingFileAppender extends FileAppender to back up the
log files depending on RollingPolicy and TriggeringPolicy.A
RollingPolicy is responsible for performing the rolling over
of the active log file.Implements methods common to most, it not all, rolling policies.
A RolloverFailure occurs if, for whatever reason a rollover fails.
As its name indicates, a RuleStore contains 2-tuples consists of a
ElementSelector and an Action.
A runnable with 'done' and 'counter' fields.
Interface for sanity checking Models.
An InterpretationContext contains the contextual state of a Joran parsing
session.
SaxEventInterpreter is Joran's driving class for handling "low-level"
SAX events.A factory bean for a JCA
SecureRandom generator.Generate sequence numbers
Action which handles <sequenceNumberGenerator> elements in
configuration files.
A listener that accepts
Client connections on behalf of a
ServerRunner.An object that is responsible for the asynchronous execution of a socket
server.
A
ServerListener that accepts connections on a ServerSocket.Interface describing a logback shutdown hook implementation
Action which builds
ShutdownHookModel based on <shutdownHook>
elements found in configuration files.Base class for classes implementing a Logback ShutdownHook via extension
This appender serves as the base class for actual SiftingAppenders
implemented by the logback-classic and logback-access modules.
An invocation gate using very simple logic.
This class implements the
RuleStore interface.This class implement
TimeBasedFileNamingAndTriggeringPolicy
interface extending TimeBasedFileNamingAndTriggeringPolicyBase.SizeAndTimeBasedFNATP class was renamed as SizeAndTimeBasedFileNamingAndTriggeringPolicy
in version 1.5.8.SizeBasedTriggeringPolicy looks at size of the file being currently written
to.
An abstract class that provides support for sending events to an email
address.
A
Runnable that (re)connects a socket.An exception handler that is notified of all exceptions that occur during the
(re)connection process.
Various constants used by the SSL implementation.
An interface used to identify components that have an SSL configuration.
An object that has configurable SSL parameters.
An
SSLConfigurable wrapper for an SSLServerSocket.An
SSLConfigurable wrapper for an SSLSocket.A configuration for an
SSLContext.A factory bean for a JSSE
SSLContext.Nested component registry rules for
SSLConfiguration and its
components.A configuration of SSL parameters for an
SSLEngine.This is the base class for module specific ServerSocketAppender
implementations.
A StatusListener registered with logback context's
StatusManager will
receive notification of every incoming status message.Collect all incoming events in a list.
Internal error messages (statii) are managed by instances of this interface.
Deprecated.
Same as StatusPrinter but with instance methods instead of static.
Static utility methods for working with collections of strings.
Utility class which can convert string into objects.
Base class for SyslogAppender.
Constants used by syslog daemon and transitively by
SyslogAppenderBase.SyslogOutputStream is a wrapper around the
DatagramSocket class so
that it behaves like an OutputStream.This stream writes its output to the target PrintStream supplied to its
constructor.
This interface lists the set of methods that need to be implemented by
triggering policies which are nested within a
TimeBasedRollingPolicy.Base implementation of
TimeBasedFileNamingAndTriggeringPolicy.TimeBasedRollingPolicy is both easy to configure and quite
powerful.Given a key and a date-and-time pattern, puts a property to the context, with
the specified key and value equal to the current time in the format
corresponding to the specified date-and-time pattern.
TokenConverter offers some basic functionality used by more
specific token converters.Utility class for transforming strings.
A
TriggeringPolicy controls the conditions under which roll-over
occurs.SizeBasedTriggeringPolicy looks at size of the file being currently written
to.
A factory bean for a JSSE
TrustManagerFactory.Similar to
AppenderBase except that derived appenders need to handle thread
synchronization on their own.Helper methods to deal with properties.
Encloses a given set of converter output in white using the appropriate ANSI
escape codes.
Compresses files using
library.
invalid reference
xz
Encloses a given set of converter output in yellow using the appropriate ANSI
escape codes.
Compresses files using JDK's Zip compression algorithm.
StatusPrinter2