Module ch.qos.logback.access.common
Package ch.qos.logback.access.common

Class PatternLayout

java.lang.Object
ch.qos.logback.core.spi.ContextAwareBase
ch.qos.logback.core.LayoutBase<IAccessEvent>
ch.qos.logback.core.pattern.PatternLayoutBase<IAccessEvent>
ch.qos.logback.access.common.PatternLayout
All Implemented Interfaces:
ch.qos.logback.core.Layout<IAccessEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle
public class PatternLayout extends ch.qos.logback.core.pattern.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)
     
    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

  • 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 ch.qos.logback.core.pattern.PatternLayoutBase<IAccessEvent>

    • doLayout

      public String doLayout(IAccessEvent event)

    • start

      public void start()
      Specified by:
      start in interface ch.qos.logback.core.spi.LifeCycle
      Overrides:
      start in class ch.qos.logback.core.pattern.PatternLayoutBase<IAccessEvent>

    • getPresentationHeaderPrefix

      protected String getPresentationHeaderPrefix()
      Overrides:
      getPresentationHeaderPrefix in class ch.qos.logback.core.pattern.PatternLayoutBase<IAccessEvent>