View Javadoc
1   /**
2    * Logback: the reliable, generic, fast and flexible logging framework.
3    * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
4    *
5    * This program and the accompanying materials are dual-licensed under
6    * either the terms of the Eclipse Public License v1.0 as published by
7    * the Eclipse Foundation
8    *
9    *   or (per the licensee's choosing)
10   *
11   * under the terms of the GNU Lesser General Public License version 2.1
12   * as published by the Free Software Foundation.
13   */
14  package ch.qos.logback.classic;
15  
16  import java.util.HashMap;
17  import java.util.Map;
18  
19  import ch.qos.logback.classic.pattern.*;
20  import ch.qos.logback.classic.pattern.color.HighlightingCompositeConverter;
21  import ch.qos.logback.classic.spi.ILoggingEvent;
22  import ch.qos.logback.core.CoreConstants;
23  import ch.qos.logback.core.pattern.PatternLayoutBase;
24  import ch.qos.logback.core.pattern.color.*;
25  import ch.qos.logback.core.pattern.parser.Parser;
26  
27  /**
28   * <p>
29   * A flexible layout configurable with pattern string. The goal of this class is
30   * to {@link #format format} a {@link ILoggingEvent} and return the results in a
31   * {#link String}. The format of the result depends on the <em>conversion
32   * pattern</em>.
33   * <p>
34   * For more information about this layout, please refer to the online manual at
35   * http://logback.qos.ch/manual/layouts.html#PatternLayout
36   * 
37   */
38  
39  public class PatternLayout extends PatternLayoutBase<ILoggingEvent> {
40  
41      public static final Map<String, String> DEFAULT_CONVERTER_MAP = new HashMap<String, String>();
42      public static final Map<String, String> CONVERTER_CLASS_TO_KEY_MAP = new HashMap<String, String>();
43  
44      /**
45       * @deprecated replaced by DEFAULT_CONVERTER_MAP
46       */
47      public static final Map<String, String> defaultConverterMap = DEFAULT_CONVERTER_MAP;
48  
49      public static final String HEADER_PREFIX = "#logback.classic pattern: ";
50  
51      static {
52          DEFAULT_CONVERTER_MAP.putAll(Parser.DEFAULT_COMPOSITE_CONVERTER_MAP);
53  
54          DEFAULT_CONVERTER_MAP.put("d", DateConverter.class.getName());
55          DEFAULT_CONVERTER_MAP.put("date", DateConverter.class.getName());
56          // used by PrefixComposite conventer
57          CONVERTER_CLASS_TO_KEY_MAP.put(DateConverter.class.getName(), "date");
58  
59          DEFAULT_CONVERTER_MAP.put("ms", MicrosecondConverter.class.getName());
60          DEFAULT_CONVERTER_MAP.put("micros", MicrosecondConverter.class.getName());
61          CONVERTER_CLASS_TO_KEY_MAP.put(MicrosecondConverter.class.getName(), "micros");
62  
63          DEFAULT_CONVERTER_MAP.put("r", RelativeTimeConverter.class.getName());
64          DEFAULT_CONVERTER_MAP.put("relative", RelativeTimeConverter.class.getName());
65          CONVERTER_CLASS_TO_KEY_MAP.put(RelativeTimeConverter.class.getName(), "relative");
66  
67          DEFAULT_CONVERTER_MAP.put("level", LevelConverter.class.getName());
68          DEFAULT_CONVERTER_MAP.put("le", LevelConverter.class.getName());
69          DEFAULT_CONVERTER_MAP.put("p", LevelConverter.class.getName());
70          CONVERTER_CLASS_TO_KEY_MAP.put(LevelConverter.class.getName(), "level");
71  
72          DEFAULT_CONVERTER_MAP.put("t", ThreadConverter.class.getName());
73          DEFAULT_CONVERTER_MAP.put("thread", ThreadConverter.class.getName());
74          CONVERTER_CLASS_TO_KEY_MAP.put(ThreadConverter.class.getName(), "thread");
75  
76          DEFAULT_CONVERTER_MAP.put("lo", LoggerConverter.class.getName());
77          DEFAULT_CONVERTER_MAP.put("logger", LoggerConverter.class.getName());
78          DEFAULT_CONVERTER_MAP.put("c", LoggerConverter.class.getName());
79          CONVERTER_CLASS_TO_KEY_MAP.put(LoggerConverter.class.getName(), "logger");
80  
81          DEFAULT_CONVERTER_MAP.put("m", MessageConverter.class.getName());
82          DEFAULT_CONVERTER_MAP.put("msg", MessageConverter.class.getName());
83          DEFAULT_CONVERTER_MAP.put("message", MessageConverter.class.getName());
84          CONVERTER_CLASS_TO_KEY_MAP.put(MessageConverter.class.getName(), "message");
85  
86          DEFAULT_CONVERTER_MAP.put("C", ClassOfCallerConverter.class.getName());
87          DEFAULT_CONVERTER_MAP.put("class", ClassOfCallerConverter.class.getName());
88          CONVERTER_CLASS_TO_KEY_MAP.put(ClassOfCallerConverter.class.getName(), "class");
89  
90          DEFAULT_CONVERTER_MAP.put("M", MethodOfCallerConverter.class.getName());
91          DEFAULT_CONVERTER_MAP.put("method", MethodOfCallerConverter.class.getName());
92          CONVERTER_CLASS_TO_KEY_MAP.put(MethodOfCallerConverter.class.getName(), "method");
93  
94          DEFAULT_CONVERTER_MAP.put("L", LineOfCallerConverter.class.getName());
95          DEFAULT_CONVERTER_MAP.put("line", LineOfCallerConverter.class.getName());
96          CONVERTER_CLASS_TO_KEY_MAP.put(LineOfCallerConverter.class.getName(), "line");
97  
98          DEFAULT_CONVERTER_MAP.put("F", FileOfCallerConverter.class.getName());
99          DEFAULT_CONVERTER_MAP.put("file", FileOfCallerConverter.class.getName());
100         CONVERTER_CLASS_TO_KEY_MAP.put(FileOfCallerConverter.class.getName(), "file");
101 
102         DEFAULT_CONVERTER_MAP.put("X", MDCConverter.class.getName());
103         DEFAULT_CONVERTER_MAP.put("mdc", MDCConverter.class.getName());
104 
105         DEFAULT_CONVERTER_MAP.put("ex", ThrowableProxyConverter.class.getName());
106         DEFAULT_CONVERTER_MAP.put("exception", ThrowableProxyConverter.class.getName());
107         DEFAULT_CONVERTER_MAP.put("rEx", RootCauseFirstThrowableProxyConverter.class.getName());
108         DEFAULT_CONVERTER_MAP.put("rootException", RootCauseFirstThrowableProxyConverter.class.getName());
109         DEFAULT_CONVERTER_MAP.put("throwable", ThrowableProxyConverter.class.getName());
110 
111         DEFAULT_CONVERTER_MAP.put("xEx", ExtendedThrowableProxyConverter.class.getName());
112         DEFAULT_CONVERTER_MAP.put("xException", ExtendedThrowableProxyConverter.class.getName());
113         DEFAULT_CONVERTER_MAP.put("xThrowable", ExtendedThrowableProxyConverter.class.getName());
114 
115         DEFAULT_CONVERTER_MAP.put("nopex", NopThrowableInformationConverter.class.getName());
116         DEFAULT_CONVERTER_MAP.put("nopexception", NopThrowableInformationConverter.class.getName());
117 
118         DEFAULT_CONVERTER_MAP.put("cn", ContextNameConverter.class.getName());
119         DEFAULT_CONVERTER_MAP.put("contextName", ContextNameConverter.class.getName());
120         CONVERTER_CLASS_TO_KEY_MAP.put(ContextNameConverter.class.getName(), "contextName");
121 
122         DEFAULT_CONVERTER_MAP.put("caller", CallerDataConverter.class.getName());
123         CONVERTER_CLASS_TO_KEY_MAP.put(CallerDataConverter.class.getName(), "caller");
124 
125         DEFAULT_CONVERTER_MAP.put("marker", MarkerConverter.class.getName());
126         CONVERTER_CLASS_TO_KEY_MAP.put(MarkerConverter.class.getName(), "marker");
127 
128         DEFAULT_CONVERTER_MAP.put("kvp", KeyValuePairConverter.class.getName());
129         CONVERTER_CLASS_TO_KEY_MAP.put(KeyValuePairConverter.class.getName(), "kvp");
130 
131         DEFAULT_CONVERTER_MAP.put("property", PropertyConverter.class.getName());
132 
133         DEFAULT_CONVERTER_MAP.put("n", LineSeparatorConverter.class.getName());
134 
135         DEFAULT_CONVERTER_MAP.put("black", BlackCompositeConverter.class.getName());
136         DEFAULT_CONVERTER_MAP.put("red", RedCompositeConverter.class.getName());
137         DEFAULT_CONVERTER_MAP.put("green", GreenCompositeConverter.class.getName());
138         DEFAULT_CONVERTER_MAP.put("yellow", YellowCompositeConverter.class.getName());
139         DEFAULT_CONVERTER_MAP.put("blue", BlueCompositeConverter.class.getName());
140         DEFAULT_CONVERTER_MAP.put("magenta", MagentaCompositeConverter.class.getName());
141         DEFAULT_CONVERTER_MAP.put("cyan", CyanCompositeConverter.class.getName());
142         DEFAULT_CONVERTER_MAP.put("white", WhiteCompositeConverter.class.getName());
143         DEFAULT_CONVERTER_MAP.put("gray", GrayCompositeConverter.class.getName());
144         DEFAULT_CONVERTER_MAP.put("boldRed", BoldRedCompositeConverter.class.getName());
145         DEFAULT_CONVERTER_MAP.put("boldGreen", BoldGreenCompositeConverter.class.getName());
146         DEFAULT_CONVERTER_MAP.put("boldYellow", BoldYellowCompositeConverter.class.getName());
147         DEFAULT_CONVERTER_MAP.put("boldBlue", BoldBlueCompositeConverter.class.getName());
148         DEFAULT_CONVERTER_MAP.put("boldMagenta", BoldMagentaCompositeConverter.class.getName());
149         DEFAULT_CONVERTER_MAP.put("boldCyan", BoldCyanCompositeConverter.class.getName());
150         DEFAULT_CONVERTER_MAP.put("boldWhite", BoldWhiteCompositeConverter.class.getName());
151         DEFAULT_CONVERTER_MAP.put("highlight", HighlightingCompositeConverter.class.getName());
152 
153         DEFAULT_CONVERTER_MAP.put("lsn", LocalSequenceNumberConverter.class.getName());
154         CONVERTER_CLASS_TO_KEY_MAP.put(LocalSequenceNumberConverter.class.getName(), "lsn");
155 
156         DEFAULT_CONVERTER_MAP.put("prefix", PrefixCompositeConverter.class.getName());
157 
158     }
159 
160     public PatternLayout() {
161         this.postCompileProcessor = new EnsureExceptionHandling();
162     }
163 
164     public Map<String, String> getDefaultConverterMap() {
165         return DEFAULT_CONVERTER_MAP;
166     }
167 
168     public String doLayout(ILoggingEvent event) {
169         if (!isStarted()) {
170             return CoreConstants.EMPTY_STRING;
171         }
172         return writeLoopOnConverters(event);
173     }
174 
175     @Override
176     protected String getPresentationHeaderPrefix() {
177         return HEADER_PREFIX;
178     }
179 }