1
2
3
4
5
6
7
8
9
10
11
12
13
14 package ch.qos.logback.classic;
15
16 import java.util.HashMap;
17 import java.util.Map;
18 import java.util.function.Supplier;
19
20 import ch.qos.logback.classic.pattern.*;
21 import ch.qos.logback.classic.pattern.color.HighlightingCompositeConverter;
22 import ch.qos.logback.classic.spi.ILoggingEvent;
23 import ch.qos.logback.core.CoreConstants;
24 import ch.qos.logback.core.pattern.DynamicConverter;
25 import ch.qos.logback.core.pattern.PatternLayoutBase;
26 import ch.qos.logback.core.pattern.color.*;
27 import ch.qos.logback.core.pattern.parser.Parser;
28
29
30
31
32
33
34
35
36
37
38
39
40
41 public class PatternLayout extends PatternLayoutBase<ILoggingEvent> {
42
43 public static final Map<String, Supplier<DynamicConverter>> DEFAULT_CONVERTER_SUPPLIER_MAP = new HashMap<>();
44
45 public static final Map<String, String> DEFAULT_CONVERTER_MAP = new HashMap<>();
46 public static final Map<String, String> CONVERTER_CLASS_TO_KEY_MAP = new HashMap<String, String>();
47
48
49
50
51 @Deprecated
52 public static final Map<String, String> defaultConverterMap = DEFAULT_CONVERTER_MAP;
53
54 public static final String HEADER_PREFIX = "#logback.classic pattern: ";
55
56 static {
57 DEFAULT_CONVERTER_SUPPLIER_MAP.putAll(Parser.DEFAULT_COMPOSITE_CONVERTER_MAP);
58
59 DEFAULT_CONVERTER_SUPPLIER_MAP.put("d", DateConverter::new);
60 DEFAULT_CONVERTER_SUPPLIER_MAP.put("date", DateConverter::new);
61
62 CONVERTER_CLASS_TO_KEY_MAP.put(DateConverter.class.getName(), "date");
63
64 DEFAULT_CONVERTER_SUPPLIER_MAP.put("ms", MicrosecondConverter::new);
65 DEFAULT_CONVERTER_SUPPLIER_MAP.put("micros", MicrosecondConverter::new);
66 CONVERTER_CLASS_TO_KEY_MAP.put(MicrosecondConverter.class.getName(), "micros");
67
68 DEFAULT_CONVERTER_SUPPLIER_MAP.put("r", RelativeTimeConverter::new);
69 DEFAULT_CONVERTER_SUPPLIER_MAP.put("relative", RelativeTimeConverter::new);
70 CONVERTER_CLASS_TO_KEY_MAP.put(RelativeTimeConverter.class.getName(), "relative");
71
72 DEFAULT_CONVERTER_SUPPLIER_MAP.put("level", LevelConverter::new);
73 DEFAULT_CONVERTER_SUPPLIER_MAP.put("le", LevelConverter::new);
74 DEFAULT_CONVERTER_SUPPLIER_MAP.put("p", LevelConverter::new);
75 CONVERTER_CLASS_TO_KEY_MAP.put(LevelConverter.class.getName(), "level");
76
77 DEFAULT_CONVERTER_SUPPLIER_MAP.put("t", ThreadConverter::new);
78 DEFAULT_CONVERTER_SUPPLIER_MAP.put("thread", ThreadConverter::new);
79 CONVERTER_CLASS_TO_KEY_MAP.put(ThreadConverter.class.getName(), "thread");
80
81 DEFAULT_CONVERTER_SUPPLIER_MAP.put("lo", LoggerConverter::new);
82 DEFAULT_CONVERTER_SUPPLIER_MAP.put("logger", LoggerConverter::new);
83 DEFAULT_CONVERTER_SUPPLIER_MAP.put("c", LoggerConverter::new);
84 CONVERTER_CLASS_TO_KEY_MAP.put(LoggerConverter.class.getName(), "logger");
85
86 DEFAULT_CONVERTER_SUPPLIER_MAP.put("m", MessageConverter::new);
87 DEFAULT_CONVERTER_SUPPLIER_MAP.put("msg", MessageConverter::new);
88 DEFAULT_CONVERTER_SUPPLIER_MAP.put("message", MessageConverter::new);
89 CONVERTER_CLASS_TO_KEY_MAP.put(MessageConverter.class.getName(), "message");
90
91 DEFAULT_CONVERTER_SUPPLIER_MAP.put("C", ClassOfCallerConverter::new);
92 DEFAULT_CONVERTER_SUPPLIER_MAP.put("class", ClassOfCallerConverter::new);
93 CONVERTER_CLASS_TO_KEY_MAP.put(ClassOfCallerConverter.class.getName(), "class");
94
95 DEFAULT_CONVERTER_SUPPLIER_MAP.put("M", MethodOfCallerConverter::new);
96 DEFAULT_CONVERTER_SUPPLIER_MAP.put("method", MethodOfCallerConverter::new);
97 CONVERTER_CLASS_TO_KEY_MAP.put(MethodOfCallerConverter.class.getName(), "method");
98
99 DEFAULT_CONVERTER_SUPPLIER_MAP.put("L", LineOfCallerConverter::new);
100 DEFAULT_CONVERTER_SUPPLIER_MAP.put("line", LineOfCallerConverter::new);
101 CONVERTER_CLASS_TO_KEY_MAP.put(LineOfCallerConverter.class.getName(), "line");
102
103 DEFAULT_CONVERTER_SUPPLIER_MAP.put("F", FileOfCallerConverter::new);
104 DEFAULT_CONVERTER_SUPPLIER_MAP.put("file", FileOfCallerConverter::new);
105 CONVERTER_CLASS_TO_KEY_MAP.put(FileOfCallerConverter.class.getName(), "file");
106
107 DEFAULT_CONVERTER_SUPPLIER_MAP.put("X", MDCConverter::new);
108 DEFAULT_CONVERTER_SUPPLIER_MAP.put("mdc", MDCConverter::new);
109
110 DEFAULT_CONVERTER_SUPPLIER_MAP.put("ex", ThrowableProxyConverter::new);
111 DEFAULT_CONVERTER_SUPPLIER_MAP.put("exception", ThrowableProxyConverter::new);
112 DEFAULT_CONVERTER_SUPPLIER_MAP.put("rEx", RootCauseFirstThrowableProxyConverter::new);
113 DEFAULT_CONVERTER_SUPPLIER_MAP.put("rootException", RootCauseFirstThrowableProxyConverter::new);
114 DEFAULT_CONVERTER_SUPPLIER_MAP.put("throwable", ThrowableProxyConverter::new);
115
116 DEFAULT_CONVERTER_SUPPLIER_MAP.put("xEx", ExtendedThrowableProxyConverter::new);
117 DEFAULT_CONVERTER_SUPPLIER_MAP.put("xException", ExtendedThrowableProxyConverter::new);
118 DEFAULT_CONVERTER_SUPPLIER_MAP.put("xThrowable", ExtendedThrowableProxyConverter::new);
119
120 DEFAULT_CONVERTER_SUPPLIER_MAP.put("nopex", NopThrowableInformationConverter::new);
121 DEFAULT_CONVERTER_SUPPLIER_MAP.put("nopexception", NopThrowableInformationConverter::new);
122
123 DEFAULT_CONVERTER_SUPPLIER_MAP.put("cn", ContextNameConverter::new);
124 DEFAULT_CONVERTER_SUPPLIER_MAP.put("contextName", ContextNameConverter::new);
125 CONVERTER_CLASS_TO_KEY_MAP.put(ContextNameConverter.class.getName(), "contextName");
126
127 DEFAULT_CONVERTER_SUPPLIER_MAP.put("caller", CallerDataConverter::new);
128 CONVERTER_CLASS_TO_KEY_MAP.put(CallerDataConverter.class.getName(), "caller");
129
130 DEFAULT_CONVERTER_SUPPLIER_MAP.put("marker", MarkerConverter::new);
131 CONVERTER_CLASS_TO_KEY_MAP.put(MarkerConverter.class.getName(), "marker");
132
133 DEFAULT_CONVERTER_SUPPLIER_MAP.put("kvp", KeyValuePairConverter::new);
134 CONVERTER_CLASS_TO_KEY_MAP.put(KeyValuePairConverter.class.getName(), "kvp");
135
136 DEFAULT_CONVERTER_SUPPLIER_MAP.put("maskedKvp", MaskedKeyValuePairConverter::new);
137 CONVERTER_CLASS_TO_KEY_MAP.put(MaskedKeyValuePairConverter.class.getName(), "maskedKvp");
138
139 DEFAULT_CONVERTER_SUPPLIER_MAP.put("property", PropertyConverter::new);
140
141 DEFAULT_CONVERTER_SUPPLIER_MAP.put("n", LineSeparatorConverter::new);
142
143 DEFAULT_CONVERTER_SUPPLIER_MAP.put("black", BlackCompositeConverter::new);
144 DEFAULT_CONVERTER_SUPPLIER_MAP.put("red", RedCompositeConverter::new);
145 DEFAULT_CONVERTER_SUPPLIER_MAP.put("green", GreenCompositeConverter::new);
146 DEFAULT_CONVERTER_SUPPLIER_MAP.put("yellow", YellowCompositeConverter::new);
147 DEFAULT_CONVERTER_SUPPLIER_MAP.put("blue", BlueCompositeConverter::new);
148 DEFAULT_CONVERTER_SUPPLIER_MAP.put("magenta", MagentaCompositeConverter::new);
149 DEFAULT_CONVERTER_SUPPLIER_MAP.put("cyan", CyanCompositeConverter::new);
150 DEFAULT_CONVERTER_SUPPLIER_MAP.put("white", WhiteCompositeConverter::new);
151 DEFAULT_CONVERTER_SUPPLIER_MAP.put("gray", GrayCompositeConverter::new);
152 DEFAULT_CONVERTER_SUPPLIER_MAP.put("boldRed", BoldRedCompositeConverter::new);
153 DEFAULT_CONVERTER_SUPPLIER_MAP.put("boldGreen", BoldGreenCompositeConverter::new);
154 DEFAULT_CONVERTER_SUPPLIER_MAP.put("boldYellow", BoldYellowCompositeConverter::new);
155 DEFAULT_CONVERTER_SUPPLIER_MAP.put("boldBlue", BoldBlueCompositeConverter::new);
156 DEFAULT_CONVERTER_SUPPLIER_MAP.put("boldMagenta", BoldMagentaCompositeConverter::new);
157 DEFAULT_CONVERTER_SUPPLIER_MAP.put("boldCyan", BoldCyanCompositeConverter::new);
158 DEFAULT_CONVERTER_SUPPLIER_MAP.put("boldWhite", BoldWhiteCompositeConverter::new);
159 DEFAULT_CONVERTER_SUPPLIER_MAP.put("highlight", HighlightingCompositeConverter::new);
160
161 DEFAULT_CONVERTER_SUPPLIER_MAP.put("lsn", LocalSequenceNumberConverter::new);
162 CONVERTER_CLASS_TO_KEY_MAP.put(LocalSequenceNumberConverter.class.getName(), "lsn");
163
164 DEFAULT_CONVERTER_SUPPLIER_MAP.put("sn", SequenceNumberConverter::new);
165 DEFAULT_CONVERTER_SUPPLIER_MAP.put("sequenceNumber", SequenceNumberConverter::new);
166 CONVERTER_CLASS_TO_KEY_MAP.put(SequenceNumberConverter.class.getName(), "sequenceNumber");
167
168 DEFAULT_CONVERTER_SUPPLIER_MAP.put("prefix", PrefixCompositeConverter::new);
169
170 }
171
172 public PatternLayout() {
173 this.postCompileProcessor = new EnsureExceptionHandling();
174 }
175
176 public Map<String, Supplier<DynamicConverter>> getDefaultConverterSupplierMap() {
177 return DEFAULT_CONVERTER_SUPPLIER_MAP;
178 }
179
180
181
182
183
184
185
186
187
188
189
190
191 @Deprecated
192 public Map<String, String> getDefaultConverterMap() {
193 return DEFAULT_CONVERTER_MAP;
194 }
195
196 public String doLayout(ILoggingEvent event) {
197 if (!isStarted()) {
198 return CoreConstants.EMPTY_STRING;
199 }
200 return writeLoopOnConverters(event);
201 }
202
203 @Override
204 protected String getPresentationHeaderPrefix() {
205 return HEADER_PREFIX;
206 }
207 }