Package org.apache.logging.log4j.core.util.internal

Class InternalLoggerRegistry

java.lang.Object

org.apache.logging.log4j.core.util.internal.InternalLoggerRegistry

@NullMarked
public final class InternalLoggerRegistry
extends Object

A registry of Loggers namespaced by name and message factory. This class is internally used by LoggerContext.

We don't use the registry from Log4j API to keep Log4j Core independent from the version of Log4j API at runtime. This also allows Log4j Core to evolve independently from Log4j API.

Since:

2.25.0

Field Summary

Fields

Modifier and Type	Field	Description
private final ReadWriteLock	lock
private final Map<MessageFactory,Map<String,WeakReference<Logger>>>	loggerRefByNameByMessageFactory
private final Lock	readLock
private final ReferenceQueue<Logger>	staleLoggerRefs
private final Lock	writeLock

Constructor Summary

Constructors

Constructor	Description
InternalLoggerRegistry()

Method Summary

Modifier and Type	Method	Description
Logger	computeIfAbsent(String name, MessageFactory messageFactory, BiFunction<String,MessageFactory,Logger> loggerSupplier)
private void	expungeStaleEntries()	Expunges stale entries for logger references and message factories.
@Nullable Logger	getLogger(String name, MessageFactory messageFactory)	Returns the logger associated with the given name and message factory.
Collection<Logger>	getLoggers()
boolean	hasLogger(String name, Class<? extends MessageFactory> messageFactoryClass)	Checks if a logger associated with the given name and message factory type exists.
boolean	hasLogger(String name, MessageFactory messageFactory)	Checks if a logger associated with the given name and message factory exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

loggerRefByNameByMessageFactory

private final Map<MessageFactory,Map<String,WeakReference<Logger>>> loggerRefByNameByMessageFactory

lock

private final ReadWriteLock lock

readLock

private final Lock readLock

writeLock

private final Lock writeLock

staleLoggerRefs

private final ReferenceQueue<Logger> staleLoggerRefs

Constructor Details

InternalLoggerRegistry

public InternalLoggerRegistry()

Method Details

expungeStaleEntries

private void expungeStaleEntries()

Expunges stale entries for logger references and message factories.

getLogger

public @Nullable Logger getLogger(String name,
 MessageFactory messageFactory)

Returns the logger associated with the given name and message factory.

Parameters:

name - a logger name

messageFactory - a message factory

Returns:

the logger associated with the given name and message factory

getLoggers

public Collection<Logger> getLoggers()

hasLogger

public boolean hasLogger(String name,
 MessageFactory messageFactory)

Checks if a logger associated with the given name and message factory exists.

Parameters:

name - a logger name

messageFactory - a message factory

Returns:

true, if the logger exists; false otherwise.

hasLogger

public boolean hasLogger(String name,
 Class<? extends MessageFactory> messageFactoryClass)

Checks if a logger associated with the given name and message factory type exists.

Parameters:

name - a logger name

messageFactoryClass - a message factory class

Returns:

true, if the logger exists; false otherwise.

computeIfAbsent

public Logger computeIfAbsent(String name,
 MessageFactory messageFactory,
 BiFunction<String,MessageFactory,Logger> loggerSupplier)