Class 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 Detail

      • defaultConverterMap

        public static final java.util.Map<java.lang.String,​java.lang.String> defaultConverterMap
      • CLF_PATTERN_NAME

        public static final java.lang.String CLF_PATTERN_NAME
        See Also:
        Constant Field Values
      • CLF_PATTERN_NAME_2

        public static final java.lang.String CLF_PATTERN_NAME_2
        See Also:
        Constant Field Values
      • COMBINED_PATTERN

        public static final java.lang.String COMBINED_PATTERN
        See Also:
        Constant Field Values
      • COMBINED_PATTERN_NAME

        public static final java.lang.String COMBINED_PATTERN_NAME
        See Also:
        Constant Field Values
    • Constructor Detail

      • PatternLayout

        public PatternLayout()
    • Method Detail

      • getDefaultConverterMap

        public java.util.Map<java.lang.String,​java.lang.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 java.lang.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