io.sarl.sre.services.logging.jul

Class JulLoggingService

java.lang.Object

com.google.common.util.concurrent.AbstractService

io.sarl.sre.services.AbstractSreService

io.sarl.sre.services.logging.jul.JulLoggingService

All Implemented Interfaces:

com.google.common.util.concurrent.Service, LoggingService

@Singleton
public class JulLoggingService
extends AbstractSreService
implements LoggingService

This class enables to log information by ensuring that the values of the parameters are not evaluated until the information should be really log, according to the log level. The logger is injected.

The LoggingService considers the parameters of the functions as:

• the message is the the message in the property file;
• the parameters are the values that will replace the strings {0}, {1}, {2}... in the text extracted from the resource property.

If a Throwable is passed as parameter, the text of the exception is retrieved.

If a Callable is passed as parameter, the object is automatically called.

If a LogParam is passed as parameter, the toString function will be invoked.

For all the other objects, the AbstractService.toString() function is invoked.

This service is thread-safe.

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Constructor Summary

Constructors

Constructor and Description
JulLoggingService(loggerCreator : JulLoggerCreator) Constructor.

Method Summary

Modifier and Type	Method and Description
Logger	createAgentLogger(name : String, [initialLevel : Level]) Create a logger for an agent.
Logger	getKernelLogger() Replies the logger used by the kernel.
Logger	getKernelModuleLogger(moduleName : String) Replies the logger used by a specific module of the kernel.
Logger	getPlatformLogger() Replies the logger used by the platform.

Methods inherited from class io.sarl.sre.services.AbstractSreService

doStart, doStop, onStart, onStop

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Constructor Detail

JulLoggingService

@Inject
public new(loggerCreator : JulLoggerCreator)

Constructor.

Parameters:

loggerCreator - the creator.

Method Detail

getPlatformLogger

@Pure
public def getPlatformLogger() : Logger 

Description copied from interface: LoggingService

Replies the logger used by the platform. The platform logger is the root logger for all the other loggers (for kernel and agents). It is not recommended to use this logger directly.

Specified by:

getPlatformLogger in interface LoggingService

Returns:

the logger.

getKernelLogger

@Pure
public def getKernelLogger() : Logger 

Description copied from interface: LoggingService

Replies the logger used by the kernel.

Specified by:

getKernelLogger in interface LoggingService

Returns:

the logger.

See Also:

LoggingService.getKernelModuleLogger(String)

getKernelModuleLogger

@Pure
public def getKernelModuleLogger(moduleName : String) : Logger 

Description copied from interface: LoggingService

Replies the logger used by a specific module of the kernel.

Specified by:

getKernelModuleLogger in interface LoggingService

Returns:

the logger.

See Also:

LoggingService.getKernelLogger()

createAgentLogger

public def createAgentLogger(name : String,
                             [initialLevel : Level]) : Logger 

Description copied from interface: LoggingService

Create a logger for an agent.

Specified by:

createAgentLogger in interface LoggingService

Parameters:

name - the name of the logger, usually the name of the agent.

initialLevel - the initial level to associate to the logger. If it is null, the level is the less verbose between the default level (given in the SRE configuration) and the parent level.

Returns:

the logger.