|
|||||||||
| Home >> All >> org >> apache >> [ log4j overview ] | PREV NEXT | ||||||||
A
- ADDITIVITY_PREFIX - Static variable in class org.apache.log4j.PropertyConfigurator
- ALL - Static variable in class org.apache.log4j.Level
- The
ALLhas the lowest possible rank and is intended to turn on all logging. - ALL_INT - Static variable in class org.apache.log4j.Priority
- APPENDER_PREFIX - Static variable in class org.apache.log4j.PropertyConfigurator
- Appender - interface org.apache.log4j.Appender.
- Implement this interface for your own strategies for outputting log statements.
- AppenderSkeleton - class org.apache.log4j.AppenderSkeleton.
- Abstract superclass of the other appenders in the package.
- AppenderSkeleton() - Constructor for class org.apache.log4j.AppenderSkeleton
- AsyncAppender - class org.apache.log4j.AsyncAppender.
- The AsyncAppender lets users log events asynchronously.
- AsyncAppender() - Constructor for class org.apache.log4j.AsyncAppender
- aai - Variable in class org.apache.log4j.AsyncAppender
- aai - Variable in class org.apache.log4j.Category
- aai - Variable in class org.apache.log4j.Dispatcher
- 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.CompositeRollingAppender
- Sets initial conditions including date/time roll over information, first check,
scheduledFilename, and calls
existingInitto initialize the current # of backups. - activateOptions() - Method in class org.apache.log4j.ConsoleAppender
- Prepares the appender for use.
- activateOptions() - Method in class org.apache.log4j.DailyFileAppender
- If the a value for
#FILE_OPTIONis non-null, thenDailyFileAppender.setFile(java.lang.String, boolean)55 is called with the values of#FILE_OPTIONand#APPEND_OPTION. - activateOptions() - Method in class org.apache.log4j.DailyRollingFileAppender
- activateOptions() - Method in class org.apache.log4j.FileAppender
- If the value of File is not
null, thenFileAppender.setFile(java.lang.String)55 is called with the values of File and Append properties. - activateOptions() - Method in class org.apache.log4j.HTMLLayout
- No options to activate.
- activateOptions() - Method in class org.apache.log4j.PatternLayout
- Does not do anything as options become effective
- activateOptions() - Method in class org.apache.log4j.SimpleLayout
- activateOptions() - Method in class org.apache.log4j.WriterAppender
- Does nothing.
- addAppender(Appender) - Method in class org.apache.log4j.AsyncAppender
- addAppender(Appender) - Method in class org.apache.log4j.Category
- Add
newAppenderto the list of appenders of this Category instance. - addFilter(Filter) - Method in interface org.apache.log4j.Appender
- Add a filter to the end of the filter list.
- addFilter(Filter) - Method in class org.apache.log4j.AppenderSkeleton
- Add a filter to end of the filter list.
- addHierarchyEventListener(HierarchyEventListener) - Method in class org.apache.log4j.Hierarchy
- addRenderer(Class, ObjectRenderer) - Method in class org.apache.log4j.Hierarchy
- Add an object renderer for a specific class.
- 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.
- append(LoggingEvent) - Method in class org.apache.log4j.AppenderSkeleton
- Subclasses of
AppenderSkeletonshould implement this method to perform actual logging. - append(LoggingEvent) - Method in class org.apache.log4j.AsyncAppender
- append(LoggingEvent) - Method in class org.apache.log4j.TempFileAppender
- This method is called by
AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent)55 method. - append(LoggingEvent) - Method in class org.apache.log4j.WriterAppender
- This method is called by the
AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent)55 method. - appendThrowableAsHTML(String[], StringBuffer) - Method in class org.apache.log4j.HTMLLayout
- assertLog(boolean, String) - Method in class org.apache.log4j.Category
- If
assertionparameter isfalse, then logsmsgas an error 55 statement.
B
- BUF_SIZE - Variable in class org.apache.log4j.HTMLLayout
- BUF_SIZE - Variable in class org.apache.log4j.PatternLayout
- BY_COMPOSITE - Static variable in class org.apache.log4j.CompositeRollingAppender
- BY_DATE - Static variable in class org.apache.log4j.CompositeRollingAppender
- BY_SIZE - Static variable in class org.apache.log4j.CompositeRollingAppender
- Style of rolling to use
- BasicConfigurator - class org.apache.log4j.BasicConfigurator.
- Use this class to quickly configure the package.
- BasicConfigurator() - Constructor for class org.apache.log4j.BasicConfigurator
- baseFileName - Variable in class org.apache.log4j.CompositeRollingAppender
- FileName provided in configuration.
- bf - Variable in class org.apache.log4j.AsyncAppender
- bf - Variable in class org.apache.log4j.Dispatcher
- buf - Variable in class org.apache.log4j.TTCCLayout
- bufferSize - Variable in class org.apache.log4j.FileAppender
- Determines the size of IO buffer be.
- bufferedIO - Variable in class org.apache.log4j.FileAppender
- Do we do bufferedIO?
C
- CATEGORY_PREFIX - Static variable in class org.apache.log4j.PropertyConfigurator
- 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.
- 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
Categoryinstance and sets its name. - CategoryKey - class org.apache.log4j.CategoryKey.
- CategoryKey is a wrapper for String that apparently accellerated hash table lookup in early JVM's.
- CategoryKey(String) - Constructor for class org.apache.log4j.CategoryKey
- CompositeRollingAppender - class org.apache.log4j.CompositeRollingAppender.
- CompositeRollingAppender combines RollingFileAppender and DailyRollingFileAppender
It can function as either or do both at the same time (making size based rolling files like RollingFileAppender until a data/time boundary is crossed at which time it rolls all of those files as per the DailyRollingFileAppender) based on the setting forrollingStyle.
To use CompositeRollingAppender to roll log files as they reach a certain size (like RollingFileAppender), set rollingStyle=1 (@see config.size)
To use CompositeRollingAppender to roll log files at certain time intervals (daily for example), set rollingStyle=2 and a datePattern (@see config.time)
To have CompositeRollingAppender roll log files at a certain size AND rename those according to time intervals, set rollingStyle=3 (@see config.composite)
- CompositeRollingAppender() - Constructor for class org.apache.log4j.CompositeRollingAppender
- The default constructor does nothing.
- CompositeRollingAppender(Layout, String, String) - Constructor for class org.apache.log4j.CompositeRollingAppender
- Instantiate a
CompositeRollingAppenderand open the file designated byfilename. - CompositeRollingAppender(Layout, String, boolean) - Constructor for class org.apache.log4j.CompositeRollingAppender
- Instantiate a CompositeRollingAppender and open the file designated by
filename. - CompositeRollingAppender(Layout, String, String, boolean) - Constructor for class org.apache.log4j.CompositeRollingAppender
- Instantiate a CompositeRollingAppender and open the file designated by
filename. - CompositeRollingAppender(Layout, String) - Constructor for class org.apache.log4j.CompositeRollingAppender
- Instantiate a CompositeRollingAppender and open the file designated by
filename. - ConsoleAppender - class org.apache.log4j.ConsoleAppender.
- ConsoleAppender appends log events to
System.outorSystem.errusing 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.
- ConsoleAppender.SystemErrStream - class org.apache.log4j.ConsoleAppender.SystemErrStream.
- An implementation of OutputStream that redirects to the current System.err.
- ConsoleAppender.SystemErrStream() - Constructor for class org.apache.log4j.ConsoleAppender.SystemErrStream
- ConsoleAppender.SystemOutStream - class org.apache.log4j.ConsoleAppender.SystemOutStream.
- An implementation of OutputStream that redirects to the current System.out.
- ConsoleAppender.SystemOutStream() - Constructor for class org.apache.log4j.ConsoleAppender.SystemOutStream
- callAppenders(LoggingEvent) - Method in class org.apache.log4j.Category
- Call the appenders in the hierrachy starting at
this. - categoryPrefixing - Variable in class org.apache.log4j.TTCCLayout
- checkEntryConditions() - Method in class org.apache.log4j.TempFileAppender
- This method determines if there is a sense in attempting to append.
- checkEntryConditions() - Method in class org.apache.log4j.WriterAppender
- This method determines if there is a sense in attempting to append.
- checkPeriod - Variable in class org.apache.log4j.CompositeRollingAppender
- Current period for roll overs
- checkPeriod - Variable in class org.apache.log4j.DailyRollingFileAppender
- 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.
- clearFilters() - Method in interface org.apache.log4j.Appender
- Clear the list of filters by removing all the filters in it.
- clearFilters() - Method in class org.apache.log4j.AppenderSkeleton
- Clear the filters chain.
- cloneStack() - Static method in class org.apache.log4j.NDC
- Clone the diagnostic context for the current thread.
- 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
AsyncAppenderby interrupting the dispatcher thread which will process all pending events before exiting. - close() - Method in class org.apache.log4j.ConsoleAppender.SystemErrStream
- close() - Method in class org.apache.log4j.ConsoleAppender.SystemOutStream
- close() - Method in class org.apache.log4j.Dispatcher
- close() - Method in class org.apache.log4j.TempFileAppender
- close() - Method in class org.apache.log4j.WriterAppender
- Close this appender instance.
- closeFile() - Method in class org.apache.log4j.FileAppender
- Closes the previously opened file.
- closeNestedAppenders() - Method in class org.apache.log4j.Category
- Close all attached appenders implementing the AppenderAttachable interface.
- closeWriter() - Method in class org.apache.log4j.ConsoleAppender
- null
- closeWriter() - Method in class org.apache.log4j.WriterAppender
- Close the underlying java.io.Writer.
- closed - Variable in class org.apache.log4j.AppenderSkeleton
- Is this appender closed?
- computeCheckPeriod() - Method in class org.apache.log4j.CompositeRollingAppender
- computeCheckPeriod() - Method in class org.apache.log4j.DailyRollingFileAppender
- configure() - Static method in class org.apache.log4j.BasicConfigurator
- Add a ConsoleAppender that uses PatternLayout
using the
PatternLayout.TTCC_CONVERSION_PATTERN55 and prints toSystem.outto the root category. - configure(Appender) - Static method in class org.apache.log4j.BasicConfigurator
- Add
appenderto the root category. - configure(String) - Static method in class org.apache.log4j.PropertyConfigurator
- configure(URL) - Static method in class org.apache.log4j.PropertyConfigurator
- Read configuration options from url
configURL. - configure(Properties) - Static method in class org.apache.log4j.PropertyConfigurator
- Read configuration options from
properties. - configureAndWatch(String) - Static method in class org.apache.log4j.PropertyConfigurator
- Like
PropertyConfigurator.configureAndWatch(String, long)55 except that the default delay as defined by FileWatchdog.DEFAULT_DELAY>FileWatchdog.DEFAULT_DELAY55 is used. - configureAndWatch(String, long) - Static method in class org.apache.log4j.PropertyConfigurator
- Read the configuration file
configFilenameif it exists. - configureLoggerFactory(Properties) - Method in class org.apache.log4j.PropertyConfigurator
- Check the provided
Propertiesobject for a LoggerFactory entry specified byPropertyConfigurator.LOGGER_FACTORY_KEY55 . - configureRootCategory(Properties, LoggerRepository) - Method in class org.apache.log4j.PropertyConfigurator
- container - Variable in class org.apache.log4j.Dispatcher
- contextPrinting - Variable in class org.apache.log4j.TTCCLayout
- countDirection - Variable in class org.apache.log4j.CompositeRollingAppender
- By default newer files have lower numbers.
- createPatternParser(String) - Method in class org.apache.log4j.PatternLayout
- Returns PatternParser used to parse the conversion string.
- createWriter(OutputStream) - Method in class org.apache.log4j.WriterAppender
- Returns an OutputStreamWriter when passed an OutputStream.
- curSizeRollBackups - Variable in class org.apache.log4j.CompositeRollingAppender
- How many sized based backups have been made so far
- curTimeRollBackups - Variable in class org.apache.log4j.CompositeRollingAppender
- currentFileName - Variable in class org.apache.log4j.DailyFileAppender
- The actual formatted filename that is currently being written to
D
- DEBUG - Static variable in class org.apache.log4j.Level
- The
DEBUGLevel designates fine-grained informational events that are most useful to debug an application. - DEBUG - Static variable in class org.apache.log4j.Priority
- Deprecated. Use
Level.DEBUG55 instead. - DEBUG_INT - Static variable in class org.apache.log4j.Priority
- 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_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.
- DEFAULT_XML_CONFIGURATION_FILE - Static variable in class org.apache.log4j.LogManager
- DailyFileAppender - class org.apache.log4j.DailyFileAppender.
- DailyFileAppender extends FileAppender to use filenames formatted with date/time information.
- DailyFileAppender() - Constructor for class org.apache.log4j.DailyFileAppender
- The default constructor does no longer set a default layout nor a default output target.
- DailyFileAppender(Layout, String, boolean) - Constructor for class org.apache.log4j.DailyFileAppender
- Instantiate a RollingFileAppender and open the file designated by
filename. - DailyFileAppender(Layout, String) - Constructor for class org.apache.log4j.DailyFileAppender
- Instantiate a FileAppender and open the file designated by
filename. - DailyFileAppenderCalendar - class org.apache.log4j.DailyFileAppenderCalendar.
- DailyFileAppenderCalendar is a helper class to DailyFileAppender.
- DailyFileAppenderCalendar() - Constructor for class org.apache.log4j.DailyFileAppenderCalendar
- 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
DailyRollingFileAppenderand open the file designated byfilename. - DefaultCategoryFactory - class org.apache.log4j.DefaultCategoryFactory.
- DefaultCategoryFactory() - Constructor for class org.apache.log4j.DefaultCategoryFactory
- Dispatcher - class org.apache.log4j.Dispatcher.
- Dispatcher(BoundedFIFO, AsyncAppender) - Constructor for class org.apache.log4j.Dispatcher
- datePattern - Variable in class org.apache.log4j.CompositeRollingAppender
- The date pattern.
- datePattern - Variable in class org.apache.log4j.DailyRollingFileAppender
- The date pattern.
- debug(Object) - Method in class org.apache.log4j.Category
- Log a message object with the DEBUG 55 level.
- debug(Object, Throwable) - Method in class org.apache.log4j.Category
- Log a message object with the
DEBUGlevel including the stack trace of the java.lang.Throwabletpassed as parameter. - defaultFactory - Variable in class org.apache.log4j.Hierarchy
- deleteFile(String) - Static method in class org.apache.log4j.CompositeRollingAppender
- Delete's the specified file if it exists
- dir - Variable in class org.apache.log4j.TempFileAppender
- Default dir
- dispatcher - Variable in class org.apache.log4j.AsyncAppender
- doAppend(LoggingEvent) - Method in interface org.apache.log4j.Appender
- Log in
Appenderspecific way. - 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)55 method. - doConfigure(String, LoggerRepository) - Method in class org.apache.log4j.PropertyConfigurator
- Read configuration from a file.
- doConfigure(Properties, LoggerRepository) - Method in class org.apache.log4j.PropertyConfigurator
- Read configuration options from
properties. - doConfigure(URL, LoggerRepository) - Method in class org.apache.log4j.PropertyConfigurator
- Read configuration options from url
configURL. - doOnChange() - Method in class org.apache.log4j.PropertyWatchdog
- Call
PropertyConfigurator.configure(String)55 with thefilenameto reconfigure log4j.
E
- ERROR - Static variable in class org.apache.log4j.Level
- The
ERRORlevel designates error events that might still allow the application to continue running. - ERROR - Static variable in class org.apache.log4j.Priority
- Deprecated. Use
Level.ERROR55 instead. - ERROR_INT - Static variable in class org.apache.log4j.Priority
- emitNoAppenderWarning(Category) - Method in class org.apache.log4j.Hierarchy
- emittedNoAppenderWarning - Variable in class org.apache.log4j.Hierarchy
- emittedNoResourceBundleWarning - Variable in class org.apache.log4j.Hierarchy
- encoding - Variable in class org.apache.log4j.WriterAppender
- The encoding to use when opening an InputStream.
- equals(Object) - Method in class org.apache.log4j.CategoryKey
- equals(Object) - Method in class org.apache.log4j.Priority
- Two priorities are equal if their level fields are equal.
- error(Object) - Method in class org.apache.log4j.Category
- Log a message object with the ERROR 55 Level.
- error(Object, Throwable) - Method in class org.apache.log4j.Category
- Log a message object with the
ERRORlevel including the stack trace of the java.lang.Throwabletpassed as parameter. - errorHandler - Variable in class org.apache.log4j.AppenderSkeleton
- It is assumed and enforced that errorHandler is never null.
- existingInit() - Method in class org.apache.log4j.CompositeRollingAppender
- Initializes based on exisiting conditions at time of
activateOptions. - exists(String) - Static method in class org.apache.log4j.Category
- Deprecated. Please use
LogManager.exists(java.lang.String)55 instead. - exists(String) - Method in class org.apache.log4j.Hierarchy
- Check if the named logger exists in the hierarchy.
- exists(String) - Static method in class org.apache.log4j.LogManager
F
- FACTORY_PREFIX - Static variable in class org.apache.log4j.PropertyConfigurator
- FATAL - Static variable in class org.apache.log4j.Level
- The
FATALlevel designates very severe error events that will presumably lead the application to abort. - FATAL - Static variable in class org.apache.log4j.Priority
- Deprecated. Use
Level.FATAL55 instead. - FATAL_INT - Static variable in class org.apache.log4j.Priority
- FILE_NAME_PATTERN_OPTION - Static variable in class org.apache.log4j.DailyFileAppender
- A string constant used in naming the option for setting the filename pattern.
- FQCN - Static variable in class org.apache.log4j.Category
- The fully qualified name of the Category class.
- FQCN - Static variable in class org.apache.log4j.Logger
- The fully qualified name of the Logger class.
- 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, boolean, boolean, int) - Constructor for class org.apache.log4j.FileAppender
- Instantiate a
FileAppenderand open the file designated byfilename. - FileAppender(Layout, String, boolean) - Constructor for class org.apache.log4j.FileAppender
- Instantiate a FileAppender and open the file designated by
filename. - FileAppender(Layout, String) - Constructor for class org.apache.log4j.FileAppender
- Instantiate a FileAppender and open the file designated by
filename. - fatal(Object) - Method in class org.apache.log4j.Category
- Log a message object with the FATAL 55 Level.
- fatal(Object, Throwable) - Method in class org.apache.log4j.Category
- Log a message object with the
FATALlevel including the stack trace of the java.lang.Throwabletpassed as parameter. - fileAppend - Variable in class org.apache.log4j.FileAppender
- Controls file truncatation.
- fileName - Variable in class org.apache.log4j.FileAppender
- The name of the log file.
- fileNamePattern - Variable in class org.apache.log4j.DailyFileAppender
- The filename pattern
- finalize() - Method in class org.apache.log4j.AppenderSkeleton
- Finalize this appender by calling the derived class'
closemethod. - fireAddAppenderEvent(Category, Appender) - Method in class org.apache.log4j.Hierarchy
- fireRemoveAppenderEvent(Category, Appender) - Method in class org.apache.log4j.Hierarchy
- flush() - Method in class org.apache.log4j.ConsoleAppender.SystemErrStream
- flush() - Method in class org.apache.log4j.ConsoleAppender.SystemOutStream
- follow - Variable in class org.apache.log4j.ConsoleAppender
- Determines if the appender honors reassignments of System.out or System.err made after configuration.
- 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(LoggingEvent) - Method in class org.apache.log4j.HTMLLayout
- 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.PatternLayout
- Produces a formatted string as specified by the conversion pattern.
- format(LoggingEvent) - Method in class org.apache.log4j.SimpleLayout
- Returns the log statement in a format consisting of the
level, followed by " - " and then themessage. - 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.
- fullMessage - Variable in class org.apache.log4j.NDC.DiagnosticContext
G
- get(String) - Static method in class org.apache.log4j.MDC
- Get the context identified by the
keyparameter. - get() - Static method in class org.apache.log4j.NDC
- Never use this method directly, use the LoggingEvent.getNDC()>
LoggingEvent.getNDC()55 method instead. - get0(String) - Method in class org.apache.log4j.MDC
- getAdditivity() - Method in class org.apache.log4j.Category
- Get the additivity flag for this Category instance.
- getAllAppenders() - Method in class org.apache.log4j.AsyncAppender
- getAllAppenders() - Method in class org.apache.log4j.Category
- Get the appenders contained in this category as an java.util.Enumeration.
- 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.AsyncAppender
- getAppender(String) - Method in class org.apache.log4j.Category
- Look for the appender named as
name. - getBufferSize() - Method in class org.apache.log4j.AsyncAppender
- Returns the current value of the BufferSize option.
- getBufferSize() - Method in class org.apache.log4j.FileAppender
- Get the size of the IO buffer.
- getBufferedIO() - Method in class org.apache.log4j.FileAppender
- Get the value of the BufferedIO option.
- getCategoryPrefixing() - Method in class org.apache.log4j.TTCCLayout
- Returns value of the CategoryPrefixing option.
- getChainedPriority() - Method in class org.apache.log4j.Category
- Deprecated. Please use the the
Category.getEffectiveLevel()55 method instead. - getContentType() - Method in class org.apache.log4j.HTMLLayout
- Returns the content type output by this layout, i.e "text/html".
- getContentType() - Method in class org.apache.log4j.Layout
- Returns the content type output by this layout.
- getContext() - Static method in class org.apache.log4j.MDC
- Get the current thread's MDC as a hashtable.
- getContext0() - Method in class org.apache.log4j.MDC
- 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.
- getCountDirection() - Method in class org.apache.log4j.CompositeRollingAppender
- getCurrentCategories() - Static method in class org.apache.log4j.Category
- Deprecated. Please use
LogManager.getCurrentLoggers()55 instead. - getCurrentCategories() - Method in class org.apache.log4j.Hierarchy
- Deprecated. Please use
Hierarchy.getCurrentLoggers()55 instead. - getCurrentLoggers() - Method in class org.apache.log4j.Hierarchy
- Returns all the currently defined categories in this hierarchy as an Enumeration.
- getCurrentLoggers() - Static method in class org.apache.log4j.LogManager
- getDatePattern() - Method in class org.apache.log4j.CompositeRollingAppender
- Returns the value of the DatePattern 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()55 instead. - 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 interface org.apache.log4j.Appender
- Returns the org.apache.log4j.spi.ErrorHandler for this appender.
- getErrorHandler() - Method in class org.apache.log4j.AppenderSkeleton
- Return the currently set org.apache.log4j.spi.ErrorHandler for this Appender.
- getFile() - Method in class org.apache.log4j.FileAppender
- Returns the value of the File option.
- getFilter() - Method in interface org.apache.log4j.Appender
- Returns the head Filter.
- getFilter() - Method in class org.apache.log4j.AppenderSkeleton
- 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.HTMLLayout
- Returns the appropriate HTML footers.
- getFooter() - Method in class org.apache.log4j.Layout
- Returns the footer for the layout format.
- getHeader() - Method in class org.apache.log4j.HTMLLayout
- Returns appropriate HTML headers.
- getHeader() - Method in class org.apache.log4j.Layout
- Returns the header for the layout format.
- getHierarchy() - Method in class org.apache.log4j.Category
- Deprecated. Please use
Category.getLoggerRepository()55 instead. - getImmediateFlush() - Method in class org.apache.log4j.WriterAppender
- Returns value of the ImmediateFlush option.
- getInstance(String) - Static method in class org.apache.log4j.Category
- Deprecated. Make sure to use
Logger.getLogger(String)55 instead. - getInstance(Class) - Static method in class org.apache.log4j.Category
- Deprecated. Please make sure to use
Logger.getLogger(Class)55 instead. - getLayout() - Method in interface org.apache.log4j.Appender
- Returns this appenders layout.
- getLayout() - Method in class org.apache.log4j.AppenderSkeleton
- Returns the layout of this appender.
- getLevel() - Method in class org.apache.log4j.Category
- Returns the assigned Level, if any, for this Category.
- getLocationInfo() - Method in class org.apache.log4j.AsyncAppender
- Returns the current value of the LocationInfo option.
- getLocationInfo() - Method in class org.apache.log4j.HTMLLayout
- Returns the current value of the LocationInfo option.
- 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, LoggerFactory) - Method in class org.apache.log4j.Hierarchy
- Return a new logger instance named as the first parameter using
factory. - getLogger(String) - Static method in class org.apache.log4j.LogManager
- Retrieve the appropriate Logger instance.
- getLogger(Class) - Static method in class org.apache.log4j.LogManager
- Retrieve the appropriate Logger instance.
- getLogger(String, LoggerFactory) - 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
nameparameter. - getLogger(Class) - Static method in class org.apache.log4j.Logger
- Shorthand for
getLogger(clazz.getName()). - getLogger(String, LoggerFactory) - Static method in class org.apache.log4j.Logger
- Like
Logger.getLogger(String)55 except that the type of logger instantiated depends on the type returned by the LoggerFactory.makeNewLoggerInstance(java.lang.String)>LoggerFactory.makeNewLoggerInstance(java.lang.String)55 method of thefactoryparameter. - getLoggerRepository() - Method in class org.apache.log4j.Category
- Return the the org.apache.log4j.spi.LoggerRepository where this
Categoryis attached. - getLoggerRepository() - Static method in class org.apache.log4j.LogManager
- getMaxBackupIndex() - Method in class org.apache.log4j.RollingFileAppender
- Returns the value of the MaxBackupIndex option.
- getMaxSizeRollBackups() - Method in class org.apache.log4j.CompositeRollingAppender
- Returns the value of the maxSizeRollBackups option.
- getMaximumFileSize() - Method in class org.apache.log4j.CompositeRollingAppender
- Get the maximum size that the output file is allowed to reach before being rolled over to backup files.
- 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.
- getName() - Method in interface org.apache.log4j.Appender
- Get the name of this appender.
- getName() - Method in class org.apache.log4j.AppenderSkeleton
- Returns the name of this FileAppender.
- getName() - Method in class org.apache.log4j.Category
- Return the category name.
- getNextCheckDate(Date) - Method in class org.apache.log4j.RollingCalendar
- getNextCheckMillis(Date) - Method in class org.apache.log4j.RollingCalendar
- getOptionStrings() - Method in class org.apache.log4j.DailyFileAppender
- Retuns the option names for this component, namely
DailyFileAppender.FILE_NAME_PATTERN_OPTION55 in addition to the options of FileAppender. - getOptionStrings() - Method in class org.apache.log4j.TempFileAppender
- Retuns the option names for this component
- getParent() - Method in class org.apache.log4j.Category
- Returns the parent of this category.
- getPriority() - Method in class org.apache.log4j.Category
- Deprecated. Please use
Category.getLevel()55 instead. - getRendererMap() - Method in class org.apache.log4j.Hierarchy
- Get the renderer map for this hierarchy.
- getResourceBundle() - Method in class org.apache.log4j.Category
- Return the inherited java.util.ResourceBundle for this category.
- getResourceBundleString(String) - Method in class org.apache.log4j.Category
- Returns the string resource coresponding to
keyin this category's inherited resource bundle. - getRollingStyle() - Method in class org.apache.log4j.CompositeRollingAppender
- getRoot() - Static method in class org.apache.log4j.Category
- Deprecated. Please use
Logger.getRootLogger()55 instead. - getRootLogger() - Method in class org.apache.log4j.Hierarchy
- Get the root of this hierarchy.
- 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.
- getStaticLogFileName() - Method in class org.apache.log4j.CompositeRollingAppender
- getSyslogEquivalent() - Method in class org.apache.log4j.Priority
- Return the syslog equivalent of this priority as an integer.
- getTarget() - Method in class org.apache.log4j.ConsoleAppender
- Returns the current value of the Target property.
- 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
enablestate. - getTimeInMillis() - Method in class org.apache.log4j.DailyFileAppenderCalendar
- Returns the current time in Millis
- getTitle() - Method in class org.apache.log4j.HTMLLayout
- Returns the current value of the Title option.
- gmtTimeZone - Static variable in class org.apache.log4j.DailyRollingFileAppender
- guard - Static variable in class org.apache.log4j.LogManager
H
- HALF_DAY - Static variable in class org.apache.log4j.CompositeRollingAppender
- HALF_DAY - Static variable in class org.apache.log4j.DailyRollingFileAppender
- HTMLLayout - class org.apache.log4j.HTMLLayout.
- This layout outputs events in a HTML table.
- HTMLLayout() - Constructor for class org.apache.log4j.HTMLLayout
- HT_SIZE - Static variable in class org.apache.log4j.MDC
- 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.
- hashCache - Variable in class org.apache.log4j.CategoryKey
- hashCode() - Method in class org.apache.log4j.CategoryKey
- head - Variable in class org.apache.log4j.PatternLayout
- headFilter - Variable in class org.apache.log4j.AppenderSkeleton
- The first filter in the filter chain.
- ht - Variable in class org.apache.log4j.Hierarchy
- ht - Static variable in class org.apache.log4j.NDC
I
- INFO - Static variable in class org.apache.log4j.Level
- The
INFOlevel designates informational messages that highlight the progress of the application at coarse-grained level. - INFO - Static variable in class org.apache.log4j.Priority
- Deprecated. Use
Level.INFO55 instead. - INFO_INT - Static variable in class org.apache.log4j.Priority
- INTERNAL_ROOT_NAME - Static variable in class org.apache.log4j.PropertyConfigurator
- 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.Layout
- If the layout handles the throwable object contained within
org.apache.log4j.spi.LoggingEvent, then the layout should return
false. - 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.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.
- 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(Object) - Method in class org.apache.log4j.Category
- Log a message object with the INFO 55 Level.
- info(Object, Throwable) - Method in class org.apache.log4j.Category
- Log a message object with the
INFOlevel including the stack trace of the java.lang.Throwabletpassed as parameter. - inherit(Stack) - Static method in class org.apache.log4j.NDC
- Inherit the diagnostic context of another thread.
- interrupted - Variable in class org.apache.log4j.Dispatcher
- interruptedWarningMessage - Variable in class org.apache.log4j.AsyncAppender
- 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.AsyncAppender
- Is the appender passed as parameter attached to this category?
- isAttached(Appender) - Method in class org.apache.log4j.Category
- Is the appender passed as parameter attached to this category?
- isDebugEnabled() - Method in class org.apache.log4j.Category
- Check whether this category is enabled for the
DEBUGLevel. - isDisabled(int) - Method in class org.apache.log4j.Hierarchy
- This method will return
trueif this repository is disabled forlevelobject passed as parameter andfalseotherwise. - isEnabledFor(Priority) - Method in class org.apache.log4j.Category
- Check whether this category is enabled for a given Level passed as parameter.
- isGreaterOrEqual(Priority) - Method in class org.apache.log4j.Priority
- Returns
trueif this level has a higher or equal level than the level passed as argument,falseotherwise. - isInfoEnabled() - Method in class org.apache.log4j.Category
- Check whether this category is enabled for the info Level.
- isTraceEnabled() - Method in class org.apache.log4j.Logger
- Check whether this category is enabled for the TRACE Level.
J
L
- LINE_SEP - Static variable in class org.apache.log4j.Layout
- LINE_SEP_LEN - Static variable in class org.apache.log4j.Layout
- 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.
- LOGGER_FACTORY_KEY - Static variable in class org.apache.log4j.PropertyConfigurator
- Key for specifying the LoggerFactory.
- LOGGER_PREFIX - Static variable in class org.apache.log4j.PropertyConfigurator
- 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
- Level - class org.apache.log4j.Level.
- Defines the minimum set of levels recognized by the system, that is
OFF,FATAL,ERROR,WARN,INFODEBUGandALL. - Level(int, String, int) - Constructor for class org.apache.log4j.Level
- Instantiate a Level object.
- LogManager - class org.apache.log4j.LogManager.
- Use the
LogManagerclass to retreive Logger instances or to operate on the current org.apache.log4j.spi.LoggerRepository. - LogManager() - Constructor for class org.apache.log4j.LogManager
- Logger - class org.apache.log4j.Logger.
- This is the central class in the log4j package.
- Logger(String) - Constructor for class org.apache.log4j.Logger
- l7dlog(Priority, String, Throwable) - Method in class org.apache.log4j.Category
- Log a localized message.
- l7dlog(Priority, String, Object[], Throwable) - Method in class org.apache.log4j.Category
- Log a localized and parameterized 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.
- lazyRemove() - Static method in class org.apache.log4j.NDC
- level - Variable in class org.apache.log4j.Category
- The assigned level of this category.
- level - Variable in class org.apache.log4j.Priority
- levelStr - Variable in class org.apache.log4j.Priority
- listeners - Variable in class org.apache.log4j.Hierarchy
- locationInfo - Variable in class org.apache.log4j.AsyncAppender
- locationInfo - Variable in class org.apache.log4j.HTMLLayout
- log(Priority, Object, Throwable) - Method in class org.apache.log4j.Category
- This generic form is intended to be used by wrappers.
- log(Priority, Object) - 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.
- loggerFactory - Variable in class org.apache.log4j.PropertyConfigurator
M
- MAX_CAPACITY - Variable in class org.apache.log4j.HTMLLayout
- MAX_CAPACITY - Variable in class org.apache.log4j.PatternLayout
- 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.
- MDC() - Constructor for class org.apache.log4j.MDC
- makeNewLoggerInstance(String) - Method in class org.apache.log4j.DefaultCategoryFactory
- maxBackupIndex - Variable in class org.apache.log4j.RollingFileAppender
- There is one backup file by default.
- maxFileSize - Variable in class org.apache.log4j.CompositeRollingAppender
- The default maximum file size is 10MB.
- maxFileSize - Variable in class org.apache.log4j.RollingFileAppender
- The default maximum file size is 10MB.
- maxSizeRollBackups - Variable in class org.apache.log4j.CompositeRollingAppender
- There is zero backup files by default.
- maxTimeRollBackups - Variable in class org.apache.log4j.CompositeRollingAppender
- not yet implemented
- mdc - Static variable in class org.apache.log4j.MDC
- message - Variable in class org.apache.log4j.NDC.DiagnosticContext
N
- 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.
- NDC() - Constructor for class org.apache.log4j.NDC
- NDC.DiagnosticContext - class org.apache.log4j.NDC.DiagnosticContext.
- NDC.DiagnosticContext(String, NDC.DiagnosticContext) - Constructor for class org.apache.log4j.NDC.DiagnosticContext
- name - Variable in class org.apache.log4j.AppenderSkeleton
- Appenders are named.
- name - Variable in class org.apache.log4j.Category
- The name of this category.
- name - Variable in class org.apache.log4j.CategoryKey
- nextCheck - Variable in class org.apache.log4j.CompositeRollingAppender
- The timestamp when we shall next recompute the filename.
- nextCheck - Variable in class org.apache.log4j.DailyRollingFileAppender
- The next time we estimate a rollover should occur.
- nextFilenameComputingMillis - Variable in class org.apache.log4j.DailyFileAppender
- The timestamp when we shall next recompute the filename
- now - Variable in class org.apache.log4j.CompositeRollingAppender
- Holds date of last roll over
- now - Variable in class org.apache.log4j.DailyRollingFileAppender
O
- OFF - Static variable in class org.apache.log4j.Level
- The
OFFhas the highest possible rank and is intended to turn off logging. - OFF_INT - Static variable in class org.apache.log4j.Priority
- org.apache.log4j - package org.apache.log4j
- overrideAsNeeded(String) - Method in class org.apache.log4j.Hierarchy
- Deprecated. Deprecated with no replacement.
P
- PATH_OPTION - Static variable in class org.apache.log4j.TempFileAppender
- A string constant used in naming the option for setting the directory where the log files will be created.
- PREFIX_OPTION - Static variable in class org.apache.log4j.TempFileAppender
- A string constant used in naming the option for setting the prefix of the log files.
- 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 or