1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.mina.util;
21
22 import java.util.Arrays;
23 import java.util.Map;
24 import java.util.Set;
25 import java.util.logging.Formatter;
26 import java.util.logging.LogRecord;
27
28 import org.slf4j.MDC;
29
30 /**
31 * Implementation of {@link java.util.logging.Formatter} that generates xml in the log4j format.
32 * <p>
33 * The generated xml corresponds 100% with what is generated by
34 * log4j's <a href="http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.html">XMLLayout</a>
35 * <p>
36 * The MDC properties will only be correct when <code>format</code> is called from the same thread
37 * that generated the LogRecord.
38 * <p>
39 * The file and line attributes in the locationInfo element will always be "?"
40 * since java.util.logging.LogRecord does not provide that info.
41 * <p>
42 * The implementation is heavily based on org.apache.log4j.xml.XMLLayout
43 * </p>
44 *
45 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
46 */
47 public class Log4jXmlFormatter extends Formatter {
48
49 private static final int DEFAULT_SIZE = 256;
50
51 private static final int UPPER_LIMIT = 2048;
52
53 private StringBuilder buf = new StringBuilder(DEFAULT_SIZE);
54
55 private boolean locationInfo = false;
56
57 private boolean properties = false;
58
59 /**
60 * The <b>LocationInfo</b> option takes a boolean value. By default,
61 * it is set to false which means there will be no location
62 * information output by this layout. If the the option is set to
63 * true, then the file name and line number of the statement at the
64 * origin of the log statement will be output.
65 *
66 * @param flag whether locationInfo should be output by this layout
67 */
68 public void setLocationInfo(boolean flag) {
69 locationInfo = flag;
70 }
71
72 /**
73 * @return the current value of the <b>LocationInfo</b> option.
74 */
75 public boolean getLocationInfo() {
76 return locationInfo;
77 }
78
79 /**
80 * Sets whether MDC key-value pairs should be output, default false.
81 *
82 * @param flag new value.
83 */
84 public void setProperties(final boolean flag) {
85 properties = flag;
86 }
87
88 /**
89 * Gets whether MDC key-value pairs should be output.
90 *
91 * @return true if MDC key-value pairs are output.
92 */
93 public boolean getProperties() {
94 return properties;
95 }
96
97 @Override
98 public String format(final LogRecord record) {
99 // Reset working buffer. If the buffer is too large, then we need a new
100 // one in order to avoid the penalty of creating a large array.
101 if (buf.capacity() > UPPER_LIMIT) {
102 buf = new StringBuilder(DEFAULT_SIZE);
103 } else {
104 buf.setLength(0);
105 }
106
107 buf.append("<log4j:event logger=\"");
108 buf.append(Transform.escapeTags(record.getLoggerName()));
109 buf.append("\" timestamp=\"");
110 buf.append(record.getMillis());
111 buf.append("\" level=\"");
112
113 buf.append(Transform.escapeTags(record.getLevel().getName()));
114 buf.append("\" thread=\"");
115 buf.append(String.valueOf(record.getThreadID()));
116 buf.append("\">\r\n");
117
118 buf.append("<log4j:message><![CDATA[");
119 // Append the rendered message. Also make sure to escape any
120 // existing CDATA sections.
121 Transform.appendEscapingCDATA(buf, record.getMessage());
122 buf.append("]]></log4j:message>\r\n");
123
124 if (record.getThrown() != null) {
125 String[] s = Transform.getThrowableStrRep(record.getThrown());
126
127 if (s != null) {
128 buf.append("<log4j:throwable><![CDATA[");
129
130 for (String value : s) {
131 Transform.appendEscapingCDATA(buf, value);
132 buf.append("\r\n");
133 }
134
135 buf.append("]]></log4j:throwable>\r\n");
136 }
137 }
138
139 if (locationInfo) {
140 buf.append("<log4j:locationInfo class=\"");
141 buf.append(Transform.escapeTags(record.getSourceClassName()));
142 buf.append("\" method=\"");
143 buf.append(Transform.escapeTags(record.getSourceMethodName()));
144 buf.append("\" file=\"?\" line=\"?\"/>\r\n");
145 }
146
147 if (properties) {
148 Map<String,String> contextMap = MDC.getCopyOfContextMap();
149
150 if (contextMap != null) {
151 Set<String> keySet = contextMap.keySet();
152
153 if ((keySet != null) && !keySet.isEmpty()) {
154 buf.append("<log4j:properties>\r\n");
155 Object[] keys = keySet.toArray();
156 Arrays.sort(keys);
157
158 for (Object key1 : keys) {
159 String key = key1 == null ? "" : key1.toString();
160 Object val = contextMap.get(key);
161
162 if (val != null) {
163 buf.append("<log4j:data name=\"");
164 buf.append(Transform.escapeTags(key));
165 buf.append("\" value=\"");
166 buf.append(Transform.escapeTags(String.valueOf(val)));
167 buf.append("\"/>\r\n");
168 }
169 }
170
171 buf.append("</log4j:properties>\r\n");
172 }
173 }
174 }
175
176 buf.append("</log4j:event>\r\n\r\n");
177
178 return buf.toString();
179 }
180 }