Log4j Version 1.2.14: Index

Log4j 1.2

Log4j 1.2.14
A B C D E F G H I J L M N O P Q R S T V W X _

A

ABS_TIME_DATE_FORMAT - Static variable in class org.apache.log4j.helpers.AbsoluteTimeDateFormat
String constant used to specify AbsoluteTimeDateFormat in layouts.
AbsoluteTimeDateFormat - class org.apache.log4j.helpers.AbsoluteTimeDateFormat.
Formats a Date in the format "HH:mm:ss,SSS" for example, "15:49:37,459".
AbsoluteTimeDateFormat() - Constructor for class org.apache.log4j.helpers.AbsoluteTimeDateFormat
 
AbsoluteTimeDateFormat(TimeZone) - Constructor for class org.apache.log4j.helpers.AbsoluteTimeDateFormat
 
AbstractDynamicMBean - class org.apache.log4j.jmx.AbstractDynamicMBean.
 
AbstractDynamicMBean() - Constructor for class org.apache.log4j.jmx.AbstractDynamicMBean
 
ACCEPT - Static variable in class org.apache.log4j.spi.Filter
The log event must be logged immediately without consulting with the remaining filters, if any, in the chain.
ACCEPT_ON_MATCH_OPTION - Static variable in class org.apache.log4j.varia.StringMatchFilter
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
activate() - Method in class org.apache.log4j.config.PropertySetter
 
activateOptions() - Method in class org.apache.log4j.SimpleLayout
 
activateOptions() - Method in class org.apache.log4j.PatternLayout
Does not do anything as options become effective
activateOptions() - Method in class org.apache.log4j.HTMLLayout
No options to activate.
activateOptions() - Method in class org.apache.log4j.AppenderSkeleton
Derived appenders should override this method if option structure requires it.
activateOptions() - Method in class org.apache.log4j.WriterAppender
Does nothing.
activateOptions() - Method in class org.apache.log4j.FileAppender
If the value of File is not null, then FileAppender.setFile(java.lang.String) is called with the values of File and Append properties.
activateOptions() - Method in class org.apache.log4j.ConsoleAppender
Prepares the appender for use.
activateOptions() - Method in class org.apache.log4j.DailyRollingFileAppender
 
activateOptions() - Method in class org.apache.log4j.helpers.DateLayout
 
activateOptions() - Method in class org.apache.log4j.helpers.OnlyOnceErrorHandler
No options to activate.
activateOptions() - Method in class org.apache.log4j.net.SocketHubAppender
Set up the socket server on the specified port.
activateOptions() - Method in class org.apache.log4j.net.SyslogAppender
This method returns immediately as options are activated when they are set.
activateOptions() - Method in class org.apache.log4j.net.SMTPAppender
Activate the specified options, such as the smtp host, the recipient, from, etc.
activateOptions() - Method in class org.apache.log4j.net.JMSAppender
Options are activated and become effective only after calling this method.
activateOptions() - Method in class org.apache.log4j.net.TelnetAppender
all of the options have been set, create the socket handler and wait for connections.
activateOptions() - Method in class org.apache.log4j.net.SocketAppender
Connect to the specified RemoteHost and Port.
activateOptions() - Method in class org.apache.log4j.nt.NTEventLogAppender
 
activateOptions() - Method in class org.apache.log4j.spi.Filter
Usually filters options become active when set.
activateOptions() - Method in interface org.apache.log4j.spi.OptionHandler
Activate the options that were previously set with calls to option setters.
activateOptions() - Method in class org.apache.log4j.varia.NullAppender
There are no options to acticate.
activateOptions() - Method in class org.apache.log4j.varia.ExternallyRolledFileAppender
Start listening on the port specified by a preceding call to ExternallyRolledFileAppender.setPort(int).
activateOptions() - Method in class org.apache.log4j.varia.FallbackErrorHandler
No options to activate.
activateOptions() - Method in class org.apache.log4j.xml.XMLLayout
No options to activate.
add(LoggingEvent) - Method in class org.apache.log4j.helpers.CyclicBuffer
Add an event as the last event in the buffer.
addAppender(Appender) - Method in class org.apache.log4j.Category
Add newAppender to the list of appenders of this Category instance.
addAppender(Appender) - Method in class org.apache.log4j.AsyncAppender
Add appender.
addAppender(Appender) - Method in class org.apache.log4j.helpers.AppenderAttachableImpl
Attach an appender.
addAppender(Appender) - Method in interface org.apache.log4j.spi.AppenderAttachable
Add an appender.
addAppenderEvent(Category, Appender) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
addAppenderEvent(Category, Appender) - Method in interface org.apache.log4j.spi.HierarchyEventListener
 
addConverter(PatternConverter) - Method in class org.apache.log4j.helpers.PatternParser
 
addFilter(Filter) - Method in class org.apache.log4j.AppenderSkeleton
Add a filter to end of the filter list.
addFilter(Filter) - Method in interface org.apache.log4j.Appender
Add a filter to the end of the filter list.
addHierarchyEventListener(HierarchyEventListener) - Method in class org.apache.log4j.Hierarchy
 
addHierarchyEventListener(HierarchyEventListener) - Method in interface org.apache.log4j.spi.LoggerRepository
Add a HierarchyEventListener event to the repository.
additive - Variable in class org.apache.log4j.Category
Additivity is set to true by default, that is children inherit the appenders of their ancestors by default.
addLoggerMBean(String) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
addNotificationListener(NotificationListener, NotificationFilter, Object) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
addRenderer(Class, ObjectRenderer) - Method in class org.apache.log4j.Hierarchy
Add an object renderer for a specific class.
addRenderer(RendererSupport, String, String) - Static method in class org.apache.log4j.or.RendererMap
Add a renderer to a hierarchy passed as parameter.
ADDRESS_PARSE_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
 
addressMessage(Message) - Method in class org.apache.log4j.net.SMTPAppender
Address message.
Agent - class org.apache.log4j.jmx.Agent.
 
Agent() - Constructor for class org.apache.log4j.jmx.Agent
 
ALL - Static variable in class org.apache.log4j.Level
The ALL has the lowest possible rank and is intended to turn on all logging.
ALL_INT - Static variable in class org.apache.log4j.Priority
 
append(LoggingEvent) - Method in class org.apache.log4j.AppenderSkeleton
Subclasses of AppenderSkeleton should implement this method to perform actual logging.
append(LoggingEvent) - Method in class org.apache.log4j.WriterAppender
This method is called by the AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent) method.
append(LoggingEvent) - Method in class org.apache.log4j.AsyncAppender
{@inheritDoc}
append(LoggingEvent) - Method in class org.apache.log4j.jdbc.JDBCAppender
Adds the event to the buffer.
append(LoggingEvent) - Method in class org.apache.log4j.lf5.LF5Appender
Appends a LoggingEvent record to the LF5Appender.
append(LoggingEvent) - Method in class org.apache.log4j.net.SocketHubAppender
Append an event to all of current connections.
append(LoggingEvent) - Method in class org.apache.log4j.net.SyslogAppender
 
append(LoggingEvent) - Method in class org.apache.log4j.net.SMTPAppender
Perform SMTPAppender specific appending actions, mainly adding the event to a cyclic buffer and checking if the event triggers an e-mail to be sent.
append(LoggingEvent) - Method in class org.apache.log4j.net.JMSAppender
This method called by AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent) method to do most of the real appending work.
append(LoggingEvent) - Method in class org.apache.log4j.net.TelnetAppender
Handles a log event.
append(LoggingEvent) - Method in class org.apache.log4j.net.SocketAppender
 
append(LoggingEvent) - Method in class org.apache.log4j.nt.NTEventLogAppender
 
append(LoggingEvent) - Method in class org.apache.log4j.performance.NullAppender
 
append(LoggingEvent) - Method in class org.apache.log4j.varia.NullAppender
Does not do anything.
Appender - interface org.apache.log4j.Appender.
Implement this interface for your own strategies for outputting log statements.
AppenderAttachable - interface org.apache.log4j.spi.AppenderAttachable.
Interface for attaching appenders to objects.
AppenderAttachableImpl - class org.apache.log4j.helpers.AppenderAttachableImpl.
A straightforward implementation of the AppenderAttachable interface.
AppenderAttachableImpl() - Constructor for class org.apache.log4j.helpers.AppenderAttachableImpl
 
AppenderDynamicMBean - class org.apache.log4j.jmx.AppenderDynamicMBean.
 
AppenderDynamicMBean(Appender) - Constructor for class org.apache.log4j.jmx.AppenderDynamicMBean
 
AppenderFinalizer - class org.apache.log4j.lf5.AppenderFinalizer.
AppenderFinalizer has a single method that will finalize resources associated with a LogBrokerMonitor in the event that the LF5Appender class is destroyed, and the class loader is garbage collected.
AppenderFinalizer(LogBrokerMonitor) - Constructor for class org.apache.log4j.lf5.AppenderFinalizer
 
appenderList - Variable in class org.apache.log4j.helpers.AppenderAttachableImpl
Array of appenders.
appenderNames - Variable in class org.apache.log4j.config.PropertyPrinter
 
AppenderSkeleton - class org.apache.log4j.AppenderSkeleton.
Abstract superclass of the other appenders in the package.
AppenderSkeleton() - Constructor for class org.apache.log4j.AppenderSkeleton
 
appendEscapingCDATA(StringBuffer, String) - Static method in class org.apache.log4j.helpers.Transform
Ensures that embeded CDEnd strings (]]>) are handled properly within message, NDC and throwable tag text.
appendLoopOnAppenders(LoggingEvent) - Method in class org.apache.log4j.helpers.AppenderAttachableImpl
Call the doAppend method on all attached appenders.
assertLog(boolean, String) - Method in class org.apache.log4j.Category
If assertion parameter is false, then logs msg as an error statement.
AsyncAppender - class org.apache.log4j.AsyncAppender.
The AsyncAppender lets users log events asynchronously.
AsyncAppender() - Constructor for class org.apache.log4j.AsyncAppender
Create new instance.
AttributesRenderer - class org.apache.log4j.or.sax.AttributesRenderer.
Render org.xml.sax.Attributes objects.
AttributesRenderer() - Constructor for class org.apache.log4j.or.sax.AttributesRenderer
 

B

BasicConfigurator - class org.apache.log4j.BasicConfigurator.
Use this class to quickly configure the package.
BasicConfigurator() - Constructor for class org.apache.log4j.BasicConfigurator
 
BoundedFIFO - class org.apache.log4j.helpers.BoundedFIFO.
BoundedFIFO serves as the bounded first-in-first-out buffer heavily used by the AsyncAppender.
BoundedFIFO(int) - Constructor for class org.apache.log4j.helpers.BoundedFIFO
Instantiate a new BoundedFIFO with a maximum size passed as argument.
buf - Variable in class org.apache.log4j.TTCCLayout
 
BUF_SIZE - Variable in class org.apache.log4j.PatternLayout
 
BUF_SIZE - Variable in class org.apache.log4j.HTMLLayout
 
buffer - Variable in class org.apache.log4j.jdbc.JDBCAppender
ArrayList holding the buffer of Logging Events.
bufferedIO - Variable in class org.apache.log4j.FileAppender
Do we do bufferedIO?
bufferSize - Variable in class org.apache.log4j.FileAppender
Determines the size of IO buffer be.
bufferSize - Variable in class org.apache.log4j.jdbc.JDBCAppender
size of LoggingEvent buffer before writting to the database.

C

callAppenders(LoggingEvent) - Method in class org.apache.log4j.Category
Call the appenders in the hierrachy starting at this.
capitalize(String) - Static method in class org.apache.log4j.config.PropertyPrinter
 
Category - class org.apache.log4j.Category.
This class has been deprecated and replaced by the Logger subclass.
Category(String) - Constructor for class org.apache.log4j.Category
This constructor created a new Category instance and sets its name.
categoryName - Variable in class org.apache.log4j.spi.LoggingEvent
Deprecated. This field will be marked as private in future releases. Please do not access it directly. Use the LoggingEvent.getLoggerName() method instead.
cb - Variable in class org.apache.log4j.net.SMTPAppender
 
checkAndConfigure() - Method in class org.apache.log4j.helpers.FileWatchdog
 
checkEntryConditions() - Method in class org.apache.log4j.WriterAppender
This method determines if there is a sense in attempting to append.
checkEntryConditions() - Method in class org.apache.log4j.net.SMTPAppender
This method determines if there is a sense in attempting to append.
checkEntryConditions() - Method in class org.apache.log4j.net.JMSAppender
 
childValue(Object) - Method in class org.apache.log4j.helpers.ThreadLocalMap
 
cleanUp() - Method in class org.apache.log4j.net.SocketHubAppender
Release the underlying ServerMonitor thread, and drop the connections to all connected remote servers.
cleanUp() - Method in class org.apache.log4j.net.SocketAppender
Drop the connection to the remote host and release the underlying connector thread if it has been created
clear() - Method in class org.apache.log4j.Hierarchy
This call will clear all logger definitions from the internal hashtable.
clear() - Static method in class org.apache.log4j.NDC
Clear any nested diagnostic information if any.
clear() - Method in class org.apache.log4j.or.RendererMap
 
clearFilters() - Method in class org.apache.log4j.AppenderSkeleton
Clear the filters chain.
clearFilters() - Method in interface org.apache.log4j.Appender
Clear the list of filters by removing all the filters in it.
cloneStack() - Static method in class org.apache.log4j.NDC
Clone the diagnostic context for the current thread.
CLOSE_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
 
close() - Method in class org.apache.log4j.WriterAppender
Close this appender instance.
close() - Method in interface org.apache.log4j.Appender
Release any resources allocated within the appender such as file handles, network connections, etc.
close() - Method in class org.apache.log4j.AsyncAppender
Close this AsyncAppender by interrupting the dispatcher thread which will process all pending events before exiting.
close() - Method in class org.apache.log4j.helpers.SyslogWriter
 
close() - Method in class org.apache.log4j.jdbc.JDBCAppender
Closes the appender, flushing the buffer first then closing the default connection if it is open.
close() - Method in class org.apache.log4j.lf5.LF5Appender
This method is an empty implementation of the close() method inherited from the org.apache.log4j.Appender interface.
close() - Method in class org.apache.log4j.net.SocketHubAppender
Close this appender.
close() - Method in class org.apache.log4j.net.SyslogAppender
Release any resources held by this SyslogAppender.
close() - Method in class org.apache.log4j.net.SMTPAppender
 
close() - Method in class org.apache.log4j.net.JMSAppender
Close this JMSAppender.
close() - Method in class org.apache.log4j.net.TelnetAppender
shuts down the appender.
close() - Method in class org.apache.log4j.net.SocketAppender
Close this appender.
close() - Method in class org.apache.log4j.nt.NTEventLogAppender
 
close() - Method in class org.apache.log4j.performance.NullAppender
 
close() - Method in class org.apache.log4j.performance.NOPWriter
 
close() - Method in class org.apache.log4j.varia.NullAppender
 
closeConnection(Connection) - Method in class org.apache.log4j.jdbc.JDBCAppender
Override this to return the connection to a pool, or to clean up the resource.
closed - Variable in class org.apache.log4j.AppenderSkeleton
Is this appender closed?
closeFile() - Method in class org.apache.log4j.FileAppender
Closes the previously opened file.
closeWriter() - Method in class org.apache.log4j.WriterAppender
Close the underlying Writer.
closeWriter() - Method in class org.apache.log4j.ConsoleAppender
{@inheritDoc}
concatanateArrays(String[], String[]) - Static method in class org.apache.log4j.helpers.OptionConverter
 
CONFIG - Static variable in class org.apache.log4j.lf5.LogLevel
 
CONFIG_DEBUG_KEY - Static variable in class org.apache.log4j.helpers.LogLog
Deprecated. Use LogLog.DEBUG_KEY instead.
Configurator - interface org.apache.log4j.spi.Configurator.
Implemented by classes capable of configuring log4j using a URL.
CONFIGURATOR_CLASS_KEY - Static variable in class org.apache.log4j.LogManager
Deprecated. This variable is for internal use only. It will become private in future versions.
configure() - Static method in class org.apache.log4j.BasicConfigurator
Add a ConsoleAppender that uses PatternLayout using the PatternLayout.TTCC_CONVERSION_PATTERN and prints to System.out to the root category.
configure() - Static method in class org.apache.log4j.lf5.DefaultLF5Configurator
This method configures the LF5Appender using a default configuration file.
configure(Appender) - Static method in class org.apache.log4j.BasicConfigurator
Add appender to the root category.
configure(Element) - Static method in class org.apache.log4j.xml.DOMConfigurator
Configure log4j using a configuration element as defined in the log4j.dtd.
configure(Properties) - Static method in class org.apache.log4j.PropertyConfigurator
Read configuration options from properties.
configure(String) - Static method in class org.apache.log4j.PropertyConfigurator
 
configure(String) - Static method in class org.apache.log4j.xml.DOMConfigurator
A static version of DOMConfigurator.doConfigure(String, LoggerRepository).
configure(URL) - Static method in class org.apache.log4j.PropertyConfigurator
Read configuration options from url configURL.
configure(URL) - Static method in class org.apache.log4j.xml.DOMConfigurator
A static version of DOMConfigurator.doConfigure(URL, LoggerRepository).
configureAndWatch(String) - Static method in class org.apache.log4j.PropertyConfigurator
Like PropertyConfigurator.configureAndWatch(String, long) except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.
configureAndWatch(String) - Static method in class org.apache.log4j.xml.DOMConfigurator
Like DOMConfigurator.configureAndWatch(String, long) except that the default delay as defined by FileWatchdog.DEFAULT_DELAY is used.
configureAndWatch(String, long) - Static method in class org.apache.log4j.PropertyConfigurator
Read the configuration file configFilename if it exists.
configureAndWatch(String, long) - Static method in class org.apache.log4j.xml.DOMConfigurator
Read the configuration file configFilename if it exists.
configureLoggerFactory(Properties) - Method in class org.apache.log4j.PropertyConfigurator
Check the provided Properties object for a LoggerFactory entry specified by PropertyConfigurator.LOGGER_FACTORY_KEY.
connection - Variable in class org.apache.log4j.jdbc.JDBCAppender
Connection used by default.
ConsoleAppender - class org.apache.log4j.ConsoleAppender.
ConsoleAppender appends log events to System.out or System.err using a layout specified by the user.
ConsoleAppender() - Constructor for class org.apache.log4j.ConsoleAppender
Constructs an unconfigured appender.
ConsoleAppender(Layout) - Constructor for class org.apache.log4j.ConsoleAppender
Creates a configured appender.
ConsoleAppender(Layout, String) - Constructor for class org.apache.log4j.ConsoleAppender
Creates a configured appender.
convert(LoggingEvent) - Method in class org.apache.log4j.helpers.PatternConverter
Derived pattern converters must override this method in order to convert conversion specifiers in the correct way.
convertArg(String, Class) - Method in class org.apache.log4j.config.PropertySetter
Convert val a String parameter to an object of a given type.
convertSpecialChars(String) - Static method in class org.apache.log4j.helpers.OptionConverter
 
count - Variable in class org.apache.log4j.helpers.CountingQuietWriter
 
CountingQuietWriter - class org.apache.log4j.helpers.CountingQuietWriter.
Counts the number of bytes written.
CountingQuietWriter(Writer, ErrorHandler) - Constructor for class org.apache.log4j.helpers.CountingQuietWriter
 
createPatternParser(String) - Method in class org.apache.log4j.PatternLayout
Returns PatternParser used to parse the conversion string.
createSession() - Method in class org.apache.log4j.net.SMTPAppender
Create mail session.
createWriter(OutputStream) - Method in class org.apache.log4j.WriterAppender
Returns an OutputStreamWriter when passed an OutputStream.
currentLiteral - Variable in class org.apache.log4j.helpers.PatternParser
 
CyclicBuffer - class org.apache.log4j.helpers.CyclicBuffer.
CyclicBuffer is used by other appenders to hold LoggingEvents for immediate or differed display.
CyclicBuffer(int) - Constructor for class org.apache.log4j.helpers.CyclicBuffer
Instantiate a new CyclicBuffer of at most maxSize events.

D

DailyRollingFileAppender - class org.apache.log4j.DailyRollingFileAppender.
DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user chosen frequency.
DailyRollingFileAppender() - Constructor for class org.apache.log4j.DailyRollingFileAppender
The default constructor does nothing.
DailyRollingFileAppender(Layout, String, String) - Constructor for class org.apache.log4j.DailyRollingFileAppender
Instantiate a DailyRollingFileAppender and open the file designated by filename.
databasePassword - Variable in class org.apache.log4j.jdbc.JDBCAppender
User to use for default connection handling
databaseURL - Variable in class org.apache.log4j.jdbc.JDBCAppender
URL of the DB for default connection handling
databaseUser - Variable in class org.apache.log4j.jdbc.JDBCAppender
User to connect as for default connection handling
date - Variable in class org.apache.log4j.helpers.DateLayout
 
DATE_AND_TIME_DATE_FORMAT - Static variable in class org.apache.log4j.helpers.AbsoluteTimeDateFormat
String constant used to specify DateTimeDateFormat in layouts.
DATE_FORMAT_OPTION - Static variable in class org.apache.log4j.helpers.DateLayout
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
dateFormat - Variable in class org.apache.log4j.helpers.DateLayout
 
dateFormat(StringBuffer, LoggingEvent) - Method in class org.apache.log4j.helpers.DateLayout
 
DateLayout - class org.apache.log4j.helpers.DateLayout.
This abstract layout takes care of all the date related options and formatting work.
DateLayout() - Constructor for class org.apache.log4j.helpers.DateLayout
 
DateTimeDateFormat - class org.apache.log4j.helpers.DateTimeDateFormat.
Formats a Date in the format "dd MMM yyyy HH:mm:ss,SSS" for example, "06 Nov 1994 15:49:37,459".
DateTimeDateFormat() - Constructor for class org.apache.log4j.helpers.DateTimeDateFormat
 
DateTimeDateFormat(TimeZone) - Constructor for class org.apache.log4j.helpers.DateTimeDateFormat
 
DEBUG - Static variable in class org.apache.log4j.Priority
Deprecated. Use Level.DEBUG instead.
DEBUG - Static variable in class org.apache.log4j.Level
The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
DEBUG - Static variable in class org.apache.log4j.lf5.LogLevel
 
DEBUG_INT - Static variable in class org.apache.log4j.Priority
 
DEBUG_KEY - Static variable in class org.apache.log4j.helpers.LogLog
Defining this value makes log4j print log4j-internal debug statements to System.out.
debug(Object) - Method in class org.apache.log4j.Category
Log a message object with the DEBUG level.
debug(Object, Throwable) - Method in class org.apache.log4j.Category
Log a message object with the DEBUG level including the stack trace of the Throwable t passed as parameter.
debug(String) - Static method in class org.apache.log4j.helpers.LogLog
This method is used to output log4j internal debug statements.
debug(String, Throwable) - Static method in class org.apache.log4j.helpers.LogLog
This method is used to output log4j internal debug statements.
debugEnabled - Static variable in class org.apache.log4j.helpers.LogLog
 
decide(LoggingEvent) - Method in class org.apache.log4j.spi.Filter
If the decision is DENY, then the event will be dropped.
decide(LoggingEvent) - Method in class org.apache.log4j.varia.DenyAllFilter
Always returns the integer constant Filter.DENY regardless of the LoggingEvent parameter.
decide(LoggingEvent) - Method in class org.apache.log4j.varia.StringMatchFilter
Returns Filter.NEUTRAL is there is no string match.
decide(LoggingEvent) - Method in class org.apache.log4j.varia.LevelMatchFilter
Return the decision of this filter.
decide(LoggingEvent) - Method in class org.apache.log4j.varia.LevelRangeFilter
Return the decision of this filter.
DEFAULT_BUFFER_SIZE - Static variable in class org.apache.log4j.AsyncAppender
The default buffer size is set to 128 events.
DEFAULT_CONFIGURATION_FILE - Static variable in class org.apache.log4j.LogManager
Deprecated. This variable is for internal use only. It will become package protected in future versions.
DEFAULT_CONFIGURATION_KEY - Static variable in class org.apache.log4j.LogManager
Deprecated. This variable is for internal use only. It will become private in future versions.
DEFAULT_CONVERSION_PATTERN - Static variable in class org.apache.log4j.PatternLayout
Default pattern string for log output.
DEFAULT_DELAY - Static variable in class org.apache.log4j.helpers.FileWatchdog
The default delay between every file modification check, set to 60 seconds.
DEFAULT_INIT_OVERRIDE_KEY - Static variable in class org.apache.log4j.LogManager
Deprecated. This variable is for internal use only. It will become private in future versions.
DefaultLF5Configurator - class org.apache.log4j.lf5.DefaultLF5Configurator.
The DefaultLF5Configurator provides a default configuration for the LF5Appender.
DefaultRepositorySelector - class org.apache.log4j.spi.DefaultRepositorySelector.
 
DefaultRepositorySelector(LoggerRepository) - Constructor for class org.apache.log4j.spi.DefaultRepositorySelector
 
delay - Variable in class org.apache.log4j.helpers.FileWatchdog
The delay to observe between every check.
DENY - Static variable in class org.apache.log4j.spi.Filter
The log event must be dropped immediately without consulting with the remaining filters, if any, in the chain.
DenyAllFilter - class org.apache.log4j.varia.DenyAllFilter.
This filter drops all logging events.
DenyAllFilter() - Constructor for class org.apache.log4j.varia.DenyAllFilter
 
doAppend(LoggingEvent) - Method in class org.apache.log4j.AppenderSkeleton
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton.append(org.apache.log4j.spi.LoggingEvent) method.
doAppend(LoggingEvent) - Method in interface org.apache.log4j.Appender
Log in Appender specific way.
doAppend(LoggingEvent) - Method in class org.apache.log4j.performance.NullAppender
 
doAppend(LoggingEvent) - Method in class org.apache.log4j.varia.NullAppender
Does not do anything.
doCapitalize - Variable in class org.apache.log4j.config.PropertyPrinter
 
doConfigure(Element, LoggerRepository) - Method in class org.apache.log4j.xml.DOMConfigurator
Configure by taking in an DOM element.
doConfigure(InputSource, LoggerRepository) - Method in class org.apache.log4j.xml.DOMConfigurator
Configure log4j by reading in a log4j.dtd compliant XML configuration file.
doConfigure(InputStream, LoggerRepository) - Method in class org.apache.log4j.xml.DOMConfigurator
Configure log4j by reading in a log4j.dtd compliant XML configuration file.
doConfigure(Properties, LoggerRepository) - Method in class org.apache.log4j.PropertyConfigurator
Read configuration options from properties.
doConfigure(Reader, LoggerRepository) - Method in class org.apache.log4j.xml.DOMConfigurator
Configure log4j by reading in a log4j.dtd compliant XML configuration file.
doConfigure(String, LoggerRepository) - Method in class org.apache.log4j.PropertyConfigurator
Read configuration from a file.
doConfigure(String, LoggerRepository) - Method in class org.apache.log4j.xml.DOMConfigurator
 
doConfigure(URL, LoggerRepository) - Method in class org.apache.log4j.PropertyConfigurator
Read configuration options from url configURL.
doConfigure(URL, LoggerRepository) - Method in class org.apache.log4j.lf5.DefaultLF5Configurator
This is a dummy method that will throw an IllegalStateException if used.
doConfigure(URL, LoggerRepository) - Method in interface org.apache.log4j.spi.Configurator
Interpret a resource pointed by a URL and set up log4j accordingly.
doConfigure(URL, LoggerRepository) - Method in class org.apache.log4j.varia.ReloadingPropertyConfigurator
 
doConfigure(URL, LoggerRepository) - Method in class org.apache.log4j.xml.DOMConfigurator
 
DOMConfigurator - class org.apache.log4j.xml.DOMConfigurator.
Use this class to initialize the log4j environment using a DOM tree.
DOMConfigurator() - Constructor for class org.apache.log4j.xml.DOMConfigurator
No argument constructor.
doOnChange() - Method in class org.apache.log4j.helpers.FileWatchdog
 
doRender(Object) - Method in interface org.apache.log4j.or.ObjectRenderer
Render the object passed as parameter as a String.
doRender(Object) - Method in class org.apache.log4j.or.ThreadGroupRenderer
Render a ThreadGroup object similar to the way that the ThreadGroup.list() method output information.
doRender(Object) - Method in class org.apache.log4j.or.jms.MessageRenderer
Render a Message.
doRender(Object) - Method in class org.apache.log4j.or.sax.AttributesRenderer
Render a Attributes.

E

emitNoAppenderWarning(Category) - Method in class org.apache.log4j.Hierarchy
 
emitNoAppenderWarning(Category) - Method in interface org.apache.log4j.spi.LoggerRepository
 
encoding - Variable in class org.apache.log4j.WriterAppender
The encoding to use when writing.
encompasses(LogLevel) - Method in class org.apache.log4j.lf5.LogLevel
Returns true if the level supplied is encompassed by this level.
equals(LF5Appender) - Method in class org.apache.log4j.lf5.LF5Appender
The equals method compares two LF5Appenders and determines whether they are equal.
equals(Object) - Method in class org.apache.log4j.Priority
Two priorities are equal if their level fields are equal.
equals(Object) - Method in class org.apache.log4j.lf5.LogLevel
 
ERROR - Static variable in class org.apache.log4j.Priority
Deprecated. Use Level.ERROR instead.
ERROR - Static variable in class org.apache.log4j.Level
The ERROR level designates error events that might still allow the application to continue running.
ERROR - Static variable in class org.apache.log4j.lf5.LogLevel
 
ERROR_INT - Static variable in class org.apache.log4j.Priority
 
error(Object) - Method in class org.apache.log4j.Category
Log a message object with the ERROR Level.
error(Object, Throwable) - Method in class org.apache.log4j.Category
Log a message object with the ERROR level including the stack trace of the Throwable t passed as parameter.
error(SAXParseException) - Method in class org.apache.log4j.xml.SAXErrorHandler
 
error(SAXParseException) - Method in class org.apache.log4j.xml.examples.ReportParserError
 
error(String) - Static method in class org.apache.log4j.helpers.LogLog
This method is used to output log4j internal error statements.
error(String) - Method in class org.apache.log4j.helpers.OnlyOnceErrorHandler
Print a the error message passed as parameter on System.err.
error(String) - Method in interface org.apache.log4j.spi.ErrorHandler
This method is normally used to just print the error message passed as a parameter.
error(String) - Method in class org.apache.log4j.varia.FallbackErrorHandler
Print a the error message passed as parameter on System.err.
error(String, Exception, int) - Method in class org.apache.log4j.helpers.OnlyOnceErrorHandler
Prints the message and the stack trace of the exception on System.err.
error(String, Exception, int) - Method in interface org.apache.log4j.spi.ErrorHandler
Equivalent to the ErrorHandler.error(String, Exception, int, LoggingEvent event) with the the event parameteter set to null.
error(String, Exception, int) - Method in class org.apache.log4j.varia.FallbackErrorHandler
Prints the message and the stack trace of the exception on System.err.
error(String, Exception, int, LoggingEvent) - Method in class org.apache.log4j.helpers.OnlyOnceErrorHandler
Prints the message and the stack trace of the exception on System.err.
error(String, Exception, int, LoggingEvent) - Method in interface org.apache.log4j.spi.ErrorHandler
This method is invoked to handle the error.
error(String, Exception, int, LoggingEvent) - Method in class org.apache.log4j.varia.FallbackErrorHandler
Prints the message and the stack trace of the exception on System.err.
error(String, Throwable) - Static method in class org.apache.log4j.helpers.LogLog
This method is used to output log4j internal error statements.
ErrorCode - interface org.apache.log4j.spi.ErrorCode.
This interface defines commonly encoutered error codes.
errorHandler - Variable in class org.apache.log4j.AppenderSkeleton
It is assumed and enforced that errorHandler is never null.
errorHandler - Variable in class org.apache.log4j.helpers.QuietWriter
 
ErrorHandler - interface org.apache.log4j.spi.ErrorHandler.
Appenders may delegate their error handling to ErrorHandlers.
escapeTags(String) - Static method in class org.apache.log4j.helpers.Transform
This method takes a string which may contain HTML tags (ie, <b>, <table>, etc) and replaces any '<' and '>' characters with respective predefined entity references.
evaluator - Variable in class org.apache.log4j.net.SMTPAppender
 
execute(String) - Method in class org.apache.log4j.jdbc.JDBCAppender
Override this to provide an alertnate method of getting connections (such as caching).
exists(String) - Static method in class org.apache.log4j.Category
Deprecated. Please use LogManager.exists(java.lang.String) instead.
exists(String) - Static method in class org.apache.log4j.LogManager
 
exists(String) - Method in class org.apache.log4j.Hierarchy
Check if the named logger exists in the hierarchy.
exists(String) - Method in interface org.apache.log4j.spi.LoggerRepository
 
ExternallyRolledFileAppender - class org.apache.log4j.varia.ExternallyRolledFileAppender.
This appender listens on a socket on the port specified by the Port property for a "RollOver" message.
ExternallyRolledFileAppender() - Constructor for class org.apache.log4j.varia.ExternallyRolledFileAppender
The default constructor does nothing but calls its super-class constructor.
extractOption() - Method in class org.apache.log4j.helpers.PatternParser
 
extractPrecisionOption() - Method in class org.apache.log4j.helpers.PatternParser
The option is expected to be in decimal and positive.

F

FACILITY_OI - Static variable in class org.apache.log4j.net.SyslogAppender
 
FallbackErrorHandler - class org.apache.log4j.varia.FallbackErrorHandler.
The FallbackErrorHandler implements the ErrorHandler interface such that a secondary appender may be specified.
FallbackErrorHandler() - Constructor for class org.apache.log4j.varia.FallbackErrorHandler
 
FATAL - Static variable in class org.apache.log4j.Priority
Deprecated. Use Level.FATAL instead.
FATAL - Static variable in class org.apache.log4j.Level
The FATAL level designates very severe error events that will presumably lead the application to abort.
FATAL - Static variable in class org.apache.log4j.lf5.LogLevel
 
FATAL_INT - Static variable in class org.apache.log4j.Priority
 
fatal(Object) - Method in class org.apache.log4j.Category
Log a message object with the FATAL Level.
fatal(Object, Throwable) - Method in class org.apache.log4j.Category
Log a message object with the FATAL level including the stack trace of the Throwable t passed as parameter.
fatalError(SAXParseException) - Method in class org.apache.log4j.xml.SAXErrorHandler
 
fatalError(SAXParseException) - Method in class org.apache.log4j.xml.examples.ReportParserError
 
FILE_OPEN_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
 
fileAppend - Variable in class org.apache.log4j.FileAppender
Controls file truncatation.
FileAppender - class org.apache.log4j.FileAppender.
FileAppender appends log events to a file.
FileAppender() - Constructor for class org.apache.log4j.FileAppender
The default constructor does not do anything.
FileAppender(Layout, String) - Constructor for class org.apache.log4j.FileAppender
Instantiate a FileAppender and open the file designated by filename.
FileAppender(Layout, String, boolean) - Constructor for class org.apache.log4j.FileAppender
Instantiate a FileAppender and open the file designated by filename.
FileAppender(Layout, String, boolean, boolean, int) - Constructor for class org.apache.log4j.FileAppender
Instantiate a FileAppender and open the file designated by filename.
filename - Variable in class org.apache.log4j.helpers.FileWatchdog
The name of the file to observe for changes.
fileName - Variable in class org.apache.log4j.FileAppender
The name of the log file.
FileWatchdog - class org.apache.log4j.helpers.FileWatchdog.
Check every now and then that a certain file has not changed.
FileWatchdog(String) - Constructor for class org.apache.log4j.helpers.FileWatchdog
 
Filter - class org.apache.log4j.spi.Filter.
Users should extend this class to implement customized logging event filtering.
Filter() - Constructor for class org.apache.log4j.spi.Filter
 
finalize() - Method in class org.apache.log4j.AppenderSkeleton
Finalize this appender by calling the derived class' close method.
finalize() - Method in class org.apache.log4j.jdbc.JDBCAppender
closes the appender before disposal
finalize() - Method in class org.apache.log4j.lf5.AppenderFinalizer
 
finalize() - Method in class org.apache.log4j.net.TelnetAppender.SocketHandler
make sure we close all network connections when this handler is destroyed.
finalize() - Method in class org.apache.log4j.nt.NTEventLogAppender
 
finalizeConverter(char) - Method in class org.apache.log4j.helpers.PatternParser
 
findAndRender(Object) - Method in class org.apache.log4j.or.RendererMap
Find the appropriate renderer for the class type of the o parameter.
findAndSubst(String, Properties) - Static method in class org.apache.log4j.helpers.OptionConverter
Find the value corresponding to key in props.
findAppenderByName(Document, String) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse appenders by IDREF name.
findAppenderByReference(Element) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse appenders by IDREF element.
FINE - Static variable in class org.apache.log4j.lf5.LogLevel
 
FINER - Static variable in class org.apache.log4j.lf5.LogLevel
 
FINEST - Static variable in class org.apache.log4j.lf5.LogLevel
 
fireAddAppenderEvent(Category, Appender) - Method in class org.apache.log4j.Hierarchy
 
fireAddAppenderEvent(Category, Appender) - Method in interface org.apache.log4j.spi.LoggerRepository
 
FLUSH_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
 
flush() - Method in class org.apache.log4j.helpers.QuietWriter
 
flush() - Method in class org.apache.log4j.helpers.SyslogWriter
 
flush() - Method in class org.apache.log4j.performance.NOPWriter
 
flushBuffer() - Method in class org.apache.log4j.jdbc.JDBCAppender
loops through the buffer of LoggingEvents, gets a sql string from getLogStatement() and sends it to execute().
forcedLog(String, Priority, Object, Throwable) - Method in class org.apache.log4j.Category
This method creates a new logging event and logs the event without further checks.
format(Date, StringBuffer, FieldPosition) - Method in class org.apache.log4j.helpers.AbsoluteTimeDateFormat
Appends to sbuf the time in the format "HH:mm:ss,SSS" for example, "15:49:37,459"
format(Date, StringBuffer, FieldPosition) - Method in class org.apache.log4j.helpers.ISO8601DateFormat
Appends a date in the format "YYYY-mm-dd HH:mm:ss,SSS" to sbuf.
format(Date, StringBuffer, FieldPosition) - Method in class org.apache.log4j.helpers.DateTimeDateFormat
Appends to sbuf the date in the format "dd MMM yyyy HH:mm:ss,SSS" for example, "06 Nov 1994 08:49:37,459".
format(Date, StringBuffer, FieldPosition) - Method in class org.apache.log4j.helpers.RelativeTimeDateFormat
Appends to sbuf the number of milliseconds elapsed since the start of the application.
format(LoggingEvent) - Method in class org.apache.log4j.Layout
Implement this method to create your own layout format.
format(LoggingEvent) - Method in class org.apache.log4j.SimpleLayout
Returns the log statement in a format consisting of the level, followed by " - " and then the message.
format(LoggingEvent) - Method in class org.apache.log4j.TTCCLayout
In addition to the level of the statement and message, the returned byte array includes time, thread, category and NDC information.
format(LoggingEvent) - Method in class org.apache.log4j.PatternLayout
Produces a formatted string as specified by the conversion pattern.
format(LoggingEvent) - Method in class org.apache.log4j.HTMLLayout
 
format(LoggingEvent) - Method in class org.apache.log4j.xml.XMLLayout
Formats a LoggingEvent in conformance with the log4j.dtd.
format(StringBuffer, LoggingEvent) - Method in class org.apache.log4j.helpers.PatternConverter
A template method for formatting in a converter specific way.
formattingInfo - Variable in class org.apache.log4j.helpers.PatternParser
 
FormattingInfo - class org.apache.log4j.helpers.FormattingInfo.
FormattingInfo instances contain the information obtained when parsing formatting modifiers in conversion modifiers.
FormattingInfo() - Constructor for class org.apache.log4j.helpers.FormattingInfo
 
foundProperty(Object, String, String, Object) - Method in interface org.apache.log4j.config.PropertyGetter.PropertyCallback
 
foundProperty(Object, String, String, Object) - Method in class org.apache.log4j.config.PropertyPrinter
 
fqnOfCategoryClass - Variable in class org.apache.log4j.spi.LoggingEvent
Fully qualified name of the calling category class.
fullInfo - Variable in class org.apache.log4j.spi.LocationInfo
All available caller information, in the format fully.qualified.classname.of.caller.methodName(Filename.java:line)

G

genAppName() - Method in class org.apache.log4j.config.PropertyPrinter
 
GENERIC_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
 
get() - Static method in class org.apache.log4j.NDC
Never use this method directly, use the LoggingEvent.getNDC() method instead.
get() - Method in class org.apache.log4j.helpers.CyclicBuffer
Get the oldest (first) element in the buffer.
get() - Method in class org.apache.log4j.helpers.BoundedFIFO
Get the first element in the buffer.
get(Class) - Method in class org.apache.log4j.or.RendererMap
Search the parents of clazz for a renderer.
get(int) - Method in class org.apache.log4j.helpers.CyclicBuffer
Get the ith oldest event currently in the buffer.
get(Object) - Method in class org.apache.log4j.or.RendererMap
Syntactic sugar method that calls RendererMap.get(Class) with the class of the object parameter.
get(String) - Static method in class org.apache.log4j.MDC
Get the context identified by the key parameter.
getAcceptOnMatch() - Method in class org.apache.log4j.varia.StringMatchFilter
 
getAcceptOnMatch() - Method in class org.apache.log4j.varia.LevelMatchFilter
 
getAcceptOnMatch() - Method in class org.apache.log4j.varia.LevelRangeFilter
Get the value of the AcceptOnMatch option.
getAdditivity() - Method in class org.apache.log4j.Category
Get the additivity flag for this Category instance.
getAllAppenders() - Method in class org.apache.log4j.Category
Get the appenders contained in this category as an Enumeration.
getAllAppenders() - Method in class org.apache.log4j.AsyncAppender
Get iterator over attached appenders.
getAllAppenders() - Method in class org.apache.log4j.helpers.AppenderAttachableImpl
Get all attached appenders as an Enumeration.
getAllAppenders() - Method in interface org.apache.log4j.spi.AppenderAttachable
Get all previously added appenders as an Enumeration.
getAllDefaultLevels() - Static method in class org.apache.log4j.lf5.LogLevel
 
getAllPossiblePriorities() - Static method in class org.apache.log4j.Priority
Deprecated. This method will be removed with no replacement.
getAppend() - Method in class org.apache.log4j.FileAppender
Returns the value of the Append option.
getAppender(String) - Method in class org.apache.log4j.Category
Look for the appender named as name.
getAppender(String) - Method in class org.apache.log4j.AsyncAppender
Get appender by name.
getAppender(String) - Method in class org.apache.log4j.helpers.AppenderAttachableImpl
Look for an attached appender named as name.
getAppender(String) - Method in interface org.apache.log4j.spi.AppenderAttachable
Get an appender by name.
getAttribute(String) - Method in class org.apache.log4j.jmx.LoggerDynamicMBean
 
getAttribute(String) - Method in class org.apache.log4j.jmx.LayoutDynamicMBean
 
getAttribute(String) - Method in class org.apache.log4j.jmx.AppenderDynamicMBean
 
getAttribute(String) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
getAttributes(String[]) - Method in class org.apache.log4j.jmx.AbstractDynamicMBean
Enables the to get the values of several attributes of the Dynamic MBean.
getBcc() - Method in class org.apache.log4j.net.SMTPAppender
Get the bcc recipient addresses.
getBlocking() - Method in class org.apache.log4j.AsyncAppender
Gets whether appender should block calling thread when buffer is full.
getBufferedIO() - Method in class org.apache.log4j.FileAppender
Get the value of the BufferedIO option.
getBufferSize() - Method in class org.apache.log4j.FileAppender
Get the size of the IO buffer.
getBufferSize() - Method in class org.apache.log4j.AsyncAppender
Gets the current buffer size.
getBufferSize() - Method in class org.apache.log4j.jdbc.JDBCAppender
 
getBufferSize() - Method in class org.apache.log4j.net.SMTPAppender
Returns value of the BufferSize option.
getCategory() - Method in class org.apache.log4j.lf5.LogRecord
Get the category asscociated with this LogRecord.
getCategoryPrefixing() - Method in class org.apache.log4j.TTCCLayout
Returns value of the CategoryPrefixing option.
getCc() - Method in class org.apache.log4j.net.SMTPAppender
Get the cc recipient addresses.
getChainedLevel() - Method in class org.apache.log4j.spi.RootLogger
Return the assigned level value without walking the logger hierarchy.
getChainedLevel() - Method in class org.apache.log4j.spi.RootCategory
Deprecated. Return the assigned level value without walking the category hierarchy.
getChainedPriority() - Method in class org.apache.log4j.Category
Deprecated. Please use the the Category.getEffectiveLevel() method instead.
getClassName() - Method in class org.apache.log4j.spi.LocationInfo
Return the fully qualified class name of the caller making the logging request.
getConnection() - Method in class org.apache.log4j.jdbc.JDBCAppender
Override this to link with your connection pooling system.
getContentType() - Method in class org.apache.log4j.Layout
Returns the content type output by this layout.
getContentType() - Method in class org.apache.log4j.HTMLLayout
Returns the content type output by this layout, i.e "text/html".
getContext() - Static method in class org.apache.log4j.MDC
Get the current thread's MDC as a hashtable.
getContextPrinting() - Method in class org.apache.log4j.TTCCLayout
Returns value of the ContextPrinting option.
getConversionPattern() - Method in class org.apache.log4j.PatternLayout
Returns the value of the ConversionPattern option.
getCount() - Method in class org.apache.log4j.helpers.CountingQuietWriter
 
getCurrentCategories() - Static method in class org.apache.log4j.Category
Deprecated. Please use LogManager.getCurrentLoggers() instead.
getCurrentCategories() - Method in class org.apache.log4j.Hierarchy
Deprecated. Please use Hierarchy.getCurrentLoggers() instead.
getCurrentCategories() - Method in interface org.apache.log4j.spi.LoggerRepository
Deprecated.
getCurrentLoggers() - Static method in class org.apache.log4j.LogManager
 
getCurrentLoggers() - Method in class org.apache.log4j.Hierarchy
Returns all the currently defined categories in this hierarchy as an Enumeration.
getCurrentLoggers() - Method in interface org.apache.log4j.spi.LoggerRepository
 
getDateFormat() - Method in class org.apache.log4j.helpers.DateLayout
Returns value of the DateFormat option.
getDatePattern() - Method in class org.apache.log4j.DailyRollingFileAppender
Returns the value of the DatePattern option.
getDefaultHierarchy() - Static method in class org.apache.log4j.Category
Deprecated. Please use LogManager.getLoggerRepository() instead.
getDefaultInstance() - Static method in class org.apache.log4j.lf5.LF5Appender
 
getDefaultMonitorHeight() - Static method in class org.apache.log4j.lf5.LF5Appender
 
getDefaultMonitorWidth() - Static method in class org.apache.log4j.lf5.LF5Appender
 
getDefaultRenderer() - Method in class org.apache.log4j.or.RendererMap
 
getDepth() - Static method in class org.apache.log4j.NDC
Get the current nesting depth of this diagnostic context.
getEffectiveLevel() - Method in class org.apache.log4j.Category
Starting from this category, search the category hierarchy for a non-null level and return it.
getEncoding() - Method in class org.apache.log4j.WriterAppender
 
getErrorHandler() - Method in class org.apache.log4j.AppenderSkeleton
Return the currently set ErrorHandler for this Appender.
getErrorHandler() - Method in interface org.apache.log4j.Appender
Returns the ErrorHandler for this appender.
getEvaluatorClass() - Method in class org.apache.log4j.net.SMTPAppender
Returns value of the EvaluatorClass option.
getFacility() - Method in class org.apache.log4j.net.SyslogAppender
Returns the value of the Facility option.
getFacility(String) - Static method in class org.apache.log4j.net.SyslogAppender
Returns the integer value corresponding to the named syslog facility, or -1 if it couldn't be recognized.
getFacilityPrinting() - Method in class org.apache.log4j.net.SyslogAppender
Returns the value of the FacilityPrinting option.
getFacilityString(int) - Static method in class org.apache.log4j.net.SyslogAppender
Returns the specified syslog facility as a lower-case String, e.g.
getFile() - Method in class org.apache.log4j.FileAppender
Returns the value of the File option.
getFileName() - Method in class org.apache.log4j.spi.LocationInfo
Return the file name of the caller.
getFilter() - Method in class org.apache.log4j.AppenderSkeleton
Returns the head Filter.
getFilter() - Method in interface org.apache.log4j.Appender
Returns the head Filter.
getFirstFilter() - Method in class org.apache.log4j.AppenderSkeleton
Return the first filter in the filter chain for this Appender.
getFollow() - Method in class org.apache.log4j.ConsoleAppender
Gets whether the appender honors reassignments of System.out or System.err made after configuration.
getFooter() - Method in class org.apache.log4j.Layout
Returns the footer for the layout format.
getFooter() - Method in class org.apache.log4j.HTMLLayout
Returns the appropriate HTML footers.
getFrom() - Method in class org.apache.log4j.net.SMTPAppender
Returns value of the From option.
getHeader() - Method in class org.apache.log4j.Layout
Returns the header for the layout format.
getHeader() - Method in class org.apache.log4j.HTMLLayout
Returns appropriate HTML headers.
getHierarchy() - Method in class org.apache.log4j.Category
Deprecated. Please use Category.getLoggerRepository() instead.
getImmediateFlush() - Method in class org.apache.log4j.WriterAppender
Returns value of the ImmediateFlush option.
getInitialContextFactoryName() - Method in class org.apache.log4j.net.JMSAppender
Returns the value of the InitialContextFactoryName option.
getInstance() - Static method in class org.apache.log4j.helpers.NullEnumeration
 
getInstance() - Method in class org.apache.log4j.varia.NullAppender
Whenever you can, use this method to retreive an instance instead of instantiating a new one with new.
getInstance(Class) - Static method in class org.apache.log4j.Category
Deprecated. Please make sure to use Logger.getLogger(Class) instead.
getInstance(String) - Static method in class org.apache.log4j.Category
Deprecated. Make sure to use Logger.getLogger(String) instead.
getJdk14Levels() - Static method in class org.apache.log4j.lf5.LogLevel
 
getLabel() - Method in class org.apache.log4j.lf5.LogLevel
Return the Label of the LogLevel.
getLayout() - Method in class org.apache.log4j.AppenderSkeleton
Returns the layout of this appender.
getLayout() - Method in interface org.apache.log4j.Appender
Returns this appenders layout.
getLevel() - Method in class org.apache.log4j.Category
Returns the assigned Level, if any, for this Category.
getLevel() - Method in class org.apache.log4j.lf5.LogRecord
Get the level of this LogRecord.
getLevel() - Method in class org.apache.log4j.spi.LoggingEvent
Return the level of this event.
getLevelMax() - Method in class org.apache.log4j.varia.LevelRangeFilter
Get the value of the LevelMax option.
getLevelMin() - Method in class org.apache.log4j.varia.LevelRangeFilter
Get the value of the LevelMin option.
getLevelToMatch() - Method in class org.apache.log4j.varia.LevelMatchFilter
 
getLineNumber() - Method in class org.apache.log4j.spi.LocationInfo
Returns the line number of the caller.
getLocation() - Method in class org.apache.log4j.lf5.LogRecord
Get the location in code where this LogRecord originated.
getLocationInfo() - Method in class org.apache.log4j.HTMLLayout
Returns the current value of the LocationInfo option.
getLocationInfo() - Method in class org.apache.log4j.AsyncAppender
Gets whether the location of the logging request call should be captured.
getLocationInfo() - Method in class org.apache.log4j.net.SocketHubAppender
Returns value of the LocationInfo option.
getLocationInfo() - Method in class org.apache.log4j.net.SMTPAppender
Returns value of the LocationInfo option.
getLocationInfo() - Method in class org.apache.log4j.net.JMSAppender
Returns value of the LocationInfo property which determines whether location (stack) info is sent to the remote subscriber.
getLocationInfo() - Method in class org.apache.log4j.net.SocketAppender
Returns value of the LocationInfo option.
getLocationInfo() - Method in class org.apache.log4j.xml.XMLLayout
Returns the current value of the LocationInfo option.
getLocationInformation() - Method in class org.apache.log4j.spi.LoggingEvent
Set the location information for this logging event.
getLog4JLevels() - Static method in class org.apache.log4j.lf5.LogLevel
 
getLogBrokerMonitor() - Method in class org.apache.log4j.lf5.LF5Appender
 
getLogger() - Method in class org.apache.log4j.jmx.AbstractDynamicMBean
 
getLogger() - Method in class org.apache.log4j.jmx.LoggerDynamicMBean
 
getLogger() - Method in class org.apache.log4j.jmx.LayoutDynamicMBean
 
getLogger() - Method in class org.apache.log4j.jmx.AppenderDynamicMBean
 
getLogger() - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
getLogger(Class) - Static method in class org.apache.log4j.LogManager
Retrieve the appropriate Logger instance.
getLogger(Class) - Static method in class org.apache.log4j.Logger
Shorthand for getLogger(clazz.getName()).
getLogger(String) - Static method in class org.apache.log4j.LogManager
Retrieve the appropriate Logger instance.
getLogger(String) - Static method in class org.apache.log4j.Logger
Retrieve a logger named according to the value of the name parameter.
getLogger(String) - Method in class org.apache.log4j.Hierarchy
Return a new logger instance named as the first parameter using the default factory.
getLogger(String) - Method in interface org.apache.log4j.spi.LoggerRepository
 
getLogger(String, LoggerFactory) - Static method in class org.apache.log4j.LogManager
Retrieve the appropriate Logger instance.
getLogger(String, LoggerFactory) - Static method in class org.apache.log4j.Logger
Like Logger.getLogger(String) except that the type of logger instantiated depends on the type returned by the LoggerFactory.makeNewLoggerInstance(java.lang.String) method of the factory parameter.
getLogger(String, LoggerFactory) - Method in class org.apache.log4j.Hierarchy
Return a new logger instance named as the first parameter using factory.
getLogger(String, LoggerFactory) - Method in interface org.apache.log4j.spi.LoggerRepository
 
getLoggerName() - Method in class org.apache.log4j.spi.LoggingEvent
Return the name of the logger.
getLoggerRepository() - Method in class org.apache.log4j.Category
Return the the LoggerRepository where this Category is attached.
getLoggerRepository() - Static method in class org.apache.log4j.LogManager
 
getLoggerRepository() - Method in class org.apache.log4j.spi.DefaultRepositorySelector
 
getLoggerRepository() - Method in interface org.apache.log4j.spi.RepositorySelector
Returns a LoggerRepository depending on the context.
getLogLevelColorMap() - Static method in class org.apache.log4j.lf5.LogLevel
 
getLogStatement(LoggingEvent) - Method in class org.apache.log4j.jdbc.JDBCAppender
By default getLogStatement sends the event to the required Layout object.
getMaxBackupIndex() - Method in class org.apache.log4j.RollingFileAppender
Returns the value of the MaxBackupIndex option.
getMaximumFileSize() - Method in class org.apache.log4j.RollingFileAppender
Get the maximum size that the output file is allowed to reach before being rolled over to backup files.
getMaxSize() - Method in class org.apache.log4j.helpers.CyclicBuffer
 
getMaxSize() - Method in class org.apache.log4j.helpers.BoundedFIFO
Get the maximum size of the buffer.
getMBeanInfo() - Method in class org.apache.log4j.jmx.LoggerDynamicMBean
 
getMBeanInfo() - Method in class org.apache.log4j.jmx.LayoutDynamicMBean
 
getMBeanInfo() - Method in class org.apache.log4j.jmx.AppenderDynamicMBean
 
getMBeanInfo() - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
getMDC(String) - Method in class org.apache.log4j.spi.LoggingEvent
Returns the the context corresponding to the key parameter.
getMDCCopy() - Method in class org.apache.log4j.spi.LoggingEvent
Obtain a copy of this thread's MDC prior to serialization or asynchronous logging.
getMessage() - Method in class org.apache.log4j.config.PropertySetterException
Returns descriptive text on the cause of this exception.
getMessage() - Method in class org.apache.log4j.lf5.LogRecord
Get the message asscociated with this LogRecord.
getMessage() - Method in class org.apache.log4j.spi.LoggingEvent
Return the message for this logging event.
getMethodName() - Method in class org.apache.log4j.spi.LocationInfo
Returns the method name of the caller.
getMillis() - Method in class org.apache.log4j.lf5.LogRecord
Get the event time of this record in milliseconds from 1970.
getName() - Method in class org.apache.log4j.Category
Return the category name.
getName() - Method in class org.apache.log4j.AppenderSkeleton
Returns the name of this FileAppender.
getName() - Method in interface org.apache.log4j.Appender
Get the name of this appender.
getNDC() - Method in class org.apache.log4j.lf5.LogRecord
Get the NDC (nested diagnostic context) for this record.
getNDC() - Method in class org.apache.log4j.spi.LoggingEvent
This method returns the NDC for this event.
getNext() - Method in class org.apache.log4j.spi.Filter
Return the pointer to the next filter;
getNextId() - Static method in class org.apache.log4j.lf5.LogRecord
 
getNotificationInfo() - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
getOptionStrings() - Method in class org.apache.log4j.helpers.DateLayout
Deprecated. Use the setter method for the option directly instead of the generic setOption method.
getOptionStrings() - Method in class org.apache.log4j.varia.DenyAllFilter
Deprecated. We now use JavaBeans introspection to configure components. Options strings are no longer needed.
getOptionStrings() - Method in class org.apache.log4j.varia.StringMatchFilter
Deprecated. We now use JavaBeans introspection to configure components. Options strings are no longer needed.
getParent() - Method in class org.apache.log4j.Category
Returns the parent of this category.
getPassword() - Method in class org.apache.log4j.jdbc.JDBCAppender
 
getPassword() - Method in class org.apache.log4j.net.JMSAppender
 
getPort() - Method in class org.apache.log4j.net.SocketHubAppender
Returns value of the Port option.
getPort() - Method in class org.apache.log4j.net.TelnetAppender
 
getPort() - Method in class org.apache.log4j.net.SocketAppender
Returns value of the Port option.
getPort() - Method in class org.apache.log4j.varia.ExternallyRolledFileAppender
Returns value of the Port option.
getPrecedence() - Method in class org.apache.log4j.lf5.LogLevel
 
getPriority() - Method in class org.apache.log4j.Category
Deprecated. Please use Category.getLevel() instead.
getProperties(Object, PropertyGetter.PropertyCallback, String) - Static method in class org.apache.log4j.config.PropertyGetter
 
getProperties(PropertyGetter.PropertyCallback, String) - Method in class org.apache.log4j.config.PropertyGetter
 
getPropertyDescriptor(String) - Method in class org.apache.log4j.config.PropertySetter
 
getProviderURL() - Method in class org.apache.log4j.net.JMSAppender
 
getReconnectionDelay() - Method in class org.apache.log4j.net.SocketAppender
Returns value of the ReconnectionDelay option.
getRemoteHost() - Method in class org.apache.log4j.net.SocketAppender
Returns value of the RemoteHost option.
getRenderedMessage() - Method in class org.apache.log4j.spi.LoggingEvent
 
getRendererMap() - Method in class org.apache.log4j.Hierarchy
Get the renderer map for this hierarchy.
getRendererMap() - Method in interface org.apache.log4j.spi.RendererSupport
 
getResource(String) - Static method in class org.apache.log4j.helpers.Loader
This method will search for resource in different places.
getResource(String, Class) - Static method in class org.apache.log4j.helpers.Loader
Deprecated. as of 1.2.
getResourceBundle() - Method in class org.apache.log4j.Category
Return the inherited ResourceBundle for this category.
getResourceBundleString(String) - Method in class org.apache.log4j.Category
Returns the string resource coresponding to key in this category's inherited resource bundle.
getRoot() - Static method in class org.apache.log4j.Category
Deprecated. Please use Logger.getRootLogger() instead.
getRootLogger() - Static method in class org.apache.log4j.LogManager
Retrieve the appropriate root logger.
getRootLogger() - Static method in class org.apache.log4j.Logger
Return the root logger for the current logger repository.
getRootLogger() - Method in class org.apache.log4j.Hierarchy
Get the root of this hierarchy.
getRootLogger() - Method in interface org.apache.log4j.spi.LoggerRepository
 
getScreenHeight() - Static method in class org.apache.log4j.lf5.LF5Appender
 
getScreenWidth() - Static method in class org.apache.log4j.lf5.LF5Appender
 
getSecurityCredentials() - Method in class org.apache.log4j.net.JMSAppender
 
getSecurityPrincipalName() - Method in class org.apache.log4j.net.JMSAppender
 
getSequenceNumber() - Method in class org.apache.log4j.lf5.LogRecord
Get the sequence number associated with this LogRecord.
getSMTPDebug() - Method in class org.apache.log4j.net.SMTPAppender
Get SMTP debug.
getSMTPHost() - Method in class org.apache.log4j.net.SMTPAppender
Returns value of the SMTPHost option.
getSMTPPassword() - Method in class org.apache.log4j.net.SMTPAppender
Get SMTP password.
getSMTPUsername() - Method in class org.apache.log4j.net.SMTPAppender
Get SMTP user name.
getSource() - Method in class org.apache.log4j.nt.NTEventLogAppender
 
getSql() - Method in class org.apache.log4j.jdbc.JDBCAppender
Returns pre-formated statement eg: insert into LogTable (msg) values ("%m")
getStartTime() - Static method in class org.apache.log4j.spi.LoggingEvent
Returns the time when the application started, in milliseconds elapsed since 01.01.1970.
getStringToMatch() - Method in class org.apache.log4j.varia.StringMatchFilter
 
getSubject() - Method in class org.apache.log4j.net.SMTPAppender
Returns value of the Subject option.
getSyslogEquivalent() - Method in class org.apache.log4j.Priority
Return the syslog equivalent of this priority as an integer.
getSyslogHost() - Method in class org.apache.log4j.net.SyslogAppender
Returns the value of the SyslogHost option.
getSystemProperty(String, String) - Static method in class org.apache.log4j.helpers.OptionConverter
Very similar to System.getProperty except that the SecurityException is hidden.
getTarget() - Method in class org.apache.log4j.ConsoleAppender
Returns the current value of the Target property.
getThreadDescription() - Method in class org.apache.log4j.lf5.LogRecord
Get the thread description asscociated with this LogRecord.
getThreadName() - Method in class org.apache.log4j.spi.LoggingEvent
 
getThreadPrinting() - Method in class org.apache.log4j.TTCCLayout
Returns value of the ThreadPrinting option.
getThreshold() - Method in class org.apache.log4j.AppenderSkeleton
Returns this appenders threshold level.
getThreshold() - Method in class org.apache.log4j.Hierarchy
Returns a Level representation of the enable state.
getThreshold() - Method in interface org.apache.log4j.spi.LoggerRepository
Get the repository-wide threshold.
getThrowable() - Method in class org.apache.log4j.spi.ThrowableInformation
 
getThrowableInformation() - Method in class org.apache.log4j.spi.LoggingEvent
Returns the throwable information contained within this event.
getThrowableStrRep() - Method in class org.apache.log4j.spi.ThrowableInformation
 
getThrowableStrRep() - Method in class org.apache.log4j.spi.LoggingEvent
Return this event's throwable's string[] representaion.
getThrown() - Method in class org.apache.log4j.lf5.LogRecord
Get the Throwable associated with this LogRecord.
getThrownStackTrace() - Method in class org.apache.log4j.lf5.LogRecord
Get the stack trace in a String-based format for the associated Throwable of this LogRecord.
getTimeZone() - Method in class org.apache.log4j.helpers.DateLayout
Returns value of the TimeZone option.
getTitle() - Method in class org.apache.log4j.HTMLLayout
Returns the current value of the Title option.
getTo() - Method in class org.apache.log4j.net.SMTPAppender
Returns value of the To option.
getTopicBindingName() - Method in class org.apache.log4j.net.JMSAppender
Returns the value of the TopicBindingName option.
getTopicConnection() - Method in class org.apache.log4j.net.JMSAppender
Returns the TopicConnection used for this appender.
getTopicConnectionFactoryBindingName() - Method in class org.apache.log4j.net.JMSAppender
Returns the value of the TopicConnectionFactoryBindingName option.
getTopicPublisher() - Method in class org.apache.log4j.net.JMSAppender
Returns the TopicPublisher used for this appender.
getTopicSession() - Method in class org.apache.log4j.net.JMSAppender
Returns the TopicSession used for this appender.
getURL() - Method in class org.apache.log4j.jdbc.JDBCAppender
 
getUser() - Method in class org.apache.log4j.jdbc.JDBCAppender
 
getUserName() - Method in class org.apache.log4j.net.JMSAppender
 

H

handleNotification(Notification, Object) - Method in class org.apache.log4j.jmx.LoggerDynamicMBean
 
hashCode() - Method in class org.apache.log4j.lf5.LogLevel
 
hasMoreElements() - Method in class org.apache.log4j.helpers.NullEnumeration
 
hasThrown() - Method in class org.apache.log4j.lf5.LogRecord
 
headFilter - Variable in class org.apache.log4j.AppenderSkeleton
The first filter in the filter chain.
Hierarchy - class org.apache.log4j.Hierarchy.
This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy.
Hierarchy(Logger) - Constructor for class org.apache.log4j.Hierarchy
Create a new logger hierarchy.
HierarchyDynamicMBean - class org.apache.log4j.jmx.HierarchyDynamicMBean.
 
HierarchyDynamicMBean() - Constructor for class org.apache.log4j.jmx.HierarchyDynamicMBean
 
HierarchyEventListener - interface org.apache.log4j.spi.HierarchyEventListener.
Listen to events occuring within a Hierarchy.
HTMLLayout - class org.apache.log4j.HTMLLayout.
This layout outputs events in a HTML table.
HTMLLayout() - Constructor for class org.apache.log4j.HTMLLayout
 

I

i - Variable in class org.apache.log4j.helpers.PatternParser
 
ignoresThrowable() - Method in class org.apache.log4j.Layout
If the layout handles the throwable object contained within LoggingEvent, then the layout should return false.
ignoresThrowable() - Method in class org.apache.log4j.SimpleLayout
The SimpleLayout does not handle the throwable contained within LoggingEvents.
ignoresThrowable() - Method in class org.apache.log4j.TTCCLayout
The TTCCLayout does not handle the throwable contained within LoggingEvents.
ignoresThrowable() - Method in class org.apache.log4j.PatternLayout
The PatternLayout does not handle the throwable contained within LoggingEvents.
ignoresThrowable() - Method in class org.apache.log4j.HTMLLayout
The HTML layout handles the throwable contained in logging events.
ignoresThrowable() - Method in class org.apache.log4j.xml.XMLLayout
The XMLLayout prints and does not ignore exceptions.
immediateFlush - Variable in class org.apache.log4j.WriterAppender
Immediate flush means that the underlying writer or output stream will be flushed at the end of each append operation.
INFO - Static variable in class org.apache.log4j.Priority
Deprecated. Use Level.INFO instead.
INFO - Static variable in class org.apache.log4j.Level
The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
INFO - Static variable in class org.apache.log4j.lf5.LogLevel
 
INFO_INT - Static variable in class org.apache.log4j.Priority
 
info(Object) - Method in class org.apache.log4j.Category
Log a message object with the INFO Level.
info(Object, Throwable) - Method in class org.apache.log4j.Category
Log a message object with the INFO level including the stack trace of the Throwable t passed as parameter.
inherit(Stack) - Static method in class org.apache.log4j.NDC
Inherit the diagnostic context of another thread.
INHERITED - Static variable in interface org.apache.log4j.spi.Configurator
Special level value signifying inherited behaviour.
instantiateByClassName(String, Class, Object) - Static method in class org.apache.log4j.helpers.OptionConverter
Instantiate an object given a class name.
instantiateByKey(Properties, String, Class, Object) - Static method in class org.apache.log4j.helpers.OptionConverter
 
introspect() - Method in class org.apache.log4j.config.PropertySetter
Uses JavaBeans Introspector to computer setters of object to be configured.
invoke(String, Object[], String[]) - Method in class org.apache.log4j.jmx.LoggerDynamicMBean
 
invoke(String, Object[], String[]) - Method in class org.apache.log4j.jmx.LayoutDynamicMBean
 
invoke(String, Object[], String[]) - Method in class org.apache.log4j.jmx.AppenderDynamicMBean
 
invoke(String, Object[], String[]) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
isAsSevereAsThreshold(Priority) - Method in class org.apache.log4j.AppenderSkeleton
Check whether the message level is below the appender's threshold.
isAttached(Appender) - Method in class org.apache.log4j.Category
Is the appender passed as parameter attached to this category?
isAttached(Appender) - Method in class org.apache.log4j.AsyncAppender
Determines if specified appender is attached.
isAttached(Appender) - Method in class org.apache.log4j.helpers.AppenderAttachableImpl
Returns true if the specified appender is in the list of attached appenders, false otherwise.
isAttached(Appender) - Method in interface org.apache.log4j.spi.AppenderAttachable
Returns true if the specified appender is in list of attached attached, false otherwise.
isDebugEnabled() - Method in class org.apache.log4j.Category
Check whether this category is enabled for the DEBUG Level.
isDisabled(int) - Method in class org.apache.log4j.Hierarchy
This method will return true if this repository is disabled for level object passed as parameter and false otherwise.
isDisabled(int) - Method in interface org.apache.log4j.spi.LoggerRepository
Returns whether this repository is disabled for a given level.
isEnabledFor(Priority) - Method in class org.apache.log4j.Category
Check whether this category is enabled for a given Level passed as parameter.
isFatal() - Method in class org.apache.log4j.lf5.LogRecord
 
isFull() - Method in class org.apache.log4j.helpers.BoundedFIFO
Return true if the buffer is full, that is, whether the number of elements in the buffer equals the buffer size.
isGenAppName(String) - Method in class org.apache.log4j.config.PropertyPrinter
Returns true if the specified appender name is considered to have been generated, that is, if it is of the form A[0-9]+.
isGreaterOrEqual(Priority) - Method in class org.apache.log4j.Priority
Returns true if this level has a higher or equal level than the level passed as argument, false otherwise.
isHandledType(Class) - Method in class org.apache.log4j.config.PropertyGetter
 
isInfoEnabled() - Method in class org.apache.log4j.Category
Check whether this category is enabled for the info Level.
isJava1() - Static method in class org.apache.log4j.helpers.Loader
Are we running under JDK 1.x?
ISO8601_DATE_FORMAT - Static variable in class org.apache.log4j.helpers.AbsoluteTimeDateFormat
String constant used to specify ISO8601DateFormat in layouts.
ISO8601DateFormat - class org.apache.log4j.helpers.ISO8601DateFormat.
Formats a Date in the format "yyyy-MM-dd HH:mm:ss,SSS" for example "1999-11-27 15:49:37,459".
ISO8601DateFormat() - Constructor for class org.apache.log4j.helpers.ISO8601DateFormat
 
ISO8601DateFormat(TimeZone) - Constructor for class org.apache.log4j.helpers.ISO8601DateFormat
 
isSevereLevel() - Method in class org.apache.log4j.lf5.LogRecord
Abstract method.
isSevereLevel() - Method in class org.apache.log4j.lf5.Log4JLogRecord
Determines which Priority levels will be displayed in colored font when the LogMonitorAppender renders this log message.
isTraceEnabled() - Method in class org.apache.log4j.Logger
Check whether this category is enabled for the TRACE Level.
isTriggeringEvent(LoggingEvent) - Method in interface org.apache.log4j.spi.TriggeringEventEvaluator
Is this the triggering event?

J

JDBCAppender - class org.apache.log4j.jdbc.JDBCAppender.
WARNING: This version of JDBCAppender is very likely to be completely replaced in the future.
JDBCAppender() - Constructor for class org.apache.log4j.jdbc.JDBCAppender
 
JMSAppender - class org.apache.log4j.net.JMSAppender.
A simple appender that publishes events to a JMS Topic.
JMSAppender() - Constructor for class org.apache.log4j.net.JMSAppender
 
JMSSink - class org.apache.log4j.net.JMSSink.
A simple application that consumes logging events sent by a JMSAppender.
JMSSink(String, String, String, String) - Constructor for class org.apache.log4j.net.JMSSink
 

L

l7dlog(Priority, String, Object[], Throwable) - Method in class org.apache.log4j.Category
Log a localized and parameterized message.
l7dlog(Priority, String, Throwable) - Method in class org.apache.log4j.Category
Log a localized message.
layout - Variable in class org.apache.log4j.AppenderSkeleton
The layout variable does not need to be set if the appender implementation has its own layout.
Layout - class org.apache.log4j.Layout.
Extend this abstract class to create your own log layout format.
Layout() - Constructor for class org.apache.log4j.Layout
 
LayoutDynamicMBean - class org.apache.log4j.jmx.LayoutDynamicMBean.
 
LayoutDynamicMBean(Layout) - Constructor for class org.apache.log4j.jmx.LayoutDynamicMBean
 
layoutNames - Variable in class org.apache.log4j.config.PropertyPrinter
 
length() - Method in class org.apache.log4j.helpers.CyclicBuffer
Get the number of elements in the buffer.
length() - Method in class org.apache.log4j.helpers.BoundedFIFO
Get the number of elements in the buffer.
level - Variable in class org.apache.log4j.Category
The assigned level of this category.
level - Variable in class org.apache.log4j.spi.LoggingEvent
Deprecated. This field will be marked as private in future releases. Please do not access it directly. Use the LoggingEvent.getLevel() method instead.
Level - class org.apache.log4j.Level.
Defines the minimum set of levels recognized by the system, that is OFF, FATAL, ERROR, WARN, INFODEBUG and ALL.
Level(int, String, int) - Constructor for class org.apache.log4j.Level
Instantiate a Level object.
LevelMatchFilter - class org.apache.log4j.varia.LevelMatchFilter.
This is a very simple filter based on level matching.
LevelMatchFilter() - Constructor for class org.apache.log4j.varia.LevelMatchFilter
 
LevelRangeFilter - class org.apache.log4j.varia.LevelRangeFilter.
This is a very simple filter based on level matching, which can be used to reject messages with priorities outside a certain range.
LevelRangeFilter() - Constructor for class org.apache.log4j.varia.LevelRangeFilter
 
LF5Appender - class org.apache.log4j.lf5.LF5Appender.
LF5Appender logs events to a swing based logging console.
LF5Appender() - Constructor for class org.apache.log4j.lf5.LF5Appender
Constructs a LF5Appender using the default instance of the LogBrokerMonitor.
LF5Appender(LogBrokerMonitor) - Constructor for class org.apache.log4j.lf5.LF5Appender
Constructs a LF5Appender using an instance of a LogBrokerMonitor supplied by the user.
LINE_SEP - Static variable in class org.apache.log4j.Layout
 
LINE_SEP_LEN - Static variable in class org.apache.log4j.Layout
 
ListVsVector - class org.apache.log4j.performance.ListVsVector.
Compares the performance of looping through a list versus a Vector.
ListVsVector() - Constructor for class org.apache.log4j.performance.ListVsVector
 
loadClass(String) - Static method in class org.apache.log4j.helpers.Loader
If running under JDK 1.2 load the specified class using the Thread contextClassLoader if that fails try Class.forname.
Loader - class org.apache.log4j.helpers.Loader.
Load resources (or images) from various sources.
Loader() - Constructor for class org.apache.log4j.helpers.Loader
 
LOCATION_INFO_OPTION - Static variable in class org.apache.log4j.HTMLLayout
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
LocationInfo - class org.apache.log4j.spi.LocationInfo.
The internal representation of caller location information.
LocationInfo(Throwable, String) - Constructor for class org.apache.log4j.spi.LocationInfo
Instantiate location information based on a Throwable.
LOG_AUTH - Static variable in class org.apache.log4j.net.SyslogAppender
security/authorization messages
LOG_AUTHPRIV - Static variable in class org.apache.log4j.net.SyslogAppender
security/authorization messages (private)
LOG_CRON - Static variable in class org.apache.log4j.net.SyslogAppender
clock daemon
LOG_DAEMON - Static variable in class org.apache.log4j.net.SyslogAppender
System daemons
LOG_FTP - Static variable in class org.apache.log4j.net.SyslogAppender
ftp daemon
LOG_KERN - Static variable in class org.apache.log4j.net.SyslogAppender
Kernel messages
LOG_LOCAL0 - Static variable in class org.apache.log4j.net.SyslogAppender
reserved for local use
LOG_LOCAL1 - Static variable in class org.apache.log4j.net.SyslogAppender
reserved for local use
LOG_LOCAL2 - Static variable in class org.apache.log4j.net.SyslogAppender
reserved for local use
LOG_LOCAL3 - Static variable in class org.apache.log4j.net.SyslogAppender
reserved for local use
LOG_LOCAL4 - Static variable in class org.apache.log4j.net.SyslogAppender
reserved for local use
LOG_LOCAL5 - Static variable in class org.apache.log4j.net.SyslogAppender
reserved for local use
LOG_LOCAL6 - Static variable in class org.apache.log4j.net.SyslogAppender
reserved for local use
LOG_LOCAL7 - Static variable in class org.apache.log4j.net.SyslogAppender
reserved for local use
LOG_LPR - Static variable in class org.apache.log4j.net.SyslogAppender
line printer subsystem
LOG_MAIL - Static variable in class org.apache.log4j.net.SyslogAppender
Mail system
LOG_NEWS - Static variable in class org.apache.log4j.net.SyslogAppender
network news subsystem
LOG_SYSLOG - Static variable in class org.apache.log4j.net.SyslogAppender
messages generated internally by syslogd
LOG_USER - Static variable in class org.apache.log4j.net.SyslogAppender
Random user-level messages
LOG_UUCP - Static variable in class org.apache.log4j.net.SyslogAppender
UUCP subsystem
log(Priority, Object) - Method in class org.apache.log4j.Category
This generic form is intended to be used by wrappers.
log(Priority, Object, Throwable) - Method in class org.apache.log4j.Category
This generic form is intended to be used by wrappers.
log(String, Priority, Object, Throwable) - Method in class org.apache.log4j.Category
This is the most generic printing method.
Log4jEntityResolver - class org.apache.log4j.xml.Log4jEntityResolver.
An EntityResolver specifically designed to return log4j.dtd which is embedded within the log4j jar file.
Log4jEntityResolver() - Constructor for class org.apache.log4j.xml.Log4jEntityResolver
 
Log4JLogRecord - class org.apache.log4j.lf5.Log4JLogRecord.
A Log4JLogRecord encapsulates the details of your log4j LoggingEvent in a format usable by the LogBrokerMonitor.
Log4JLogRecord() - Constructor for class org.apache.log4j.lf5.Log4JLogRecord
Constructs an instance of a Log4JLogRecord.
Logger - class org.apache.log4j.Logger.
This is the central class in the log4j package.
LOGGER_FACTORY_KEY - Static variable in class org.apache.log4j.PropertyConfigurator
Key for specifying the LoggerFactory.
Logger(String) - Constructor for class org.apache.log4j.Logger
 
LoggerDynamicMBean - class org.apache.log4j.jmx.LoggerDynamicMBean.
 
LoggerDynamicMBean(Logger) - Constructor for class org.apache.log4j.jmx.LoggerDynamicMBean
 
loggerFactory - Variable in class org.apache.log4j.PropertyConfigurator
 
LoggerFactory - interface org.apache.log4j.spi.LoggerFactory.
Implement this interface to create new instances of Logger or a sub-class of Logger.
LoggerRepository - interface org.apache.log4j.spi.LoggerRepository.
A LoggerRepository is used to create and retrieve Loggers.
LoggingEvent - class org.apache.log4j.spi.LoggingEvent.
The internal representation of logging events.
LoggingEvent(String, Category, long, Priority, Object, Throwable) - Constructor for class org.apache.log4j.spi.LoggingEvent
Instantiate a LoggingEvent from the supplied parameters.
LoggingEvent(String, Category, Priority, Object, Throwable) - Constructor for class org.apache.log4j.spi.LoggingEvent
Instantiate a LoggingEvent from the supplied parameters.
LogLevel - class org.apache.log4j.lf5.LogLevel.
The LogLevel class defines a set of standard logging levels.
LogLevel(String, int) - Constructor for class org.apache.log4j.lf5.LogLevel
 
LogLevelFormatException - exception org.apache.log4j.lf5.LogLevelFormatException.
Thrown to indicate that the client has attempted to convert a string to one the LogLevel types, but the string does not have the appropriate format.
LogLevelFormatException(String) - Constructor for class org.apache.log4j.lf5.LogLevelFormatException
 
LogLog - class org.apache.log4j.helpers.LogLog.
This class used to output log statements from within the log4j package.
LogLog() - Constructor for class org.apache.log4j.helpers.LogLog
 
LogManager - class org.apache.log4j.LogManager.
Use the LogManager class to retreive Logger instances or to operate on the current LoggerRepository.
LogManager() - Constructor for class org.apache.log4j.LogManager
 
LogRecord - class org.apache.log4j.lf5.LogRecord.
LogRecord.
LogRecord() - Constructor for class org.apache.log4j.lf5.LogRecord
 
LogRecordFilter - interface org.apache.log4j.lf5.LogRecordFilter.
An interface for classes which filters LogRecords.
lookup(Context, String) - Method in class org.apache.log4j.net.JMSAppender
 
lookup(Context, String) - Static method in class org.apache.log4j.net.JMSSink
 

M

Main - class org.apache.log4j.chainsaw.Main.
The main application.
main(String[]) - Static method in class org.apache.log4j.chainsaw.Main
The main method.
main(String[]) - Static method in class org.apache.log4j.config.PropertyPrinter
 
main(String[]) - Static method in class org.apache.log4j.lf5.LF5Appender
 
main(String[]) - Static method in class org.apache.log4j.lf5.StartLogFactor5
Main - starts a an instance of the LogFactor5 console and configures the console settings.
main(String[]) - Static method in class org.apache.log4j.net.SocketServer
 
main(String[]) - Static method in class org.apache.log4j.net.SimpleSocketServer
 
main(String[]) - Static method in class org.apache.log4j.net.JMSSink
 
main(String[]) - Static method in class org.apache.log4j.performance.ListVsVector
 
main(String[]) - Static method in class org.apache.log4j.performance.SystemTime
 
main(String[]) - Static method in class org.apache.log4j.performance.NewVsSetLen
 
main(String[]) - Static method in class org.apache.log4j.varia.Roller
Send a "RollOver" message to ExternallyRolledFileAppender on host and port.
main(String[]) - Static method in class org.apache.log4j.xml.examples.XMLSample
 
makeNewLoggerInstance(String) - Method in interface org.apache.log4j.spi.LoggerFactory
 
MAX_CAPACITY - Variable in class org.apache.log4j.PatternLayout
 
MAX_CAPACITY - Variable in class org.apache.log4j.HTMLLayout
 
maxBackupIndex - Variable in class org.apache.log4j.RollingFileAppender
There is one backup file by default.
maxFileSize - Variable in class org.apache.log4j.RollingFileAppender
The default maximum file size is 10MB.
MDC - class org.apache.log4j.MDC.
The MDC class is similar to the NDC class except that it is based on a map instead of a stack.
MessageRenderer - class org.apache.log4j.or.jms.MessageRenderer.
Render javax.jms.Message objects.
MessageRenderer() - Constructor for class org.apache.log4j.or.jms.MessageRenderer
 
MISSING_LAYOUT - Static variable in interface org.apache.log4j.spi.ErrorCode
 
msg - Variable in class org.apache.log4j.net.SMTPAppender
 

N

NA - Static variable in class org.apache.log4j.spi.LocationInfo
When location information is not available the constant NA is returned.
name - Variable in class org.apache.log4j.Category
The name of this category.
name - Variable in class org.apache.log4j.AppenderSkeleton
Appenders are named.
NDC - class org.apache.log4j.NDC.
The NDC 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.
NEUTRAL - Static variable in class org.apache.log4j.spi.Filter
This filter is neutral with respect to the log event.
NewVsSetLen - class org.apache.log4j.performance.NewVsSetLen.
This program compares the cost of creating a new StringBuffer and converting it to a String versus keeping the same StringBuffer, setting its size to zero and then converting it to String.
NewVsSetLen() - Constructor for class org.apache.log4j.performance.NewVsSetLen
 
next - Variable in class org.apache.log4j.helpers.PatternConverter
 
next - Variable in class org.apache.log4j.spi.Filter
Deprecated. As of 1.2.12, use Filter.getNext() and Filter.setNext(org.apache.log4j.spi.Filter) instead
nextElement() - Method in class org.apache.log4j.helpers.NullEnumeration
 
NOPWriter - class org.apache.log4j.performance.NOPWriter.
Extends Writer with methods that return immediately without doing anything.
NOPWriter() - Constructor for class org.apache.log4j.performance.NOPWriter
 
NTEventLogAppender - class org.apache.log4j.nt.NTEventLogAppender.
Append to the NT event log system.
NTEventLogAppender() - Constructor for class org.apache.log4j.nt.NTEventLogAppender
 
NTEventLogAppender(Layout) - Constructor for class org.apache.log4j.nt.NTEventLogAppender
 
NTEventLogAppender(String) - Constructor for class org.apache.log4j.nt.NTEventLogAppender
 
NTEventLogAppender(String, Layout) - Constructor for class org.apache.log4j.nt.NTEventLogAppender
 
NTEventLogAppender(String, String) - Constructor for class org.apache.log4j.nt.NTEventLogAppender
 
NTEventLogAppender(String, String, Layout) - Constructor for class org.apache.log4j.nt.NTEventLogAppender
 
NULL - Static variable in interface org.apache.log4j.spi.Configurator
Special level signifying inherited behaviour, same as Configurator.INHERITED.
NULL_ARG - Static variable in class org.apache.log4j.config.PropertyGetter
 
NULL_DATE_FORMAT - Static variable in class org.apache.log4j.helpers.DateLayout
String constant designating no time information.
NullAppender - class org.apache.log4j.performance.NullAppender.
A bogus appender which calls the format method of its layout object but does not write the result anywhere.
NullAppender - class org.apache.log4j.varia.NullAppender.
A NullAppender merely exists, it never outputs a message to any device.
NullAppender() - Constructor for class org.apache.log4j.performance.NullAppender
 
NullAppender() - Constructor for class org.apache.log4j.varia.NullAppender
 
NullAppender(Layout) - Constructor for class org.apache.log4j.performance.NullAppender
 
NullEnumeration - class org.apache.log4j.helpers.NullEnumeration.
An always-empty Enumerator.
numAppenders - Variable in class org.apache.log4j.config.PropertyPrinter
 

O

obj - Variable in class org.apache.log4j.config.PropertySetter
 
obj - Variable in class org.apache.log4j.config.PropertyGetter
 
ObjectRenderer - interface org.apache.log4j.or.ObjectRenderer.
Implement this interface in order to render objects as strings.
OFF - Static variable in class org.apache.log4j.Level
The OFF has the highest possible rank and is intended to turn off logging.
OFF_INT - Static variable in class org.apache.log4j.Priority
 
OK - Static variable in class org.apache.log4j.varia.ExternallyRolledFileAppender
The string constant sent to acknowledge a roll over.
OnlyOnceErrorHandler - class org.apache.log4j.helpers.OnlyOnceErrorHandler.
The OnlyOnceErrorHandler implements log4j's default error handling policy which consists of emitting a message for the first error in an appender and ignoring all following errors.
OnlyOnceErrorHandler() - Constructor for class org.apache.log4j.helpers.OnlyOnceErrorHandler
 
onMessage(Message) - Method in class org.apache.log4j.net.JMSSink
 
OptionConverter - class org.apache.log4j.helpers.OptionConverter.
A convenience class to convert property values to specific types.
OptionHandler - interface org.apache.log4j.spi.OptionHandler.
A string based interface to configure package components.
org.apache.log4j - package org.apache.log4j
The main log4j package.
org.apache.log4j.chainsaw - package org.apache.log4j.chainsaw
Chainsaw is a GUI log viewer and filter for the log4j package.
org.apache.log4j.config - package org.apache.log4j.config
Package used in getting/setting component properties.
org.apache.log4j.helpers - package org.apache.log4j.helpers
This package is used internally.
org.apache.log4j.jdbc - package org.apache.log4j.jdbc
The JDBCAppender provides for sending log events to a database.
org.apache.log4j.jmx - package org.apache.log4j.jmx
This package lets you manage log4j settings using JMX.
org.apache.log4j.lf5 - package org.apache.log4j.lf5
 
org.apache.log4j.net - package org.apache.log4j.net
Package for remote logging.
org.apache.log4j.nt - package org.apache.log4j.nt
Package for NT event logging.
org.apache.log4j.or - package org.apache.log4j.or
ObjectRenders are resposible for rendering messages depending on their class type.
org.apache.log4j.or.jms - package org.apache.log4j.or.jms
This package contains the MessageRenderer which renders objects of type javax.jms.Message.
org.apache.log4j.or.sax - package org.apache.log4j.or.sax
This package contains the AttributesRenderer which renders object of class org.xml.sax.Attributes.
org.apache.log4j.performance - package org.apache.log4j.performance
Package to measure the performance of the different log4j components.
org.apache.log4j.spi - package org.apache.log4j.spi
Contains part of the System Programming Interface (SPI) needed to extend log4j.
org.apache.log4j.varia - package org.apache.log4j.varia
Contains various appenders, filters and other odds and ends.
org.apache.log4j.xml - package org.apache.log4j.xml
XML based components.
org.apache.log4j.xml.examples - package org.apache.log4j.xml.examples
Example usage of log4j with XML (including source code).
out - Variable in class org.apache.log4j.config.PropertyPrinter
 
overrideAsNeeded(String) - Method in class org.apache.log4j.Hierarchy
Deprecated. Deprecated with no replacement.

P

parent - Variable in class org.apache.log4j.Category
The parent of this category.
parse() - Method in class org.apache.log4j.helpers.PatternParser
 
parse(Element) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to configure the log4j framework by parsing a DOM tree of XML elements based on log4j.dtd.
parse(String, ParsePosition) - Method in class org.apache.log4j.helpers.AbsoluteTimeDateFormat
This method does not do anything but return null.
parse(String, ParsePosition) - Method in class org.apache.log4j.helpers.ISO8601DateFormat
This method does not do anything but return null.
parse(String, ParsePosition) - Method in class org.apache.log4j.helpers.DateTimeDateFormat
This method does not do anything but return null.
parse(String, ParsePosition) - Method in class org.apache.log4j.helpers.RelativeTimeDateFormat
This method does not do anything but return null.
parseAppender(Element) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse an appender element.
parseCategory(Element) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse an category element.
parseCategoryFactory(Element) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse the category factory element.
parseCatsAndRenderers(Properties, LoggerRepository) - Method in class org.apache.log4j.PropertyConfigurator
Parse non-root elements, such non-root categories and renderers.
parseChildrenOfLoggerElement(Element, Logger, boolean) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse the children of a category element.
parseErrorHandler(Element, Appender) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse an ErrorHandler element.
parseFilters(Element, Appender) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse a filter element.
parseLayout(Element) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse a layout element.
parseLevel(Element, Logger, boolean) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse a level element.
parseRenderer(Element) - Method in class org.apache.log4j.xml.DOMConfigurator
 
parseRoot(Element) - Method in class org.apache.log4j.xml.DOMConfigurator
Used internally to parse the roor category element.
passes(LogRecord) - Method in interface org.apache.log4j.lf5.LogRecordFilter
 
passes(LogRecord) - Method in class org.apache.log4j.lf5.PassingLogRecordFilter
 
PassingLogRecordFilter - class org.apache.log4j.lf5.PassingLogRecordFilter.
An implementation of LogRecordFilter which always returns true.
PassingLogRecordFilter() - Constructor for class org.apache.log4j.lf5.PassingLogRecordFilter
 
pattern - Variable in class org.apache.log4j.helpers.PatternParser
 
PatternConverter - class org.apache.log4j.helpers.PatternConverter.
PatternConverter is an abtract class that provides the formatting functionality that derived classes need.
PatternConverter() - Constructor for class org.apache.log4j.helpers.PatternConverter
 
PatternConverter(FormattingInfo) - Constructor for class org.apache.log4j.helpers.PatternConverter
 
PatternLayout - class org.apache.log4j.PatternLayout.
A flexible layout configurable with pattern string.
PatternLayout() - Constructor for class org.apache.log4j.PatternLayout
Constructs a PatternLayout using the DEFAULT_LAYOUT_PATTERN.
PatternLayout(String) - Constructor for class org.apache.log4j.PatternLayout
Constructs a PatternLayout using the supplied conversion pattern.
patternLength - Variable in class org.apache.log4j.helpers.PatternParser
 
PatternParser - class org.apache.log4j.helpers.PatternParser.
Most of the work of the PatternLayout class is delegated to the PatternParser class.
PatternParser(String) - Constructor for class org.apache.log4j.helpers.PatternParser
 
peek() - Static method in class org.apache.log4j.NDC
Looks at the last diagnostic context at the top of this NDC without removing it.
pop() - Static method in class org.apache.log4j.NDC
Clients should call this method before leaving a diagnostic context.
PORT_PROP_NAME - Static variable in class org.apache.log4j.chainsaw.Main
name of property for port name
pos - Variable in class org.apache.log4j.helpers.DateLayout
 
postDeregister() - Method in class org.apache.log4j.jmx.AbstractDynamicMBean
 
postRegister(Boolean) - Method in class org.apache.log4j.jmx.AbstractDynamicMBean
 
postRegister(Boolean) - Method in class org.apache.log4j.jmx.LoggerDynamicMBean
 
postRegister(Boolean) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
preDeregister() - Method in class org.apache.log4j.jmx.AbstractDynamicMBean
 
preRegister(MBeanServer, ObjectName) - Method in class org.apache.log4j.jmx.AbstractDynamicMBean
 
preRegister(MBeanServer, ObjectName) - Method in class org.apache.log4j.jmx.AppenderDynamicMBean
 
print(PrintWriter) - Method in class org.apache.log4j.config.PropertyPrinter
Prints the configuration of the default log4j hierarchy as a Java properties file on the specified Writer.
printOptions(PrintWriter, Logger) - Method in class org.apache.log4j.config.PropertyPrinter
 
printOptions(PrintWriter, Object, String) - Method in class org.apache.log4j.config.PropertyPrinter
 
Priority - class org.apache.log4j.Priority.
Refrain from using this class directly, use the Level class instead.
Priority() - Constructor for class org.apache.log4j.Priority
Default constructor for deserialization.
Priority(int, String, int) - Constructor for class org.apache.log4j.Priority
Instantiate a level object.
PropertyConfigurator - class org.apache.log4j.PropertyConfigurator.
Allows the configuration of log4j from an external file.
PropertyConfigurator() - Constructor for class org.apache.log4j.PropertyConfigurator
 
PropertyGetter - class org.apache.log4j.config.PropertyGetter.
Used for inferring configuration information for a log4j's component.
PropertyGetter.PropertyCallback - interface org.apache.log4j.config.PropertyGetter.PropertyCallback.
 
PropertyGetter(Object) - Constructor for class org.apache.log4j.config.PropertyGetter
Create a new PropertyGetter for the specified Object.
PropertyPrinter - class org.apache.log4j.config.PropertyPrinter.
Prints the configuration of the log4j default hierarchy (which needs to be auto-initialized) as a propoperties file on a PrintWriter.
PropertyPrinter(PrintWriter) - Constructor for class org.apache.log4j.config.PropertyPrinter
 
PropertyPrinter(PrintWriter, boolean) - Constructor for class org.apache.log4j.config.PropertyPrinter
 
PropertySetter - class org.apache.log4j.config.PropertySetter.
General purpose Object property setter.
PropertySetter(Object) - Constructor for class org.apache.log4j.config.PropertySetter
Create a new PropertySetter for the specified Object.
PropertySetterException - exception org.apache.log4j.config.PropertySetterException.
Thrown when an error is encountered whilst attempting to set a property using the PropertySetter utility class.
PropertySetterException(String) - Constructor for class org.apache.log4j.config.PropertySetterException
 
PropertySetterException(Throwable) - Constructor for class org.apache.log4j.config.PropertySetterException
 
props - Variable in class org.apache.log4j.config.PropertySetter
 
props - Variable in class org.apache.log4j.config.PropertyGetter
 
push(String) - Static method in class org.apache.log4j.NDC
Push new diagnostic context information for the current thread.
put(Class, ObjectRenderer) - Method in class org.apache.log4j.or.RendererMap
Register an ObjectRenderer for clazz.
put(LoggingEvent) - Method in class org.apache.log4j.helpers.BoundedFIFO
Place a LoggingEvent in the buffer.
put(String, Object) - Static method in class org.apache.log4j.MDC
Put a context value (the o parameter) as identified with the key parameter into the current thread's context map.

Q

QuietWriter - class org.apache.log4j.helpers.QuietWriter.
QuietWriter does not throw exceptions when things go wrong.
QuietWriter(Writer, ErrorHandler) - Constructor for class org.apache.log4j.helpers.QuietWriter
 
qw - Variable in class org.apache.log4j.WriterAppender
This is the quietWriter where we will write to.

R

register(List) - Static method in class org.apache.log4j.lf5.LogLevel
 
register(LogLevel) - Static method in class org.apache.log4j.lf5.LogLevel
Registers a used defined LogLevel.
register(LogLevel[]) - Static method in class org.apache.log4j.lf5.LogLevel
 
registry - Variable in class org.apache.log4j.PropertyConfigurator
Used internally to keep track of configured appenders.
RELATIVE_TIME_DATE_FORMAT - Static variable in class org.apache.log4j.helpers.DateLayout
String constant designating relative time.
RelativeTimeDateFormat - class org.apache.log4j.helpers.RelativeTimeDateFormat.
Formats a Date by printing the number of milliseconds elapsed since construction of the format.
RelativeTimeDateFormat() - Constructor for class org.apache.log4j.helpers.RelativeTimeDateFormat
 
ReloadingPropertyConfigurator - class org.apache.log4j.varia.ReloadingPropertyConfigurator.
 
ReloadingPropertyConfigurator() - Constructor for class org.apache.log4j.varia.ReloadingPropertyConfigurator
 
remove() - Static method in class org.apache.log4j.NDC
Remove the diagnostic context for this thread.
remove(String) - Static method in class org.apache.log4j.MDC
Remove the the context identified by the key parameter.
removeAllAppenders() - Method in class org.apache.log4j.Category
Remove all previously added appenders from this Category instance.
removeAllAppenders() - Method in class org.apache.log4j.AsyncAppender
Removes and closes all attached appenders.
removeAllAppenders() - Method in class org.apache.log4j.helpers.AppenderAttachableImpl
Remove and close all previously attached appenders.
removeAllAppenders() - Method in interface org.apache.log4j.spi.AppenderAttachable
Remove all previously added appenders.
removeAppender(Appender) - Method in class org.apache.log4j.Category
Remove the appender passed as parameter form the list of appenders.
removeAppender(Appender) - Method in class org.apache.log4j.AsyncAppender
Removes an appender.
removeAppender(Appender) - Method in class org.apache.log4j.helpers.AppenderAttachableImpl
Remove the appender passed as parameter form the list of attached appenders.
removeAppender(Appender) - Method in interface org.apache.log4j.spi.AppenderAttachable
Remove the appender passed as parameter from the list of appenders.
removeAppender(String) - Method in class org.apache.log4j.Category
Remove the appender with the name passed as parameter form the list of appenders.
removeAppender(String) - Method in class org.apache.log4j.AsyncAppender
Remove appender by name.
removeAppender(String) - Method in class org.apache.log4j.helpers.AppenderAttachableImpl
Remove the appender with the name passed as parameter form the list of appenders.
removeAppender(String) - Method in interface org.apache.log4j.spi.AppenderAttachable
Remove the appender with the name passed as parameter from the list of appenders.
removeAppenderEvent(Category, Appender) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
removeAppenderEvent(Category, Appender) - Method in interface org.apache.log4j.spi.HierarchyEventListener
 
removeNotificationListener(NotificationListener) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
removes - Variable in class org.apache.log4j.jdbc.JDBCAppender
Helper object for clearing out the buffer
RendererMap - class org.apache.log4j.or.RendererMap.
Map class objects to an ObjectRenderer.
RendererMap() - Constructor for class org.apache.log4j.or.RendererMap
 
RendererSupport - interface org.apache.log4j.spi.RendererSupport.
 
ReportParserError - class org.apache.log4j.xml.examples.ReportParserError.
This class is needed for validating a log4j.dtd derived XML file.
ReportParserError() - Constructor for class org.apache.log4j.xml.examples.ReportParserError
 
repository - Variable in class org.apache.log4j.Category
 
RepositorySelector - interface org.apache.log4j.spi.RepositorySelector.
The LogManager uses one (and only one) RepositorySelector implementation to select the LoggerRepository for a particular application context.
requiresLayout() - Method in class org.apache.log4j.WriterAppender
The WriterAppender requires a layout.
requiresLayout() - Method in interface org.apache.log4j.Appender
Configurators call this method to determine if the appender requires a layout.
requiresLayout() - Method in class org.apache.log4j.AsyncAppender
{@inheritDoc}
requiresLayout() - Method in class org.apache.log4j.jdbc.JDBCAppender
JDBCAppender requires a layout.
requiresLayout() - Method in class org.apache.log4j.lf5.LF5Appender
Returns a value that indicates whether this appender requires a Layout.
requiresLayout() - Method in class org.apache.log4j.net.SocketHubAppender
The SocketHubAppender does not use a layout.
requiresLayout() - Method in class org.apache.log4j.net.SyslogAppender
The SyslogAppender requires a layout.
requiresLayout() - Method in class org.apache.log4j.net.SMTPAppender
The SMTPAppender requires a layout.
requiresLayout() - Method in class org.apache.log4j.net.JMSAppender
The JMSAppender sends serialized events and consequently does not require a layout.
requiresLayout() - Method in class org.apache.log4j.net.TelnetAppender
This appender requires a layout to format the text to the attached client(s).
requiresLayout() - Method in class org.apache.log4j.net.SocketAppender
The SocketAppender does not use a layout.
requiresLayout() - Method in class org.apache.log4j.nt.NTEventLogAppender
The NTEventLogAppender requires a layout.
requiresLayout() - Method in class org.apache.log4j.performance.NullAppender
This is a bogus appender but it still uses a layout.
requiresLayout() - Method in class org.apache.log4j.varia.NullAppender
NullAppenders do not need a layout.
reset() - Method in class org.apache.log4j.WriterAppender
Clear internal references to the writer and other variables.
reset() - Method in class org.apache.log4j.FileAppender
Close any previously opened file and call the parent's reset.
reset() - Method in class org.apache.log4j.lf5.PassingLogRecordFilter
Does nothing.
resetConfiguration() - Static method in class org.apache.log4j.LogManager
 
resetConfiguration() - Method in class org.apache.log4j.Hierarchy
Reset all values contained in this hierarchy instance to their default.
resetConfiguration() - Static method in class org.apache.log4j.BasicConfigurator
Reset the default hierarchy to its defaut.
resetConfiguration() - Method in interface org.apache.log4j.spi.LoggerRepository
 
resetLogLevelColorMap() - Static method in class org.apache.log4j.lf5.LogLevel
 
resetSequenceNumber() - Static method in class org.apache.log4j.lf5.LogRecord
Resets that sequence number to 0.
resize(int) - Method in class org.apache.log4j.helpers.CyclicBuffer
Resize the cyclic buffer to newSize.
resize(int) - Method in class org.apache.log4j.helpers.BoundedFIFO
Resize the buffer to a new size.
resolveEntity(String, String) - Method in class org.apache.log4j.xml.Log4jEntityResolver
 
resourceBundle - Variable in class org.apache.log4j.Category
 
ROLL_OVER - Static variable in class org.apache.log4j.varia.ExternallyRolledFileAppender
The string constant sent to initiate a roll over.
Roller - class org.apache.log4j.varia.Roller.
A simple application to send roll over messages to a potentially remote ExternallyRolledFileAppender.
RollingFileAppender - class org.apache.log4j.RollingFileAppender.
RollingFileAppender extends FileAppender to backup the log files when they reach a certain size.
RollingFileAppender() - Constructor for class org.apache.log4j.RollingFileAppender
The default constructor simply calls its parents constructor.
RollingFileAppender(Layout, String) - Constructor for class org.apache.log4j.RollingFileAppender
Instantiate a FileAppender and open the file designated by filename.
RollingFileAppender(Layout, String, boolean) - Constructor for class org.apache.log4j.RollingFileAppender
Instantiate a RollingFileAppender and open the file designated by filename.
rollOver() - Method in class org.apache.log4j.RollingFileAppender
Implements the usual roll over behaviour.
RootCategory - class org.apache.log4j.spi.RootCategory.
Deprecated. Replaced by RootLogger.
RootCategory(Level) - Constructor for class org.apache.log4j.spi.RootCategory
Deprecated. The root category names itself as "root".
rootCause - Variable in class org.apache.log4j.config.PropertySetterException
 
RootLogger - class org.apache.log4j.spi.RootLogger.
RootLogger sits at the top of the logger hierachy.
RootLogger(Level) - Constructor for class org.apache.log4j.spi.RootLogger
The root logger names itself as "root".
run() - Method in class org.apache.log4j.helpers.FileWatchdog
 
run() - Method in class org.apache.log4j.net.SocketNode
 
run() - Method in class org.apache.log4j.net.TelnetAppender.SocketHandler
Continually accepts client connections.

S

s - Static variable in class org.apache.log4j.performance.NullAppender
 
SAXErrorHandler - class org.apache.log4j.xml.SAXErrorHandler.
 
SAXErrorHandler() - Constructor for class org.apache.log4j.xml.SAXErrorHandler
 
selectAndConfigure(URL, String, LoggerRepository) - Static method in class org.apache.log4j.helpers.OptionConverter
Configure log4j given a URL.
send(String) - Method in class org.apache.log4j.net.TelnetAppender.SocketHandler
sends a message to each of the clients in telnet-friendly output.
sendBuffer() - Method in class org.apache.log4j.net.SMTPAppender
Send the contents of the cyclic buffer as an e-mail message.
setAcceptOnMatch(boolean) - Method in class org.apache.log4j.varia.StringMatchFilter
 
setAcceptOnMatch(boolean) - Method in class org.apache.log4j.varia.LevelMatchFilter
 
setAcceptOnMatch(boolean) - Method in class org.apache.log4j.varia.LevelRangeFilter
Set the AcceptOnMatch option.
setAdditivity(boolean) - Method in class org.apache.log4j.Category
Set the additivity flag for this Category instance.
setAppend(boolean) - Method in class org.apache.log4j.FileAppender
The Append option takes a boolean value.
setAppender(Appender) - Method in class org.apache.log4j.helpers.OnlyOnceErrorHandler
Does not do anything.
setAppender(Appender) - Method in interface org.apache.log4j.spi.ErrorHandler
Set the appender for which errors are handled.
setAppender(Appender) - Method in class org.apache.log4j.varia.FallbackErrorHandler
The appender to which this error handler is attached.
setAttribute(Attribute) - Method in class org.apache.log4j.jmx.LoggerDynamicMBean
 
setAttribute(Attribute) - Method in class org.apache.log4j.jmx.LayoutDynamicMBean
 
setAttribute(Attribute) - Method in class org.apache.log4j.jmx.AppenderDynamicMBean
 
setAttribute(Attribute) - Method in class org.apache.log4j.jmx.HierarchyDynamicMBean
 
setAttributes(AttributeList) - Method in class org.apache.log4j.jmx.AbstractDynamicMBean
Sets the values of several attributes of the Dynamic MBean, and returns the list of attributes that have been set.
setBackupAppender(Appender) - Method in class org.apache.log4j.helpers.OnlyOnceErrorHandler
Does not do anything.
setBackupAppender(Appender) - Method in interface org.apache.log4j.spi.ErrorHandler
Set the appender to falkback upon in case of failure.
setBackupAppender(Appender) - Method in class org.apache.log4j.varia.FallbackErrorHandler
Set the backup appender.
setBcc(String) - Method in class org.apache.log4j.net.SMTPAppender
Set the bcc recipient addresses.
setBlocking(boolean) - Method in class org.apache.log4j.AsyncAppender
Sets whether appender should wait if there is no space available in the event buffer or immediately return.
setBufferedIO(boolean) - Method in class org.apache.log4j.FileAppender
The BufferedIO option takes a boolean value.
setBufferSize(int) - Method in class org.apache.log4j.FileAppender
Set the size of the IO buffer.
setBufferSize(int) - Method in class org.apache.log4j.AsyncAppender
Sets the number of messages allowed in the event buffer before the calling thread is blocked (if blocking is true) or until messages are summarized and discarded.
setBufferSize(int) - Method in class org.apache.log4j.jdbc.JDBCAppender
 
setBufferSize(int) - Method in class org.apache.log4j.net.SMTPAppender
The BufferSize option takes a positive integer representing the maximum number of logging events to collect in a cyclic buffer.
setCallSystemExitOnClose(boolean) - Method in class org.apache.log4j.lf5.LF5Appender
This method is used to set the property that controls whether the LogBrokerMonitor is hidden or closed when a user exits the monitor.
setCategory(String) - Method in class org.apache.log4j.lf5.LogRecord
Set the category associated with this LogRecord.
setCategoryPrefixing(boolean) - Method in class org.apache.log4j.TTCCLayout
The CategoryPrefixing option specifies whether Category name is part of log output or not.
setCc(String) - Method in class org.apache.log4j.net.SMTPAppender
Set the cc recipient addresses.
setContextPrinting(boolean) - Method in class org.apache.log4j.TTCCLayout
The ContextPrinting option specifies log output will include the nested context information belonging to the current thread.
setConversionPattern(String) - Method in class org.apache.log4j.PatternLayout
Set the ConversionPattern option.
setCount(long) - Method in class org.apache.log4j.helpers.CountingQuietWriter
 
setDateFormat(DateFormat, TimeZone) - Method in class org.apache.log4j.helpers.DateLayout
Sets the DateFormat used to format time and date in the zone determined by timeZone.
setDateFormat(String) - Method in class org.apache.log4j.helpers.DateLayout
The value of the DateFormat option should be either an argument to the constructor of SimpleDateFormat or one of the srings "NULL", "RELATIVE", "ABSOLUTE", "DATE" or "ISO8601.
setDateFormat(String, TimeZone) - Method in class org.apache.log4j.helpers.DateLayout
Sets the DateFormat used to format date and time in the time zone determined by timeZone parameter.
setDatePattern(String) - Method in class org.apache.log4j.DailyRollingFileAppender
The DatePattern takes a string in the same format as expected by SimpleDateFormat.
setDelay(long) - Method in class org.apache.log4j.helpers.FileWatchdog
Set the delay to observe between each check of the file changes.
setDisableOverride(String) - Method in class org.apache.log4j.Hierarchy
Deprecated. Deprecated with no replacement.
setDriver(String) - Method in class org.apache.log4j.jdbc.JDBCAppender
Ensures that the given driver class has been loaded for sql connection creation.
setEncoding(String) - Method in class org.apache.log4j.WriterAppender
 
setErrorHandler(ErrorHandler) - Method in class org.apache.log4j.AppenderSkeleton
Set the ErrorHandler for this Appender.
setErrorHandler(ErrorHandler) - Method in class org.apache.log4j.WriterAppender
Set the ErrorHandler for this WriterAppender and also the underlying QuietWriter if any.
setErrorHandler(ErrorHandler) - Method in interface org.apache.log4j.Appender
Set the ErrorHandler for this appender.
setErrorHandler(ErrorHandler) - Method in class org.apache.log4j.helpers.QuietWriter
 
setEvaluatorClass(String) - Method in class org.apache.log4j.net.SMTPAppender
The EvaluatorClass option takes a string value representing the name of the class implementing the TriggeringEventEvaluator interface.
setFacility(String) - Method in class org.apache.log4j.net.SyslogAppender
Set the syslog facility.
setFacilityPrinting(boolean) - Method in class org.apache.log4j.net.SyslogAppender
If the FacilityPrinting option is set to true, the printed message will include the facility name of the application.
setFile(String) - Method in class org.apache.log4j.FileAppender
The File property takes a string value which should be the name of the file to append to.
setFile(String, boolean, boolean, int) - Method in class org.apache.log4j.FileAppender
Sets and opens the file where the log output will go.
setFile(String, boolean, boolean, int) - Method in class org.apache.log4j.RollingFileAppender
 
setFollow(boolean) - Method in class org.apache.log4j.ConsoleAppender
Sets whether the appender honors reassignments of System.out or System.err made after configuration.
setFrom(String) - Method in class org.apache.log4j.net.SMTPAppender
The From option takes a string value which should be a e-mail address of the sender.
setImmediateFlush(boolean) - Method in class org.apache.log4j.WriterAppender
If the ImmediateFlush option is set to true, the appender will flush at the end of each write.
setInitialContextFactoryName(String) - Method in class org.apache.log4j.net.JMSAppender
Setting the InitialContextFactoryName method will cause this JMSAppender instance to use the InitialContext.InitialContext(Hashtable) method instead of the no-argument constructor.
setInternalDebugging(boolean) - Static method in class org.apache.log4j.helpers.LogLog
Allows to enable/disable log4j internal logging.
setLayout(Layout) - Method in class org.apache.log4j.AppenderSkeleton
Set the layout for this appender.
setLayout(Layout) - Method in interface org.apache.log4j.Appender
Set the Layout for this appender.
setLevel(int) - Method in class org.apache.log4j.helpers.SyslogQuietWriter
 
setLevel(Level) - Method in class org.apache.log4j.Category
Set the level of this Category.
setLevel(Level) - Method in class org.apache.log4j.spi.RootLogger
Setting a null value to the level of the root logger may have catastrophic results.
setLevel(Level) - Method in class org.apache.log4j.spi.RootCategory
Deprecated. Setting a null value to the level of the root category may have catastrophic results.
setLevel(LogLevel) - Method in class org.apache.log4j.lf5.LogRecord
Set the level of this LogRecord.
setLevelMax(Level) - Method in class org.apache.log4j.varia.LevelRangeFilter
Set the LevelMax option.
setLevelMin(Level) - Method in class org.apache.log4j.varia.LevelRangeFilter
Set the LevelMin option.
setLevelToMatch(String) - Method in class org.apache.log4j.varia.LevelMatchFilter
 
setLocation(String) - Method in class org.apache.log4j.lf5.LogRecord
Set the location in code where this LogRecord originated.
setLocationInfo(boolean) - Method in class org.apache.log4j.HTMLLayout
The LocationInfo option takes a boolean value.
setLocationInfo(boolean) - Method in class org.apache.log4j.AsyncAppender
The LocationInfo option takes a boolean value.
setLocationInfo(boolean) - Method in class org.apache.log4j.net.SocketHubAppender
The LocationInfo option takes a boolean value.
setLocationInfo(boolean) - Method in class org.apache.log4j.net.SMTPAppender
The LocationInfo option takes a boolean value.
setLocationInfo(boolean) - Method in class org.apache.log4j.net.JMSAppender
If true, the information sent to the remote subscriber will include caller's location information.
setLocationInfo(boolean) - Method in class org.apache.log4j.net.SocketAppender
The LocationInfo option takes a boolean value.
setLocationInfo(boolean) - Method in class org.apache.log4j.xml.XMLLayout
The LocationInfo option takes a boolean value.
setLogger(Logger) - Method in class org.apache.log4j.helpers.OnlyOnceErrorHandler
Does not do anything.
setLogger(Logger) - Method in interface org.apache.log4j.spi.ErrorHandler
Add a reference to a logger to which the failing appender might be attached to.
setLogger(Logger) - Method in class org.apache.log4j.varia.FallbackErrorHandler
Adds the logger passed as parameter to the list of loggers that we need to search for in case of appender failure.
setLogLevelColorMap(LogLevel, Color) - Method in class org.apache.log4j.lf5.LogLevel
 
setMaxBackupIndex(int) - Method in class org.apache.log4j.RollingFileAppender
Set the maximum number of backup files to keep around.
setMaxDepth(int) - Static method in class org.apache.log4j.NDC
Set maximum depth of this diagnostic context.
setMaxFileSize(String) - Method in class org.apache.log4j.RollingFileAppender
Set the maximum size that the output file is allowed to reach before being rolled over to backup files.
setMaximumFileSize(long) - Method in class org.apache.log4j.RollingFileAppender
Set the maximum size that the output file is allowed to reach before being rolled over to backup files.
setMaxNumberOfRecords(int) - Method in class org.apache.log4j.lf5.LF5Appender
 
setMessage(String) - Method in class org.apache.log4j.lf5.LogRecord
Set the message associated with this LogRecord.
setMillis(long) - Method in class org.apache.log4j.lf5.LogRecord
Set the event time of this record.
setName(String) - Method in class org.apache.log4j.AppenderSkeleton
Set the name of this Appender.
setName(String) - Method in interface org.apache.log4j.Appender
Set the name of this appender.
setNDC(String) - Method in class org.apache.log4j.lf5.LogRecord
Set the NDC (nested diagnostic context) for this record.
setNext(Filter) - Method in class org.apache.log4j.spi.Filter
Set the next filter pointer.
setOption(String, String) - Method in class org.apache.log4j.helpers.DateLayout
Deprecated. Use the setter method for the option directly instead of the generic setOption method.
setOption(String, String) - Method in class org.apache.log4j.varia.DenyAllFilter
Deprecated. Use the setter method for the option directly instead of the generic setOption method.
setOption(String, String) - Method in class org.apache.log4j.varia.StringMatchFilter
Deprecated. Use the setter method for the option directly instead of the generic setOption method.
setParameter(Element, PropertySetter) - Method in class org.apache.log4j.xml.DOMConfigurator
 
setPassword(String) - Method in class org.apache.log4j.jdbc.JDBCAppender
 
setPassword(String) - Method in class org.apache.log4j.net.JMSAppender
The paswword to use when creating a topic session.
setPort(int) - Method in class org.apache.log4j.net.SocketHubAppender
The Port option takes a positive integer representing the port where the server is waiting for connections.
setPort(int) - Method in class org.apache.log4j.net.TelnetAppender
 
setPort(int) - Method in class org.apache.log4j.net.SocketAppender
The Port option takes a positive integer representing the port where the server is waiting for connections.
setPort(int) - Method in class org.apache.log4j.varia.ExternallyRolledFileAppender
The Port [roperty is used for setting the port for listening to external roll over messages.
setPriority(Level) - Method in class org.apache.log4j.spi.RootCategory
Deprecated.  
setPriority(Priority) - Method in class org.apache.log4j.Category
Deprecated. Please use Category.setLevel(org.apache.log4j.Level) instead.
setProperties(Object, Properties, String) - Static method in class org.apache.log4j.config.PropertySetter
Set the properties of an object passed as a parameter in one go.
setProperties(Properties, String) - Method in class org.apache.log4j.config.PropertySetter
Set the properites for the object that match the prefix passed as parameter.
setProperty(PropertyDescriptor, String, String) - Method in class org.apache.log4j.config.PropertySetter
Set the named property given a PropertyDescriptor.
setProperty(String, String) - Method in class org.apache.log4j.config.PropertySetter
Set a property on this PropertySetter's Object.
setProviderURL(String) - Method in class org.apache.log4j.net.JMSAppender
 
setQuietMode(boolean) - Static method in class org.apache.log4j.helpers.LogLog
In quite mode no LogLog generates strictly no output, not even for errors.
setQWForFiles(Writer) - Method in class org.apache.log4j.FileAppender
Sets the quiet writer being used.
setQWForFiles(Writer) - Method in class org.apache.log4j.RollingFileAppender
 
setReconnectionDelay(int) - Method in class org.apache.log4j.net.SocketAppender
The ReconnectionDelay option takes a positive integer representing the number of milliseconds to wait between each failed connection attempt to the server.
setRemoteHost(String) - Method in class org.apache.log4j.net.SocketAppender
The RemoteHost option takes a string value which should be the host name of the server where a SocketNode is running.
setRenderer(Class, ObjectRenderer) - Method in class org.apache.log4j.Hierarchy
Used by subclasses to add a renderer to the hierarchy passed as parameter.
setRenderer(Class, ObjectRenderer) - Method in interface org.apache.log4j.spi.RendererSupport
 
setRepositorySelector(RepositorySelector, Object) - Static method in class org.apache.log4j.LogManager
Sets LoggerFactory but only if the correct guard is passed as parameter.
setResourceBundle(ResourceBundle) - Method in class org.apache.log4j.Category
Set the resource bundle to be used with localized logging methods Category.l7dlog(Priority,String,Throwable) and Category.l7dlog(Priority,String,Object[],Throwable).
setSecurityCredentials(String) - Method in class org.apache.log4j.net.JMSAppender
 
setSecurityPrincipalName(String) - Method in class org.apache.log4j.net.JMSAppender
 
setSequenceNumber(long) - Method in class org.apache.log4j.lf5.LogRecord
Set the sequence number assocsiated with this LogRecord.
setSMTPDebug(boolean) - Method in class org.apache.log4j.net.SMTPAppender
Setting the SmtpDebug option to true will cause the mail session to log its server interaction to stdout.
setSMTPHost(String) - Method in class org.apache.log4j.net.SMTPAppender
The SMTPHost option takes a string value which should be a the host name of the SMTP server that will send the e-mail message.
setSMTPPassword(String) - Method in class org.apache.log4j.net.SMTPAppender
The SmtpPassword option takes a string value which should be the password required to authenticate against the mail server.
setSMTPUsername(String) - Method in class org.apache.log4j.net.SMTPAppender
The SmtpUsername option takes a string value which should be the username required to authenticate against the mail server.
setSource(String) - Method in class org.apache.log4j.nt.NTEventLogAppender
The Source option which names the source of the event.
setSql(String) - Method in class org.apache.log4j.jdbc.JDBCAppender
 
setStringToMatch(String) - Method in class org.apache.log4j.varia.StringMatchFilter
 
setSubject(String) - Method in class org.apache.log4j.net.SMTPAppender
The Subject option takes a string value which should be a the subject of the e-mail message.
setSyslogFacility(int) - Method in class org.apache.log4j.helpers.SyslogQuietWriter
 
setSyslogHost(String) - Method in class org.apache.log4j.net.SyslogAppender
The SyslogHost option is the name of the the syslog host where log output should go.
setTarget(String) - Method in class org.apache.log4j.ConsoleAppender
Sets the value of the Target option.
setThreadDescription(String) - Method in class org.apache.log4j.lf5.LogRecord
Set the thread description associated with this LogRecord.
setThreadPrinting(boolean) - Method in class org.apache.log4j.TTCCLayout
The ThreadPrinting option specifies whether the name of the current thread is part of log output or not.
setThreshold(Level) - Method in class org.apache.log4j.Hierarchy
Enable logging for logging requests with level l or higher.
setThreshold(Level) - Method in interface org.apache.log4j.spi.LoggerRepository
Set the repository-wide threshold.
setThreshold(Priority) - Method in class org.apache.log4j.AppenderSkeleton
Set the threshold level.
setThreshold(String) - Method in class org.apache.log4j.Hierarchy
The string form of Hierarchy.setThreshold(Level).
setThreshold(String) - Method in interface org.apache.log4j.spi.LoggerRepository
Another form of LoggerRepository.setThreshold(Level) accepting a string parameter instead of a Level.
setThrown(Throwable) - Method in class org.apache.log4j.lf5.LogRecord
Set the Throwable associated with this LogRecord.
setThrownStackTrace(String) - Method in class org.apache.log4j.lf5.LogRecord
Set the ThrownStackTrace for the log record.
setThrownStackTrace(ThrowableInformation) - Method in class org.apache.log4j.lf5.Log4JLogRecord
Set stack trace information associated with this Log4JLogRecord.
setTimeZone(String) - Method in class org.apache.log4j.helpers.DateLayout
The TimeZoneID option is a time zone ID string in the format expected by the TimeZone.getTimeZone(java.lang.String) method.
setTitle(String) - Method in class org.apache.log4j.HTMLLayout
The Title option takes a String value.
setTo(String) - Method in class org.apache.log4j.net.SMTPAppender
The To option takes a string value which should be a comma separated list of e-mail address of the recipients.
setTopicBindingName(String) - Method in class org.apache.log4j.net.JMSAppender
The TopicBindingName option takes a string value.
setTopicConnectionFactoryBindingName(String) - Method in class org.apache.log4j.net.JMSAppender
The TopicConnectionFactoryBindingName option takes a string value.
setURL(String) - Method in class org.apache.log4j.jdbc.JDBCAppender
 
setURLPkgPrefixes(String) - Method in class org.apache.log4j.net.JMSAppender
 
setUser(String) - Method in class org.apache.log4j.jdbc.JDBCAppender
 
setUserName(String) - Method in class org.apache.log4j.net.JMSAppender
The user name to use when creating a topic session.
setWriter(Writer) - Method in class org.apache.log4j.WriterAppender
Sets the Writer where the log output will go.
SEVERE - Static variable in class org.apache.log4j.lf5.LogLevel
 
shutdown() - Static method in class org.apache.log4j.Category
Deprecated. Please use LogManager.shutdown() instead.
shutdown() - Static method in class org.apache.log4j.LogManager
 
shutdown() - Method in class org.apache.log4j.Hierarchy
Shutting down a hierarchy will safely close and remove all appenders in all categories including the root logger.
shutdown() - Method in interface org.apache.log4j.spi.LoggerRepository
 
SimpleLayout - class org.apache.log4j.SimpleLayout.
SimpleLayout consists of the level of the log statement, followed by " - " and then the log message itself.
SimpleLayout() - Constructor for class org.apache.log4j.SimpleLayout
 
SimpleSocketServer - class org.apache.log4j.net.SimpleSocketServer.
A simple SocketNode based server.
SimpleSocketServer() - Constructor for class org.apache.log4j.net.SimpleSocketServer
 
SMTPAppender - class org.apache.log4j.net.SMTPAppender.
Send an e-mail when a specific logging event occurs, typically on errors or fatal errors.
SMTPAppender() - Constructor for class org.apache.log4j.net.SMTPAppender
The default constructor will instantiate the appender with a TriggeringEventEvaluator that will trigger on events with level ERROR or higher.
SMTPAppender(TriggeringEventEvaluator) - Constructor for class org.apache.log4j.net.SMTPAppender
Use evaluator passed as parameter as the TriggeringEventEvaluator for this SMTPAppender.
SocketAppender - class org.apache.log4j.net.SocketAppender.
Sends LoggingEvent objects to a remote a log server, usually a SocketNode.
SocketAppender() - Constructor for class org.apache.log4j.net.SocketAppender
 
SocketAppender(InetAddress, int) - Constructor for class org.apache.log4j.net.SocketAppender
Connects to remote server at address and port.
SocketAppender(String, int) - Constructor for class org.apache.log4j.net.SocketAppender
Connects to remote server at host and port.
SocketHubAppender - class org.apache.log4j.net.SocketHubAppender.
Sends LoggingEvent objects to a set of remote log servers, usually a SocketNodes.
SocketHubAppender() - Constructor for class org.apache.log4j.net.SocketHubAppender
 
SocketHubAppender(int) - Constructor for class org.apache.log4j.net.SocketHubAppender
Connects to remote server at address and port.
SocketNode - class org.apache.log4j.net.SocketNode.
Read LoggingEvent objects sent from a remote client using Sockets (TCP).
SocketNode(Socket, LoggerRepository) - Constructor for class org.apache.log4j.net.SocketNode
 
SocketServer - class org.apache.log4j.net.SocketServer.
A SocketNode based server that uses a different hierarchy for each client.
SocketServer(File) - Constructor for class org.apache.log4j.net.SocketServer
 
spacePad(StringBuffer, int) - Method in class org.apache.log4j.helpers.PatternConverter
Fast space padding method.
sqlStatement - Variable in class org.apache.log4j.jdbc.JDBCAppender
Stores the string given to the pattern layout for conversion into a SQL statement, eg: insert into LogTable (Thread, Class, Message) values ("%t", "%c", "%m").
start() - Method in class org.apache.log4j.jmx.Agent
 
StartLogFactor5 - class org.apache.log4j.lf5.StartLogFactor5.
Starts an instance of the LogFactor5 console for off-line viewing.
StartLogFactor5() - Constructor for class org.apache.log4j.lf5.StartLogFactor5
 
startTime - Variable in class org.apache.log4j.helpers.RelativeTimeDateFormat
 
STRING_TO_MATCH_OPTION - Static variable in class org.apache.log4j.varia.StringMatchFilter
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
StringMatchFilter - class org.apache.log4j.varia.StringMatchFilter.
This is a very simple filter based on string matching.
StringMatchFilter() - Constructor for class org.apache.log4j.varia.StringMatchFilter
 
subAppend(LoggingEvent) - Method in class org.apache.log4j.WriterAppender
Actual writing occurs here.
subAppend(LoggingEvent) - Method in class org.apache.log4j.DailyRollingFileAppender
This method differentiates DailyRollingFileAppender from its super class.
subAppend(LoggingEvent) - Method in class org.apache.log4j.RollingFileAppender
This method differentiates RollingFileAppender from its super class.
subst(String) - Method in class org.apache.log4j.xml.DOMConfigurator
 
substVars(String, Properties) - Static method in class org.apache.log4j.helpers.OptionConverter
Perform variable substitution in string val from the values of keys found in the system propeties.
SYSLOG_HOST_OI - Static variable in class org.apache.log4j.net.SyslogAppender
 
SyslogAppender - class org.apache.log4j.net.SyslogAppender.
Use SyslogAppender to send log messages to a remote syslog daemon.
SyslogAppender() - Constructor for class org.apache.log4j.net.SyslogAppender
 
SyslogAppender(Layout, int) - Constructor for class org.apache.log4j.net.SyslogAppender
 
SyslogAppender(Layout, String, int) - Constructor for class org.apache.log4j.net.SyslogAppender
 
SyslogQuietWriter - class org.apache.log4j.helpers.SyslogQuietWriter.
SyslogQuietWriter extends QuietWriter by prepending the syslog level code before each printed String.
SyslogQuietWriter(Writer, int, ErrorHandler) - Constructor for class org.apache.log4j.helpers.SyslogQuietWriter
 
SyslogWriter - class org.apache.log4j.helpers.SyslogWriter.
SyslogWriter is a wrapper around the java.net.DatagramSocket class so that it behaves like a java.io.Writer.
SyslogWriter(String) - Constructor for class org.apache.log4j.helpers.SyslogWriter
Constructs a new instance of SyslogWriter.
SYSTEM_ERR - Static variable in class org.apache.log4j.ConsoleAppender
 
SYSTEM_OUT - Static variable in class org.apache.log4j.ConsoleAppender
 
SystemTime - class org.apache.log4j.performance.SystemTime.
Measures the time required to make a System.currentTimeMillis() and Thread.currentThread().getName() calls.
SystemTime() - Constructor for class org.apache.log4j.performance.SystemTime
 

T

t - Variable in class org.apache.log4j.performance.NullAppender
 
tailFilter - Variable in class org.apache.log4j.AppenderSkeleton
The last filter in the filter chain.
target - Variable in class org.apache.log4j.ConsoleAppender
 
TelnetAppender - class org.apache.log4j.net.TelnetAppender.
The TelnetAppender is a log4j appender that specializes in writing to a read-only socket.
TelnetAppender.SocketHandler - class org.apache.log4j.net.TelnetAppender.SocketHandler.
The SocketHandler class is used to accept connections from clients.
TelnetAppender.SocketHandler(TelnetAppender, int) - Constructor for class org.apache.log4j.net.TelnetAppender.SocketHandler
 
TelnetAppender() - Constructor for class org.apache.log4j.net.TelnetAppender
 
ThreadGroupRenderer - class org.apache.log4j.or.ThreadGroupRenderer.
Render ThreadGroup objects in a format similar to the information output by the ThreadGroup.list() method.
ThreadGroupRenderer() - Constructor for class org.apache.log4j.or.ThreadGroupRenderer
 
ThreadLocalMap - class org.apache.log4j.helpers.ThreadLocalMap.
ThreadLocalMap extends InheritableThreadLocal to bequeath a copy of the hashtable of the MDC of the parent thread.
ThreadLocalMap() - Constructor for class org.apache.log4j.helpers.ThreadLocalMap
 
threshold - Variable in class org.apache.log4j.AppenderSkeleton
There is no level threshold filtering by default.
ThrowableInformation - class org.apache.log4j.spi.ThrowableInformation.
ThrowableInformation is log4j's internal representation of throwables.
ThrowableInformation(Throwable) - Constructor for class org.apache.log4j.spi.ThrowableInformation
 
timeStamp - Variable in class org.apache.log4j.spi.LoggingEvent
The number of milliseconds elapsed from 1/1/1970 until logging event was created.
TIMEZONE_OPTION - Static variable in class org.apache.log4j.helpers.DateLayout
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
TITLE_OPTION - Static variable in class org.apache.log4j.HTMLLayout
A string constant used in naming the option for setting the the HTML document title.
toBoolean(String, boolean) - Static method in class org.apache.log4j.helpers.OptionConverter
If value is "true", then true is returned.
toFileSize(String, long) - Static method in class org.apache.log4j.helpers.OptionConverter
 
toInt() - Method in class org.apache.log4j.Priority
Returns the integer representation of this level.
toInt(String, int) - Static method in class org.apache.log4j.helpers.OptionConverter
 
toLevel(int) - Static method in class org.apache.log4j.Level
Convert an integer passed as argument to a level.
toLevel(int, Level) - Static method in class org.apache.log4j.Level
Convert an integer passed as argument to a level.
toLevel(String) - Static method in class org.apache.log4j.Level
Convert the string passed as argument to a level.
toLevel(String, Level) - Static method in class org.apache.log4j.Level
Convert the string passed as argument to a level.
toLevel(String, Level) - Static method in class org.apache.log4j.helpers.OptionConverter
Converts a standard or custom priority level to a Level object.
toPriority(int) - Static method in class org.apache.log4j.Priority
Deprecated. Please use the Level.toLevel(int) method instead.
toPriority(int, Priority) - Static method in class org.apache.log4j.Priority
Deprecated. Please use the Level.toLevel(int, Level) method instead.
toPriority(String) - Static method in class org.apache.log4j.Priority
Deprecated. Please use the Level.toLevel(String) method instead.
toPriority(String, Priority) - Static method in class org.apache.log4j.Priority
Deprecated. Please use the Level.toLevel(String, Level) method instead.
toString() - Method in class org.apache.log4j.Priority
Returns the string representation of this priority.
toString() - Method in class org.apache.log4j.lf5.LogLevel
 
toString() - Method in class org.apache.log4j.lf5.LogRecord
Return a String representation of this LogRecord.
TRACE - Static variable in class org.apache.log4j.Level
The TRACE Level designates finer-grained informational events than the DEBUG
TRACE_INT - Static variable in class org.apache.log4j.Level
TRACE level integer value.
trace(Object) - Method in class org.apache.log4j.Logger
Log a message object with the TRACE level.
trace(Object, Throwable) - Method in class org.apache.log4j.Logger
Log a message object with the TRACE level including the stack trace of the Throwablet passed as parameter.
Transform - class org.apache.log4j.helpers.Transform.
Utility class for transforming strings.
Transform() - Constructor for class org.apache.log4j.helpers.Transform
 
TriggeringEventEvaluator - interface org.apache.log4j.spi.TriggeringEventEvaluator.
Implementions of this interface allow certain appenders to decide when to perform an appender specific action.
TTCC_CONVERSION_PATTERN - Static variable in class org.apache.log4j.PatternLayout
A conversion pattern equivalent to the TTCCCLayout.
TTCCLayout - class org.apache.log4j.TTCCLayout.
TTCC layout format consists of time, thread, category and nested diagnostic context information, hence the name.
TTCCLayout() - Constructor for class org.apache.log4j.TTCCLayout
Instantiate a TTCCLayout object with RelativeTimeDateFormat as the date formatter in the local time zone.
TTCCLayout(String) - Constructor for class org.apache.log4j.TTCCLayout
Instantiate a TTCCLayout object using the local time zone.

V

valueOf(String) - Static method in class org.apache.log4j.lf5.LogLevel
Convert a log level label into a LogLevel object.

W

WARN - Static variable in class org.apache.log4j.Priority
Deprecated. Use Level.WARN instead.
WARN - Static variable in class org.apache.log4j.Level
The WARN level designates potentially harmful situations.
WARN - Static variable in class org.apache.log4j.lf5.LogLevel
 
WARN_INT - Static variable in class org.apache.log4j.Priority
 
warn(Object) - Method in class org.apache.log4j.Category
Log a message object with the WARN Level.
warn(Object, Throwable) - Method in class org.apache.log4j.Category
Log a message with the WARN level including the stack trace of the Throwable t passed as parameter.
warn(String) - Static method in class org.apache.log4j.helpers.LogLog
This method is used to output log4j internal warning statements.
warn(String, Throwable) - Static method in class org.apache.log4j.helpers.LogLog
This method is used to output log4j internal warnings.
WARNING - Static variable in class org.apache.log4j.lf5.LogLevel
 
warning(SAXParseException) - Method in class org.apache.log4j.xml.SAXErrorHandler
 
warning(SAXParseException) - Method in class org.apache.log4j.xml.examples.ReportParserError
 
wasEmpty() - Method in class org.apache.log4j.helpers.BoundedFIFO
Returns true if there is just one element in the buffer.
wasFull() - Method in class org.apache.log4j.helpers.BoundedFIFO
Returns true if the number of elements in the buffer plus 1 equals the maximum buffer size, returns false otherwise.
WRITE_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
 
write(char[]) - Method in class org.apache.log4j.performance.NOPWriter
 
write(char[], int, int) - Method in class org.apache.log4j.helpers.SyslogWriter
 
write(char[], int, int) - Method in class org.apache.log4j.performance.NOPWriter
 
write(int) - Method in class org.apache.log4j.performance.NOPWriter
 
write(String) - Method in class org.apache.log4j.helpers.QuietWriter
 
write(String) - Method in class org.apache.log4j.helpers.CountingQuietWriter
 
write(String) - Method in class org.apache.log4j.helpers.SyslogWriter
 
write(String) - Method in class org.apache.log4j.helpers.SyslogQuietWriter
 
write(String) - Method in class org.apache.log4j.performance.NOPWriter
 
write(String, int, int) - Method in class org.apache.log4j.performance.NOPWriter
 
writeFooter() - Method in class org.apache.log4j.WriterAppender
Write a footer as produced by the embedded layout's Layout.getFooter() method.
writeHeader() - Method in class org.apache.log4j.WriterAppender
Write a header as produced by the embedded layout's Layout.getHeader() method.
WriterAppender - class org.apache.log4j.WriterAppender.
WriterAppender appends log events to a Writer or an OutputStream depending on the user's choice.
WriterAppender() - Constructor for class org.apache.log4j.WriterAppender
This default constructor does nothing.
WriterAppender(Layout, OutputStream) - Constructor for class org.apache.log4j.WriterAppender
Instantiate a WriterAppender and set the output destination to a new OutputStreamWriter initialized with os as its OutputStream.
WriterAppender(Layout, Writer) - Constructor for class org.apache.log4j.WriterAppender
Instantiate a WriterAppender and set the output destination to writer.

X

XMLLayout - class org.apache.log4j.xml.XMLLayout.
The output of the XMLLayout consists of a series of log4j:event elements as defined in the log4j.dtd.
XMLLayout() - Constructor for class org.apache.log4j.xml.XMLLayout
 
XMLSample - class org.apache.log4j.xml.examples.XMLSample.
This example code shows how to read an XML based configuration file using a DOM parser.
XMLSample() - Constructor for class org.apache.log4j.xml.examples.XMLSample
 

_

_category - Variable in class org.apache.log4j.lf5.LogRecord
 
_defaultLogMonitor - Static variable in class org.apache.log4j.lf5.LF5Appender
 
_defaultMonitor - Variable in class org.apache.log4j.lf5.AppenderFinalizer
 
_finalizer - Static variable in class org.apache.log4j.lf5.LF5Appender
 
_label - Variable in class org.apache.log4j.lf5.LogLevel
 
_level - Variable in class org.apache.log4j.lf5.LogRecord
 
_location - Variable in class org.apache.log4j.lf5.LogRecord
 
_logMonitor - Variable in class org.apache.log4j.lf5.LF5Appender
 
_message - Variable in class org.apache.log4j.lf5.LogRecord
 
_millis - Variable in class org.apache.log4j.lf5.LogRecord
 
_ndc - Variable in class org.apache.log4j.lf5.LogRecord
 
_precedence - Variable in class org.apache.log4j.lf5.LogLevel
 
_seqCount - Static variable in class org.apache.log4j.lf5.LogRecord
 
_sequenceNumber - Variable in class org.apache.log4j.lf5.LogRecord
 
_thread - Variable in class org.apache.log4j.lf5.LogRecord
 
_thrown - Variable in class org.apache.log4j.lf5.LogRecord
 
_thrownStackTrace - Variable in class org.apache.log4j.lf5.LogRecord
 

A B C D E F G H I J L M N O P Q R S T V W X _
Log4j 1.2.14

Copyright 2000-2005 Apache Software Foundation.