Apache log4cxx Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AbsoluteTimeDateFormatFormats a date in the format HH:mm:ss,SSS for example, "15:49:37,459"
ActionA file system action performed as part of a rollover event
AndFilterA filter that 'and's the results of any number of contained filters together
AppenderImplement this interface for your own strategies for outputting log statements
AppenderAttachableThis Interface is for attaching Appenders to objects
AppenderSkeletonImplementation base class for all appenders
AsyncAppenderThe AsyncAppender lets users log events asynchronously
BasicConfiguratorUse this class to quickly configure the package
BindExceptionSignals that an error occurred while attempting to bind a socket to a local address and port
BufferedOutputStreamAbstract class for writing to character streams
BufferedWriterWrites text to a character-output stream buffering requests to increase efficiency
ByteArrayInputStreamInputStream implemented on top of a byte array
ByteArrayOutputStreamOutputStream implemented on top of std::vector
ByteBufferA byte buffer
CharMessageBufferThis class is used by the LOG4CXX_INFO and similar macros to support insertion operators in the message parameter
CharsetDecoderAn abstract engine to transform a sequences of bytes in a specific charset into a LogString
CharsetEncoderAn engine to transform LogStrings into bytes for the specific character set
ClassNamePatternConverterFormats the class name of the site of the logging request
ClassNotFoundExceptionThrown when an application tries to load in a class through its string name but no definition for the class with the specified name could be found
ConditionThis class provides a means for one thread to suspend exception until notified by another thread to resume
ConfiguratorImplemented by classes capable of configuring log4j using a URL
ConnectExceptionSignals that an error occurred while attempting to connect a socket to a remote address and port
ConsoleAppenderConsoleAppender appends log events to stdout or stderr using a layout specified by the user
CyclicBufferCyclicBuffer is used by other appenders to hold instances of LoggingEvent for immediate or deferred display
DailyRollingFileAppenderDailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user chosen frequency
DatagramPacketThis class represents a datagram packet
DatagramSocketThis class represents a socket for sending and receiving datagram packets
DateSimple transcoder for converting between external char and wchar_t strings and internal strings
DateFormatDateFormat is an abstract class for date/time formatting patterned after java.text.DateFormat
DateLayoutThis abstract layout takes care of all the date related options and formatting work
DatePatternConverterConvert and format the event's date in a StringBuffer
DateTimeDateFormatFormats a date in the format dd MMM yyyy HH:mm:ss,SSS for example, "06 Nov 1994 15:49:37,459"
DefaultConfiguratorConfigures the repository from environmental settings and files
DenyAllFilterThis filter drops all logging events
DOMConfiguratorUse this class to initialize the log4cxx environment using a DOM tree
ErrorHandlerAppenders may delegate their error handling to ErrorHandlers
ExceptionThe class Exception and its subclasses indicate conditions that a reasonable application might want to catch
ExpressionFilterA filter supporting complex expressions - supports both infix and postfix expressions (infix expressions must first be converted to postfix prior to processing)
FallbackErrorHandlerThe FallbackErrorHandler implements the ErrorHandler interface such that a secondary appender may be specified
FileAn abstract representation of file and directory path names
FileAppenderFileAppender appends log events to a file
FileDatePatternConverterFormats an date by delegating to DatePatternConverter
FileInputStreamInputStream implemented on top of APR file IO
FileLocationPatternConverterReturn the event's line location information in a StringBuffer
FileOutputStreamOutputStream implemented on top of APR file IO
FileWatchdogCheck every now and then that a certain file has not changed
FilterUsers should extend this class to implement customized logging event filtering
FilterBasedTriggeringPolicyFilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current message against a set of filters
FixedWindowRollingPolicyWhen rolling over, FixedWindowRollingPolicy renames files according to a fixed window algorithm as described below
FormattingInfoModifies the output of a pattern converter for a specified minimum and maximum width and alignment
FullLocationPatternConverterFormat the event's line location information
HierarchyThis class is specialized in retrieving loggers by name and also maintaining the logger hierarchy
HierarchyEventListenerListen to events occuring within a Hierarchy
HTMLLayoutThis layout outputs events in a HTML table
IllegalArgumentExceptionThrown to indicate that a method has been passed an illegal or inappropriate argument
InputStreamAbstract class for reading from character streams
InputStreamReaderClass for reading from character streams
InstantiationExceptionThrown when an application tries to create an instance of a class using the newInstance method in class Class, but the specified class object cannot be instantiated because it is an interface or is an abstract class
IntegerPatternConverterFormats an integer
InterruptedIOExceptionSignals that an I/O operation has been interrupted
IOExceptionSignals that an I/O exception of some sort has occurred
ISO8601DateFormatFormats a date in the format yyyy-MM-dd HH:mm:ss,SSS for example "1999-11-27 15:49:37,459"
LayoutExtend this abstract class to create your own log layout format
LevelDefines the minimum set of levels recognized by the system, that is OFF, FATAL, ERROR, WARN, INFO, DEBUG and ALL
LevelMatchFilterThis is a very simple filter based on level matching
LevelPatternConverterReturn the event's level in a StringBuffer
LevelRangeFilterThis is a very simple filter based on level matching, which can be used to reject messages with priorities outside a certain range
LineLocationPatternConverterFormat the event's line location information
LineSeparatorPatternConverterFormats a line separator
LiteralPatternConverterFormats a string literal
LocationInfoThis class represents the location of a logging statement
LocationInfoFilterLocation information is usually specified at the appender level - all events associated with an appender either create and parse stack traces or they do not
LoggerThis is the central class in the log4cxx package
LoggerFactoryImplement this interface to create new instances of Logger or a sub-class of Logger
LoggerPatternConverterFormats a logger name
LoggerRepositoryA LoggerRepository is used to create and retrieve Loggers
LoggingEventThe internal representation of logging events
LoggingEventPatternConverterLoggingEventPatternConverter is a base class for pattern converters that can format information from instances of LoggingEvent
LogLogThis class used to output log statements from within the log4cxx package
LogManagerUse the LogManager class to retreive Logger instances or to operate on the current LoggerRepository
logstreamAn STL-like stream API for log4cxx using char as the character type
logstream_baseBase class for the basic_logstream template which attempts to emulate std::basic_ostream but attempts to short-circuit unnecessary operations
ManualTriggeringPolicyManualTriggeringPolicy only rolls over on explicit calls to RollingFileAppender.rollover()
MDCSimilar to the NDC class except that it is based on a map instead of a stack
MessageBufferThis class is used by the LOG4CXX_INFO and similar macros to support insertion operators in the message parameter
MessagePatternConverterFormats the message of an logging event
MethodLocationPatternConverterReturn the event's line location information in a StringBuffer
NameAbbreviatorNameAbbreviator generates abbreviated logger and class names
NamePatternConverterBase class for other pattern converters which can return only parts of their name
NDCNdc class implements nested diagnostic contexts as defined by neil harrison in the article "patterns for logging diagnostic messages" part of the book "pattern languages of program design 3" edited by martin et al
NDCPatternConverterReturn the event's NDC in a StringBuffer
NTEventLogAppenderAppends log events to NT EventLog
NullPointerExceptionThrown when an application attempts to use null in a case where an object is required
ObjectBase class for java-like objects
ObjectImplImplementation class for Object
ObjectOutputStreamEmulates java serialization
ObjectPtrTSmart pointer to a Object descendant
OnlyOnceErrorHandlerThe OnlyOnceErrorHandler implements log4cxx's default error handling policy which consists of emitting a message for the first error in an appender and ignoring all following errors
OptionConverterA convenience class to convert property values to specific types
OptionHandlerA string based interface to configure package components
OutputStreamAbstract class for writing to character streams
OutputStreamWriterAbstract class for writing to character streams
PatternLayoutA flexible layout configurable with pattern string
PatternParserMost of the work of the PatternLayout class is delegated to the PatternParser class
PropertiesPatternConverterAble to handle the contents of the LoggingEvent's Property bundle and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the property bundle when this pattern converter has the option set
PropertyConfiguratorAllows the configuration of log4cxx from an external file
PropertyFilterNOTE: This filter modifies logging events by adding properties to the event
PropertyResourceBundlePropertyResourceBundle is a concrete subclass of ResourceBundle that manages resources for a locale using a set of static strings from a property file
PropertySetterGeneral purpose Object property setter
ReaderAbstract class for reading from character streams
RelativeTimeDateFormatFormats a date by printing the number of seconds elapsed since the start of the application
RelativeTimePatternConverterFormat the relative time in milliseconds
RepositorySelectorThe LogManager uses one (and only one) RepositorySelector implementation to select the LoggerRepository for a particular application context
ResourceBundleResource bundles contain locale-specific objects
RollingFileAppenderRollingFileAppender extends log4cxx::FileAppender to backup the log files depending on RollingPolicy and TriggeringPolicy
RollingFileAppenderRollingFileAppender extends FileAppender to backup the log files when they reach a certain size
RollingFileAppenderSkeletonBase class for log4cxx::rolling::RollingFileAppender and log4cxx::RollingFileAppender (analogues of org.apache.log4j.rolling.RFA from extras companion and org.apache.log4j.RFA from log4j 1.2, respectively)
RollingPolicyA RollingPolicy is responsible for performing the rolling over of the active log file
RollingPolicyBaseImplements methods common to most, it not all, rolling policies
RootLoggerRootLogger sits at the top of the logger hierachy
RuntimeExceptionRuntimeException is the parent class of those exceptions that can be thrown during the normal operation of the process
SimpleDateFormatConcrete class for formatting and parsing dates in a locale-sensitive manner
SimpleLayoutSimpleLayout consists of the level of the log statement, followed by " - " and then the log message itself
SizeBasedTriggeringPolicySizeBasedTriggeringPolicy looks at size of the file being currently written to
SMTPAppenderSend an e-mail when a specific logging event occurs, typically on errors or fatal errors
SocketAppenderSends LoggingEvent objects to a remote a log server, usually Apache Chainsaw
SocketAppenderSkeletonAbstract base class for SocketAppender and XMLSocketAppender
SocketExceptionThrown to indicate that there is an error in the underlying protocol, such as a TCP error
SocketHubAppenderSends LoggingEvent objects to a set of remote log servers, usually a SocketNode
SocketTimeoutExceptionSignals that an I/O operation has been interrupted
StrftimeDateFormatConcrete class for formatting and parsing dates in a locale-sensitive manner
StrictMathThe class StrictMath contains methods for performing basic numeric operations
StringHelperString manipulation routines
StringMatchFilterThis is a very simple filter based on string matching
synchronizedUtility class for objects multi-thread synchronization
SyslogAppenderUse SyslogAppender to send log messages to a remote syslog daemon
SyslogWriterSyslogWriter is a wrapper around the DatagramSocket class it writes text to the specified host on the port 514 (UNIX syslog)
SystemSeveral useful class fields and methods
SystemErrWriterAbstract class for writing to character streams
SystemOutWriterAbstract class for writing to character streams
ThreadThis class implements an approximation of java.util.Thread
ThreadLocalThis class provides thread-local variables
ThreadPatternConverterFormats the event thread name
ThreadSpecificDataThis class contains all the thread-specific data in use by log4cxx
ThrowableInformationPatternConverterOutputs the ThrowableInformation portion of the LoggingiEvent as a full stacktrace unless this converter's option is 'short', where it just outputs the first line of the trace
TimeBasedRollingPolicyTimeBasedRollingPolicy is both easy to configure and quite powerful
TranscoderSimple transcoder for converting between external char and wchar_t strings and internal strings
TransformUtility class for transforming strings
TriggeringEventEvaluatorImplementions of this interface allow certain appenders to decide when to perform an appender specific action
TriggeringPolicyA TriggeringPolicy controls the conditions under which rollover occurs
TTCCLayoutTTCC layout format consists of time, thread, logger name and nested diagnostic context information, hence the name
ulogstreamAn STL-like stream API for log4cxx using UniChar as the character type
UniCharMessageBufferThis class is designed to support insertion operations in the message argument to the LOG4CXX_INFO and similar macros and is not designed for general purpose use
WideMessageBufferThis class is designed to support insertion operations in the message argument to the LOG4CXX_INFO and similar macros and is not designed for general purpose use
wlogstreamAn STL-like stream API for log4cxx using wchar_t as the character type
WriterAbstract class for writing to character streams
WriterAppenderWriterAppender appends log events to a standard output stream
XMLDOMDocumentThe XMLDOMDocument interface represents an entire XML document
XMLDOMElementThe XMLDOMElement interface represents an element in an XML document
XMLDOMNodeThe XMLDOMNode interface is the primary datatype for the entire Document Object Model
XMLDOMNodeListThe XMLDOMNodeList interface provides the abstraction of an ordered collection of nodes, without defining or constraining how this collection is implemented
XMLLayoutThe output of the XMLLayout consists of a series of log4j:event elements
XMLSocketAppenderSends LoggingEvent objects in XML format to a remote a log server, usually a XMLSocketNode