|
|||||||||
| Home >> All >> org >> apache >> log4j >> [ spi overview ] | PREV NEXT | ||||||||
A
- 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.
- ADDRESS_PARSE_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
- AppenderAttachable - interface org.apache.log4j.spi.AppenderAttachable.
- Interface for attaching appenders to objects.
- 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.
- addAppender(Appender) - Method in interface org.apache.log4j.spi.AppenderAttachable
- Add an appender.
- addAppenderEvent(Category, Appender) - Method in interface org.apache.log4j.spi.HierarchyEventListener
- addHierarchyEventListener(HierarchyEventListener) - Method in interface org.apache.log4j.spi.LoggerRepository
- Add a HierarchyEventListener event to the repository.
C
- CLOSE_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
- Configurator - interface org.apache.log4j.spi.Configurator.
- Implemented by classes capable of configuring log4j using a URL.
- 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()55 method instead. - className - Variable in class org.apache.log4j.spi.LocationInfo
- Caller's fully qualified class name.
- close() - Method in class org.apache.log4j.spi.NullWriter
D
- 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.
- DefaultRepositorySelector - class org.apache.log4j.spi.DefaultRepositorySelector.
- DefaultRepositorySelector(LoggerRepository) - Constructor for class org.apache.log4j.spi.DefaultRepositorySelector
- decide(LoggingEvent) - Method in class org.apache.log4j.spi.Filter
- If the decision is
DENY, then the event will be dropped. - doConfigure(URL, LoggerRepository) - Method in interface org.apache.log4j.spi.Configurator
- Interpret a resource pointed by a URL and set up log4j accordingly.
E
- ErrorCode - interface org.apache.log4j.spi.ErrorCode.
- This interface defines commonly encoutered error codes.
- ErrorHandler - interface org.apache.log4j.spi.ErrorHandler.
- Appenders may delegate their error handling to
ErrorHandlers. - emitNoAppenderWarning(Category) - Method in interface org.apache.log4j.spi.LoggerRepository
- error(String, Exception, int) - Method in interface org.apache.log4j.spi.ErrorHandler
- Equivalent to the
ErrorHandler.error(String, Exception, int, LoggingEvent event)55 with the the event parameteter set tonull. - 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, Exception, int, LoggingEvent) - Method in interface org.apache.log4j.spi.ErrorHandler
- This method is invoked to handle the error.
- exists(String) - Method in interface org.apache.log4j.spi.LoggerRepository
F
- FILE_OPEN_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
- FLUSH_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
- 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
- fileName - Variable in class org.apache.log4j.spi.LocationInfo
- Caller's file name.
- fireAddAppenderEvent(Category, Appender) - Method in interface org.apache.log4j.spi.LoggerRepository
- flush() - Method in class org.apache.log4j.spi.NullWriter
- 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
- GENERIC_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
- getAllAppenders() - Method in interface org.apache.log4j.spi.AppenderAttachable
- Get all previously added appenders as an Enumeration.
- getAppender(String) - Method in interface org.apache.log4j.spi.AppenderAttachable
- Get an appender by name.
- getChainedLevel() - Method in class org.apache.log4j.spi.RootCategory
- Deprecated. Return the assigned level value without walking the category hierarchy.
- getChainedLevel() - Method in class org.apache.log4j.spi.RootLogger
- Return the assigned level value without walking the logger hierarchy.
- getClassName() - Method in class org.apache.log4j.spi.LocationInfo
- Return the fully qualified class name of the caller making the logging request.
- getCurrentCategories() - Method in interface org.apache.log4j.spi.LoggerRepository
- Deprecated.
- getCurrentLoggers() - Method in interface org.apache.log4j.spi.LoggerRepository
- getFileName() - Method in class org.apache.log4j.spi.LocationInfo
- Return the file name of the caller.
- getLevel() - Method in class org.apache.log4j.spi.LoggingEvent
- Return the level of this event.
- getLineNumber() - Method in class org.apache.log4j.spi.LocationInfo
- Returns the line number of the caller.
- getLocationInformation() - Method in class org.apache.log4j.spi.LoggingEvent
- Set the location information for this logging event.
- getLogger(String) - Method in interface org.apache.log4j.spi.LoggerRepository
- 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.spi.DefaultRepositorySelector
- getLoggerRepository() - Method in interface org.apache.log4j.spi.RepositorySelector
- Returns a LoggerRepository depending on the context.
- getMDC(String) - Method in class org.apache.log4j.spi.LoggingEvent
- Returns the the context corresponding to the
keyparameter. - 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.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.
- 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;
- getRenderedMessage() - Method in class org.apache.log4j.spi.LoggingEvent
- getRendererMap() - Method in interface org.apache.log4j.spi.RendererSupport
- getRootLogger() - Method in interface org.apache.log4j.spi.LoggerRepository
- getStartTime() - Static method in class org.apache.log4j.spi.LoggingEvent
- Returns the time when the application started, in milliseconds elapsed since 01.01.1970.
- getThreadName() - Method in class org.apache.log4j.spi.LoggingEvent
- 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.LoggingEvent
- Return this event's throwable's string[] representaion.
- getThrowableStrRep() - Method in class org.apache.log4j.spi.ThrowableInformation
H
- HierarchyEventListener - interface org.apache.log4j.spi.HierarchyEventListener.
- Listen to events occuring within a Hierarchy.
I
- INHERITED - Static variable in interface org.apache.log4j.spi.Configurator
- Special level value signifying inherited behaviour.
- inVisualAge - Static variable in class org.apache.log4j.spi.LocationInfo
- isAttached(Appender) - Method in interface org.apache.log4j.spi.AppenderAttachable
- Returns
trueif the specified appender is in list of attached attached,falseotherwise. - isDisabled(int) - Method in interface org.apache.log4j.spi.LoggerRepository
- Returns whether this repository is disabled for a given level.
- isTriggeringEvent(LoggingEvent) - Method in interface org.apache.log4j.spi.TriggeringEventEvaluator
- Is this the triggering event?
L
- 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.
- 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
LoggerRepositoryis used to create and retrieveLoggers. - LoggingEvent - class org.apache.log4j.spi.LoggingEvent.
- The internal representation of logging events.
- LoggingEvent(String, Category, Priority, Object, Throwable) - Constructor for class org.apache.log4j.spi.LoggingEvent
- Instantiate a LoggingEvent from the supplied parameters.
- LoggingEvent(String, Category, long, Priority, Object, Throwable) - Constructor for class org.apache.log4j.spi.LoggingEvent
- Instantiate a LoggingEvent from the supplied parameters.
- 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()55 method instead. - lineNumber - Variable in class org.apache.log4j.spi.LocationInfo
- Caller's line number.
- locationInfo - Variable in class org.apache.log4j.spi.LoggingEvent
- Location information for the caller.
- logger - Variable in class org.apache.log4j.spi.LoggingEvent
- Deprecated. This field will be marked as private or be completely removed in future releases. Please do not use it.
M
- MISSING_LAYOUT - Static variable in interface org.apache.log4j.spi.ErrorCode
- makeNewLoggerInstance(String) - Method in interface org.apache.log4j.spi.LoggerFactory
- mdcCopy - Variable in class org.apache.log4j.spi.LoggingEvent
- The mapped diagnostic context (MDC) of logging event.
- mdcCopyLookupRequired - Variable in class org.apache.log4j.spi.LoggingEvent
- Have we tried to do an MDC lookup? If we did, there is no need to do it again.
- message - Variable in class org.apache.log4j.spi.LoggingEvent
- The application supplied message of logging event.
- methodCache - Static variable in class org.apache.log4j.spi.LoggingEvent
- methodName - Variable in class org.apache.log4j.spi.LocationInfo
- Caller's method name.
N
- NA - Static variable in class org.apache.log4j.spi.LocationInfo
- When location information is not available the constant
NAis returned. - NEUTRAL - Static variable in class org.apache.log4j.spi.Filter
- This filter is neutral with respect to the log event.
- NULL - Static variable in interface org.apache.log4j.spi.Configurator
- Special level signifying inherited behaviour, same as
Configurator.INHERITED55 . - NullWriter - class org.apache.log4j.spi.NullWriter.
- NullWriter() - Constructor for class org.apache.log4j.spi.NullWriter
- ndc - Variable in class org.apache.log4j.spi.LoggingEvent
- The nested diagnostic context (NDC) of logging event.
- ndcLookupRequired - Variable in class org.apache.log4j.spi.LoggingEvent
- Have we tried to do an NDC lookup? If we did, there is no need to do it again.
- next - Variable in class org.apache.log4j.spi.Filter
- Deprecated. As of 1.2.12, use
Filter.getNext()55 andFilter.setNext(org.apache.log4j.spi.Filter)55 instead
O
- OptionHandler - interface org.apache.log4j.spi.OptionHandler.
- A string based interface to configure package components.
- org.apache.log4j.spi - package org.apache.log4j.spi
P
- PARAM_ARRAY - Static variable in class org.apache.log4j.spi.LoggingEvent
- print(Object) - Method in class org.apache.log4j.spi.VectorWriter
- print(char[]) - Method in class org.apache.log4j.spi.VectorWriter
- print(String) - Method in class org.apache.log4j.spi.VectorWriter
- println(Object) - Method in class org.apache.log4j.spi.VectorWriter
- println(char[]) - Method in class org.apache.log4j.spi.VectorWriter
- println(String) - Method in class org.apache.log4j.spi.VectorWriter
- pw - Static variable in class org.apache.log4j.spi.LocationInfo
R
- RendererSupport - interface org.apache.log4j.spi.RendererSupport.
- RepositorySelector - interface org.apache.log4j.spi.RepositorySelector.
- The
LogManageruses one (and only one)RepositorySelectorimplementation to select the LoggerRepository for a particular application context. - 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".
- 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".
- readLevel(ObjectInputStream) - Method in class org.apache.log4j.spi.LoggingEvent
- readObject(ObjectInputStream) - Method in class org.apache.log4j.spi.LoggingEvent
- removeAllAppenders() - Method in interface org.apache.log4j.spi.AppenderAttachable
- Remove all previously added 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 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 interface org.apache.log4j.spi.HierarchyEventListener
- renderedMessage - Variable in class org.apache.log4j.spi.LoggingEvent
- The application supplied message rendered through the log4j objet rendering mechanism.
- rep - Variable in class org.apache.log4j.spi.ThrowableInformation
- repository - Variable in class org.apache.log4j.spi.DefaultRepositorySelector
- resetConfiguration() - Method in interface org.apache.log4j.spi.LoggerRepository
S
- serialVersionUID - Static variable in class org.apache.log4j.spi.LocationInfo
- serialVersionUID - Static variable in class org.apache.log4j.spi.LoggingEvent
- serialVersionUID - Static variable in class org.apache.log4j.spi.ThrowableInformation
- setAppender(Appender) - Method in interface org.apache.log4j.spi.ErrorHandler
- Set the appender for which errors are handled.
- setBackupAppender(Appender) - Method in interface org.apache.log4j.spi.ErrorHandler
- Set the appender to falkback upon in case of failure.
- 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(Level) - Method in class org.apache.log4j.spi.RootLogger
- Setting a null value to the level of the root logger may have catastrophic results.
- 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.
- setNext(Filter) - Method in class org.apache.log4j.spi.Filter
- Set the next filter pointer.
- setPriority(Level) - Method in class org.apache.log4j.spi.RootCategory
- Deprecated.
- setRenderer(Class, ObjectRenderer) - Method in interface org.apache.log4j.spi.RendererSupport
- setThreshold(Level) - Method in interface org.apache.log4j.spi.LoggerRepository
- Set the repository-wide threshold.
- setThreshold(String) - Method in interface org.apache.log4j.spi.LoggerRepository
- Another form of
LoggerRepository.setThreshold(Level)55 accepting a string parameter instead of aLevel. - shutdown() - Method in interface org.apache.log4j.spi.LoggerRepository
- startTime - Static variable in class org.apache.log4j.spi.LoggingEvent
- sw - Static variable in class org.apache.log4j.spi.LocationInfo
T
- TO_LEVEL - Static variable in class org.apache.log4j.spi.LoggingEvent
- TO_LEVEL_PARAMS - Static variable in class org.apache.log4j.spi.LoggingEvent
- 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
- TriggeringEventEvaluator - interface org.apache.log4j.spi.TriggeringEventEvaluator.
- Implementions of this interface allow certain appenders to decide when to perform an appender specific action.
- threadName - Variable in class org.apache.log4j.spi.LoggingEvent
- The name of thread in which this logging event was generated.
- throwable - Variable in class org.apache.log4j.spi.ThrowableInformation
- throwableInfo - Variable in class org.apache.log4j.spi.LoggingEvent
- This variable contains information about this event's throwable
- timeStamp - Variable in class org.apache.log4j.spi.LoggingEvent
- The number of milliseconds elapsed from 1/1/1970 until logging event was created.
- toStringArray() - Method in class org.apache.log4j.spi.VectorWriter
V
- VectorWriter - class org.apache.log4j.spi.VectorWriter.
- VectorWriter is a seemingly trivial implemtantion of PrintWriter.
- VectorWriter() - Constructor for class org.apache.log4j.spi.VectorWriter
- v - Variable in class org.apache.log4j.spi.VectorWriter
W
- WRITE_FAILURE - Static variable in interface org.apache.log4j.spi.ErrorCode
- write(char[], int, int) - Method in class org.apache.log4j.spi.NullWriter
- write(char[]) - Method in class org.apache.log4j.spi.VectorWriter
- write(char[], int, int) - Method in class org.apache.log4j.spi.VectorWriter
- write(String, int, int) - Method in class org.apache.log4j.spi.VectorWriter
- write(String) - Method in class org.apache.log4j.spi.VectorWriter
- writeLevel(ObjectOutputStream) - Method in class org.apache.log4j.spi.LoggingEvent
- writeObject(ObjectOutputStream) - Method in class org.apache.log4j.spi.LoggingEvent
A C D E F G H I L M N O P R S T V W
|
|||||||||
| Home >> All >> org >> apache >> log4j >> [ spi overview ] | PREV NEXT | ||||||||