Package org.wso2.carbon.log4j2.plugins

Class TenantIdConverter

java.lang.Object

org.apache.logging.log4j.core.pattern.AbstractPatternConverter

org.apache.logging.log4j.core.pattern.LogEventPatternConverter

org.wso2.carbon.log4j2.plugins.TenantIdConverter

All Implemented Interfaces:

org.apache.logging.log4j.core.pattern.PatternConverter

@Plugin(name="TenantIdConverter",
        category="Converter")
public class TenantIdConverter
extends org.apache.logging.log4j.core.pattern.LogEventPatternConverter

This Converter is used to register the tenantId as a parameter in the log message. The value specified for @ConverterKeys is used as the syntax to refer the tenantId in the configuration file. Refer documentation Converters are required to provide a static newInstance method that accepts an array of Strings as the only parameter. Similar implementation in log4J package ThreadNamePatternConverter

Field Summary

Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

LOGGER

Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

CATEGORY

Method Summary

Modifier and Type	Method	Description
void	format(org.apache.logging.log4j.core.LogEvent event, StringBuilder toAppendTo)
static TenantIdConverter	newInstance(String[] options)	Obtains an instance of TenantIdConverter.

Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

format, handlesThrowable, isVariable

Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

getName, getStyleClass

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static TenantIdConverter newInstance(String[] options)

Obtains an instance of TenantIdConverter.

Parameters:

options - ignored since it cannot be configured in log4j2.properties

Returns:

instance of TenantIdConverter

format

public void format(org.apache.logging.log4j.core.LogEvent event,
                   StringBuilder toAppendTo)

Specified by:

format in class org.apache.logging.log4j.core.pattern.LogEventPatternConverter