org.xwiki.logging.script

Class LoggingScriptService

java.lang.Object

org.xwiki.logging.script.LoggingScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Named(value="logging")
 @Singleton
public class LoggingScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Provide logging related script oriented APIs.

Since:

4.2M3

Version:

$Id: 7b62a7ee4e142153f6cc01a0cca716cfdab90b84 $

Constructor Summary

Constructors

Constructor and Description
LoggingScriptService()

Method Summary

Modifier and Type	Method and Description
void	deprecate(String loggerName, String message) Log a deprecated message, only if the LoggerConfiguration.isDeprecatedLogEnabled() is true.
org.xwiki.logging.LogLevel	getLevel(String loggerName)
Map<String,org.xwiki.logging.LogLevel>	getLevels()
org.slf4j.Logger	getLogger(String name) Return a logger named according to the name parameter.
void	setLevel(String logger, org.xwiki.logging.LogLevel level)
org.xwiki.logging.LogTree	toLogTree(Iterable<org.xwiki.logging.event.LogEvent> logs) Create a tree representation of a series of logs.
org.xwiki.logging.event.LogEvent	translate(org.xwiki.logging.event.LogEvent logEvent) Translate the passed LogEvent based on the translation message corresponding to the translation key stored in the LogEvent.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingScriptService

public LoggingScriptService()

Method Detail

getLogger

public org.slf4j.Logger getLogger(String name)

Return a logger named according to the name parameter.

Parameters:

name - The name of the logger.

Returns:

logger

Since:

6.1RC1

getLevels

public Map<String,org.xwiki.logging.LogLevel> getLevels()

Returns:

all the loggers (usually packages) with corresponding levels.

getLevel

public org.xwiki.logging.LogLevel getLevel(String loggerName)

Parameters:

loggerName - the logger name (usually packages)

Returns:

the level associated to the logger

setLevel

public void setLevel(String logger,
                     org.xwiki.logging.LogLevel level)

Parameters:

logger - the logger name (usually package)

level - the level associated to the logger

toLogTree

public org.xwiki.logging.LogTree toLogTree(Iterable<org.xwiki.logging.event.LogEvent> logs)

Create a tree representation of a series of logs.

Parameters:

logs - the logs

Returns:

the logs as a LogTree

Since:

5.4RC1

translate

public org.xwiki.logging.event.LogEvent translate(org.xwiki.logging.event.LogEvent logEvent)

Translate the passed LogEvent based on the translation message corresponding to the translation key stored in the LogEvent.

The translation message pattern use the same syntax than standard message pattern except that it's optionally possible to provide a custom index as in Some {1} translation {0} message in order to modify the order of the argument which can be required depending on the language.

Parameters:

logEvent - the LogEvent to translate

Returns:

the translated version of the passed LogEvent

deprecate

@Unstable
public void deprecate(String loggerName,
                                String message)

Log a deprecated message, only if the LoggerConfiguration.isDeprecatedLogEnabled() is true. Note that the deprecated message is displayed as a warning with the [DEPRECATED] suffix.

Parameters:

loggerName - the name of the logger to be used for the deprecated message.

message - the message to be displayed for explaining the deprecation.

Since:

13.1RC1