io.clogr

Class Clogr

java.lang.Object

io.clogr.Clogr

public class Clogr
extends Object

Csar Logging Registration (Clogr) simplifies SLF4J logger access while providing compartmentalized logging configurations via Csar.

Clogr is not yet another logging facade. Rather Clogr facilitates access to SLF4J loggers; while improving SLF4J logging configuration, allowing various compartmentalized log settings. The LoggingConcern is accessed using Csar's concern registration mechanism. The primary logging access method getLoggingConcern() will return the logging concern registered with Csar. The default, unconfigured state will still merely delegate the configured SLF4J logger factory, exactly as could be done dynamically directly from SLF4J. The benefit is that multiple logging configurations can separately be compartmentalized using Csar, and code that accesses loggers via Clogr will be routed to use the correct log configuration automatically.

Moreover classes needing access to a logger may implement Clogged for simplified retrieval of an SLF4J logger.

Author:

Garret Wilson

See Also:

Csar

Constructor Summary

Constructors

Constructor and Description
Clogr()

Method Summary

Modifier and Type	Method and Description
static Optional<LoggingConcern>	getDefaultLoggingConcern() Returns the default logging concern.
static org.slf4j.Logger	getLogger(Class<?> contextClass) Returns an appropriate logger for the current context.
static LoggingConcern	getLoggingConcern() Returns the configured logging concern for the current context.
static Optional<LoggingConcern>	setDefaultLoggingConcern(LoggingConcern loggingConcern) Sets the default logging concern.

Methods inherited from class java.lang.Object

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

Constructor Detail

Clogr

public Clogr()

Method Detail

getDefaultLoggingConcern

public static Optional<LoggingConcern> getDefaultLoggingConcern()

Returns the default logging concern.

Returns:

The default logging concern.

See Also:

Csar.getDefaultConcern(Class)

setDefaultLoggingConcern

public static Optional<LoggingConcern> setDefaultLoggingConcern(@Nonnull
                                                                LoggingConcern loggingConcern)

Sets the default logging concern.

Parameters:

loggingConcern - The default logging concern to set.

Returns:

The previous concern, or null if there was no previous concern.

Throws:

NullPointerException - if the given concern is null.

See Also:

Csar.registerDefaultConcern(Class, Concern)

getLoggingConcern

@Nonnull
public static LoggingConcern getLoggingConcern()

Returns the configured logging concern for the current context.

If no logging concern is registered for the current context, and no default logging concern is registered, a default logging concern instance will be returned that retrieves loggers with the equivalent of calling LoggerFactory.getLogger(Class).

Returns:

The configured logging concern for the current context.

See Also:

Csar.getConcern(Class), LoggingConcern.DEFAULT

getLogger

@Nonnull
public static org.slf4j.Logger getLogger(@Nonnull
                                                   Class<?> contextClass)

Returns an appropriate logger for the current context.

This is a convenience method that requests a logger from the current context logging concern.

Parameters:

contextClass - The context for which logging is to be performed.

Returns:

A logger instance to use with the given context class in the current context.

Throws:

NullPointerException - if the given context class is null.

See Also:

getLoggingConcern(), LoggingConcern.getLogger(Class)