Package ch.qos.logback.access

Class PatternLayout

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.LayoutBase<E>

ch.qos.logback.core.pattern.PatternLayoutBase<IAccessEvent>

ch.qos.logback.access.PatternLayout

All Implemented Interfaces:

Layout<IAccessEvent>, ContextAware, LifeCycle

public class PatternLayout
extends PatternLayoutBase<IAccessEvent>

This class is a module-specific implementation of PatternLayout to allow http-specific patterns to be used. The ch.qos.logback.access.PatternLayout provides a way to format the logging output that is just as easy and flexible as the usual PatternLayout.

For more information about this layout, please refer to the online manual at http://logback.qos.ch/manual/layouts.html#AccessPatternLayout

Author:

Ceki Gülcü, Sébastien Pennec

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLF_PATTERN
static final String	CLF_PATTERN_NAME
static final String	CLF_PATTERN_NAME_2
static final String	COMBINED_PATTERN
static final String	COMBINED_PATTERN_NAME
static final Map<String,String>	defaultConverterMap
static final String	HEADER_PREFIX

Fields inherited from class ch.qos.logback.core.pattern.PatternLayoutBase

outputPatternAsHeader, postCompileProcessor

Fields inherited from class ch.qos.logback.core.LayoutBase

started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
PatternLayout()

Method Summary

Modifier and Type	Method	Description
String	doLayout(IAccessEvent event)	Transform an event (of type Object) and return it as a String after appropriate formatting.
Map<String,String>	getDefaultConverterMap()	Returns the default converter map for this instance.
protected String	getPresentationHeaderPrefix()
void	start()

Methods inherited from class ch.qos.logback.core.pattern.PatternLayoutBase

getEffectiveConverterMap, getInstanceConverterMap, getPattern, getPresentationHeader, isOutputPatternAsHeader, setContextForConverters, setOutputPatternAsHeader, setPattern, setPostCompileProcessor, toString, writeLoopOnConverters

Methods inherited from class ch.qos.logback.core.LayoutBase

getContentType, getContext, getFileFooter, getFileHeader, getPresentationFooter, isStarted, setContext, setFileFooter, setFileHeader, setPresentationFooter, setPresentationHeader, stop

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getDeclaredOrigin, getStatusManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn

Field Details

defaultConverterMap

public static final Map<String,String> defaultConverterMap

HEADER_PREFIX

public static final String HEADER_PREFIX

See Also:

• Constant Field Values

CLF_PATTERN

public static final String CLF_PATTERN

See Also:

• Constant Field Values

CLF_PATTERN_NAME

public static final String CLF_PATTERN_NAME

See Also:

• Constant Field Values

CLF_PATTERN_NAME_2

public static final String CLF_PATTERN_NAME_2

See Also:

• Constant Field Values

COMBINED_PATTERN

public static final String COMBINED_PATTERN

See Also:

• Constant Field Values

COMBINED_PATTERN_NAME

public static final String COMBINED_PATTERN_NAME

See Also:

• Constant Field Values

Constructor Details

PatternLayout

public PatternLayout()

Method Details

getDefaultConverterMap

public Map<String,String> getDefaultConverterMap()

Returns the default converter map for this instance.

Specified by:

getDefaultConverterMap in class PatternLayoutBase<IAccessEvent>

Returns:

A map associating pattern words to the names of converter classes

doLayout

public String doLayout(IAccessEvent event)

Description copied from interface: Layout

Transform an event (of type Object) and return it as a String after appropriate formatting.

Taking in an object and returning a String is the least sophisticated way of formatting events. However, it is remarkably CPU-effective.

Parameters:

event - The event to format

Returns:

the event formatted as a String

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class PatternLayoutBase<IAccessEvent>

getPresentationHeaderPrefix

protected String getPresentationHeaderPrefix()

Overrides:

getPresentationHeaderPrefix in class PatternLayoutBase<IAccessEvent>