A LoggerRepository is used to create and retrieve Loggers. More...

#include <loggerrepository.h>

Inheritance diagram for log4cxx::spi::LoggerRepository:

Public Member Functions
virtual	~LoggerRepository ()
virtual void	addHierarchyEventListener (const HierarchyEventListenerPtr &listener)=0
	Add `listener` to the repository.
virtual void	removeHierarchyEventListener (const spi::HierarchyEventListenerPtr &listener)=0
	Remove `listener` from the repository.
virtual void	ensureIsConfigured (std::function< void()> configurator)=0
	Call `configurator` if not yet configured and `configurator` has not already been tried.
virtual bool	isDisabled (int level) const =0
	Is the repository disabled for `level`?
virtual void	setThreshold (const LevelPtr &newLevel)=0
	Enable logging for logging requests with level `newLevel` or higher.
virtual void	setThreshold (const LogString &newLevel)=0
	Enable logging for logging requests with level `newLevel` or higher.
virtual void	emitNoAppenderWarning (const Logger *logger)=0
	Add a warning to internal debug output that `logger` does not have any Appender attached.
virtual LevelPtr	getThreshold () const =0
	The current repository-wide threshold.
virtual LoggerPtr	getLogger (const LogString &name, const spi::LoggerFactoryPtr &factory={})=0
	Retrieve the `name` Logger instance.
virtual bool	removeLogger (const LogString &name, bool ifNotUsed=true)=0
	Remove the `name` Logger from the repository.
virtual LoggerPtr	getRootLogger () const =0
	The logger that cannot be retrieved by name.
virtual LoggerPtr	exists (const LogString &name)=0
	Does `name` exist in the repository?
virtual void	shutdown ()=0
	Close and remove all appenders in all categories including the root logger.
virtual LoggerList	getCurrentLoggers () const =0
	All the loggers currently defined in this repository.
virtual void	fireAddAppenderEvent (const Logger logger, const Appender appender)
	Call addAppenderEvent on all registered listeners.
virtual void	fireRemoveAppenderEvent (const Logger logger, const Appender appender)
	Call removeAppenderEvent on all registered listeners.
virtual void	resetConfiguration ()=0
	Reset all values contained in this repository instance to their default.
virtual bool	isConfigured ()=0
	The value of the configured status.
virtual void	setConfigured (bool configured)=0
	Set the configured status to `true`.
virtual void	updateChildren (const Logger *parent)=0
	Refresh the configuration of all loggers where `parent` is somewhere in their ancestor chain.
Public Member Functions inherited from log4cxx::helpers::Object
virtual	~Object ()
virtual const helpers::Class &	getClass () const =0
virtual bool	instanceof (const Class &clazz) const =0
virtual const void *	cast (const Class &clazz) const =0

Detailed Description

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.

Constructor & Destructor Documentation

◆ ~LoggerRepository()

virtual log4cxx::spi::LoggerRepository::~LoggerRepository ( )

virtual

Member Function Documentation

◆ addHierarchyEventListener()

virtual void log4cxx::spi::LoggerRepository::addHierarchyEventListener ( const HierarchyEventListenerPtr & listener )

pure virtual

Add listener to the repository.

◆ emitNoAppenderWarning()

virtual void log4cxx::spi::LoggerRepository::emitNoAppenderWarning ( const Logger * logger )

pure virtual

Add a warning to internal debug output that logger does not have any Appender attached.

To avoid overloading the output stream, the warning is emitted only once.

Implemented in log4cxx::Hierarchy.

◆ ensureIsConfigured()

virtual void log4cxx::spi::LoggerRepository::ensureIsConfigured ( std::function< void()> configurator )

pure virtual

Call configurator if not yet configured and configurator has not already been tried.

If configurator succeeds, it must call LoggerRepository::setConfigured to ensure subsequent calls to LoggerRepository::ensureIsConfigured from overwriting the configuration.

Implemented in log4cxx::Hierarchy.

◆ exists()

virtual LoggerPtr log4cxx::spi::LoggerRepository::exists ( const LogString & name )

pure virtual

Does name exist in the repository?

Returns: The Logger instance if name exists in the repository.

Implemented in log4cxx::Hierarchy.

◆ fireAddAppenderEvent()

virtual void log4cxx::spi::LoggerRepository::fireAddAppenderEvent	(	const Logger *	logger,
		const Appender *	appender )

virtual

Call addAppenderEvent on all registered listeners.

Reimplemented in log4cxx::Hierarchy.

◆ fireRemoveAppenderEvent()

virtual void log4cxx::spi::LoggerRepository::fireRemoveAppenderEvent	(	const Logger *	logger,
		const Appender *	appender )

virtual

Call removeAppenderEvent on all registered listeners.

Reimplemented in log4cxx::Hierarchy.

◆ getCurrentLoggers()

virtual LoggerList log4cxx::spi::LoggerRepository::getCurrentLoggers ( ) const

pure virtual

All the loggers currently defined in this repository.

The root logger is not included in the returned LoggerList.

Implemented in log4cxx::Hierarchy.

◆ getLogger()

virtual LoggerPtr log4cxx::spi::LoggerRepository::getLogger	(	const LogString &	name,
		const spi::LoggerFactoryPtr &	factory = {} )

pure virtual

Retrieve the name Logger instance.

If a logger of that name already exists, it will be returned. Otherwise, a new logger will be instantiated, optionally by calling factory->makeNewLoggerInstance().

Parameters

name	The logger to retrieve.
factory	If provided, used to instantiate a new logger.

Implemented in log4cxx::Hierarchy.

◆ getRootLogger()

virtual LoggerPtr log4cxx::spi::LoggerRepository::getRootLogger ( ) const

pure virtual

The logger that cannot be retrieved by name.

Implemented in log4cxx::Hierarchy.

◆ getThreshold()

virtual LevelPtr log4cxx::spi::LoggerRepository::getThreshold ( ) const

pure virtual

The current repository-wide threshold.

See setThreshold for an explanation.

Implemented in log4cxx::Hierarchy.

◆ isConfigured()

virtual bool log4cxx::spi::LoggerRepository::isConfigured ( )

pure virtual

The value of the configured status.

Implemented in log4cxx::Hierarchy.

◆ isDisabled()

virtual bool log4cxx::spi::LoggerRepository::isDisabled ( int level ) const

pure virtual

Is the repository disabled for level?

The answer depends on the repository threshold and the level parameter. See also the setThreshold method.

Implemented in log4cxx::Hierarchy.

◆ removeHierarchyEventListener()

virtual void log4cxx::spi::LoggerRepository::removeHierarchyEventListener ( const spi::HierarchyEventListenerPtr & listener )

pure virtual

Remove listener from the repository.

Implemented in log4cxx::Hierarchy.

◆ removeLogger()

virtual bool log4cxx::spi::LoggerRepository::removeLogger	(	const LogString &	name,
		bool	ifNotUsed = true )

pure virtual

Remove the name Logger from the repository.

Note: The name Logger must be retrieved from the repository after any subsequent configuration file change for the newly loaded settings to be used.

Parameters

name	The logger to remove.
ifNotUsed	If true and use_count() indicates there are other references, do not remove the Logger and return false.

Returns: true if name Logger was removed from the repository.

Implemented in log4cxx::Hierarchy.

◆ resetConfiguration()

virtual void log4cxx::spi::LoggerRepository::resetConfiguration ( )

pure virtual

Reset all values contained in this repository instance to their default.

This removes all appenders from all categories, sets the level of all non-root categories to null, sets their additivity flag to true and sets the level of the root logger to DEBUG. Also the repository wide threshold is set its default "ALL" value.

Existing categories are not removed.

This method should be used sparingly and with care as it will block all logging until this is configured again.

Implemented in log4cxx::Hierarchy.

◆ setConfigured()

virtual void log4cxx::spi::LoggerRepository::setConfigured ( bool configured )

pure virtual

Set the configured status to true.

Implemented in log4cxx::Hierarchy.

◆ setThreshold() [1/2]

virtual void log4cxx::spi::LoggerRepository::setThreshold ( const LevelPtr & newLevel )

pure virtual

Enable logging for logging requests with level newLevel or higher.

All logging requests below the threshold are immediately dropped. By default, the threshold is set to Level::getAll() which has the lowest possible rank.

Implemented in log4cxx::Hierarchy.

◆ setThreshold() [2/2]

virtual void log4cxx::spi::LoggerRepository::setThreshold ( const LogString & newLevel )

pure virtual

Enable logging for logging requests with level newLevel or higher.

The threshold is set the DEBUG if newLevel is not recognised by Level::getLevel. All logging requests below the threshold are immediately dropped. By default, the threshold is set to Level::getAll() which has the lowest possible rank.

Implemented in log4cxx::Hierarchy.

◆ shutdown()

virtual void log4cxx::spi::LoggerRepository::shutdown ( )

pure virtual

Close and remove all appenders in all categories including the root logger.

The configured status becomes false.

Implemented in log4cxx::Hierarchy.

◆ updateChildren()

virtual void log4cxx::spi::LoggerRepository::updateChildren ( const Logger * parent )

pure virtual

Refresh the configuration of all loggers where parent is somewhere in their ancestor chain.

The ancestor chain ends at the root logger.

Implemented in log4cxx::Hierarchy.

The documentation for this class was generated from the following file:

loggerrepository.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~LoggerRepository()

Member Function Documentation

◆ addHierarchyEventListener()

◆ emitNoAppenderWarning()

◆ ensureIsConfigured()

◆ exists()

◆ fireAddAppenderEvent()

◆ fireRemoveAppenderEvent()

◆ getCurrentLoggers()

◆ getLogger()

◆ getRootLogger()

◆ getThreshold()

◆ isConfigured()

◆ isDisabled()

◆ removeHierarchyEventListener()

◆ removeLogger()

◆ resetConfiguration()

◆ setConfigured()

◆ setThreshold() [1/2]

◆ setThreshold() [2/2]

◆ shutdown()

◆ updateChildren()