Package org.apache.log4j.spi
Interface LoggerRepositoryEx
- All Superinterfaces:
org.apache.log4j.spi.LoggerRepository
- All Known Implementing Classes:
LoggerRepositoryExImpl
public interface LoggerRepositoryEx
extends org.apache.log4j.spi.LoggerRepository
A
LoggerRepository
is used to create and retrieve
Loggers
. The relation between loggers in a repository
depends on the repository but typically loggers are arranged in a
named hierarchy.
In addition to the creational methods, a
LoggerRepository
can be queried for existing loggers,
can act as a point of registry for events related to loggers.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addErrorItem
(ErrorItem errorItem) Errors which cannot be logged, go to the error list.void
addLoggerEventListener
(LoggerEventListener listener) Add aLoggerEventListener
to the repository.void
Add aLoggerRepositoryEventListener
to the repository.void
Requests that a configuration changed event be sent to any registeredLoggerRepositoryEventListener
.void
fireLevelChangedEvent
(org.apache.log4j.Logger logger) Requests that a level changed event be sent to any registeredLoggerEventListener
.void
fireRemoveAppenderEvent
(org.apache.log4j.Category logger, org.apache.log4j.Appender appender) Requests that a appender removed event be sent to any registeredLoggerEventListener
.Errors which cannot be logged, go to the error list.org.apache.log4j.spi.LoggerFactory
Returns the logger factory used by LoggerRepository.getLogger(String).getName()
Get the name of this logger repository.A LoggerRepository can also act as a store for various objects used by log4j components.Return the PluginRegisty for this LoggerRepository.Get the properties specific for this repository.getProperty
(String key) Get the property of this repository.Return theScheduler
for this LoggerRepository.boolean
Is the current configuration of the repository in its original (pristine) state?void
Store an object under 'key'.void
removeLoggerEventListener
(LoggerEventListener listener) Remove aLoggerEventListener
from the repository.void
Remove aLoggerRepositoryEventListener
from the repository.void
setLoggerFactory
(org.apache.log4j.spi.LoggerFactory loggerFactory) Sets the logger factory used by LoggerRepository.getLogger(String).void
A logger repository is a named entity.void
setPristine
(boolean state) Set the pristine flag.void
setProperty
(String key, String value) Set a property of this repository.Methods inherited from interface org.apache.log4j.spi.LoggerRepository
addHierarchyEventListener, emitNoAppenderWarning, exists, fireAddAppenderEvent, getCurrentCategories, getCurrentLoggers, getLogger, getLogger, getRootLogger, getThreshold, isDisabled, resetConfiguration, setThreshold, setThreshold, shutdown
-
Method Details
-
addLoggerRepositoryEventListener
Add aLoggerRepositoryEventListener
to the repository. The listener will be called when repository events occur.- Parameters:
listener
- event listener, may not be null.
-
removeLoggerRepositoryEventListener
Remove aLoggerRepositoryEventListener
from the repository.- Parameters:
listener
- listener.
-
addLoggerEventListener
Add aLoggerEventListener
to the repository. The listener will be called when repository events occur.- Parameters:
listener
- listener, may not be null.
-
removeLoggerEventListener
Remove aLoggerEventListener
from the repository.- Parameters:
listener
- listener, may not be null.
-
getName
String getName()Get the name of this logger repository.- Returns:
- name, may not be null.
-
setName
A logger repository is a named entity.- Parameters:
repoName
- new name, may not be null.
-
isPristine
boolean isPristine()Is the current configuration of the repository in its original (pristine) state?- Returns:
- true if repository is in original state.
-
setPristine
void setPristine(boolean state) Set the pristine flag.- Parameters:
state
- state- See Also:
-
fireRemoveAppenderEvent
void fireRemoveAppenderEvent(org.apache.log4j.Category logger, org.apache.log4j.Appender appender) Requests that a appender removed event be sent to any registeredLoggerEventListener
.- Parameters:
logger
- The logger from which the appender was removed.appender
- The appender removed from the logger.
-
fireLevelChangedEvent
void fireLevelChangedEvent(org.apache.log4j.Logger logger) Requests that a level changed event be sent to any registeredLoggerEventListener
.- Parameters:
logger
- The logger which changed levels.
-
fireConfigurationChangedEvent
void fireConfigurationChangedEvent()Requests that a configuration changed event be sent to any registeredLoggerRepositoryEventListener
. -
getPluginRegistry
PluginRegistry getPluginRegistry()Return the PluginRegisty for this LoggerRepository.- Returns:
- plug in registry.
-
getScheduler
Scheduler getScheduler()Return theScheduler
for this LoggerRepository.- Returns:
- scheduler.
-
getProperties
Get the properties specific for this repository.- Returns:
- property map.
-
getProperty
Get the property of this repository.- Parameters:
key
- property key.- Returns:
- key value or null if not set.
-
setProperty
Set a property of this repository.- Parameters:
key
- key, may not be null.value
- new value, if null, property will be removed.
-
getErrorList
Errors which cannot be logged, go to the error list.- Returns:
- List
-
addErrorItem
Errors which cannot be logged, go to the error list.- Parameters:
errorItem
- an ErrorItem to add to the error list
-
getObject
A LoggerRepository can also act as a store for various objects used by log4j components.- Parameters:
key
- key, may not be null.- Returns:
- The object stored under 'key'.
-
putObject
Store an object under 'key'. If no object can be found, null is returned.- Parameters:
key
- key, may not be null.value
- value, may be null.
-
setLoggerFactory
void setLoggerFactory(org.apache.log4j.spi.LoggerFactory loggerFactory) Sets the logger factory used by LoggerRepository.getLogger(String).- Parameters:
loggerFactory
- factory to use, may not be null
-
getLoggerFactory
org.apache.log4j.spi.LoggerFactory getLoggerFactory()Returns the logger factory used by LoggerRepository.getLogger(String).- Returns:
- non-null factory
-