1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
/* * @(#)XMLFormatter.java 1.26 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.util.logging; import java.io.*; import java.nio.charset.Charset; import java.util.*; /** * Format a LogRecord into a standard XML format. * <p> * The DTD specification is provided as Appendix A to the * Java Logging APIs specification. * <p> * The XMLFormatter can be used with arbitrary character encodings, * but it is recommended that it normally be used with UTF-8. The * character encoding can be set on the output Handler. * * @version 1.26, 11/17/05 * @since 1.4 */ public class XMLFormatter extends Formatter { private LogManager manager = LogManager.getLogManager(); // Append a two digit number. private void a2(StringBuffer sb, int x) { if (x < 10) { sb.append('0'); } sb.append(x); } // Append the time and date in ISO 8601 format private void appendISO8601(StringBuffer sb, long millis) { Date date = new Date(millis); sb.append(date.getYear() + 1900); sb.append('-'); a2(sb, date.getMonth() + 1); sb.append('-'); a2(sb, date.getDate()); sb.append('T'); a2(sb, date.getHours()); sb.append(':'); a2(sb, date.getMinutes()); sb.append(':'); a2(sb, date.getSeconds()); } // Append to the given StringBuffer an escaped version of the // given text string where XML special characters have been escaped. // For a null string we append "<null>" private void escape(StringBuffer sb, String text) { if (text == null) { text = "<null>"; } for (int i = 0; i < text.length(); i++) { char ch = text.charAt(i); if (ch == '<') { sb.append("<"); } else if (ch == '>') { sb.append(">"); } else if (ch == '&') { sb.append("&"); } else { sb.append(ch); } } } /** * Format the given message to XML. * @param record the log record to be formatted. * @return a formatted log record */ public String format(LogRecord record) { StringBuffer sb = new StringBuffer(500); sb.append("<record>\n"); sb.append(" <date>"); appendISO8601(sb, record.getMillis()); sb.append("</date>\n"); sb.append(" <millis>"); sb.append(record.getMillis()); sb.append("</millis>\n"); sb.append(" <sequence>"); sb.append(record.getSequenceNumber()); sb.append("</sequence>\n"); String name = record.getLoggerName(); if (name != null) { sb.append(" <logger>"); escape(sb, name); sb.append("</logger>\n"); } sb.append(" <level>"); escape(sb, record.getLevel().toString()); sb.append("</level>\n"); if (record.getSourceClassName() != null) { sb.append(" <class>"); escape(sb, record.getSourceClassName()); sb.append("</class>\n"); } if (record.getSourceMethodName() != null) { sb.append(" <method>"); escape(sb, record.getSourceMethodName()); sb.append("</method>\n"); } sb.append(" <thread>"); sb.append(record.getThreadID()); sb.append("</thread>\n"); if (record.getMessage() != null) { // Format the message string and its accompanying parameters. String message = formatMessage(record); sb.append(" <message>"); escape(sb, message); sb.append("</message>"); sb.append("\n"); } // If the message is being localized, output the key, resource // bundle name, and params. ResourceBundle bundle = record.getResourceBundle(); try { if (bundle != null && bundle.getString(record.getMessage()) != null) { sb.append(" <key>"); escape(sb, record.getMessage()); sb.append("</key>\n"); sb.append(" <catalog>"); escape(sb, record.getResourceBundleName()); sb.append("</catalog>\n"); } } catch (Exception ex) { // The message is not in the catalog. Drop through. } Object parameters[] = record.getParameters(); // Check to see if the parameter was not a messagetext format // or was not null or empty if ( parameters != null && parameters.length != 0 && record.getMessage().indexOf("{") == -1 ) { for (int i = 0; i < parameters.length; i++) { sb.append(" <param>"); try { escape(sb, parameters[i].toString()); } catch (Exception ex) { sb.append("???"); } sb.append("</param>\n"); } } if (record.getThrown() != null) { // Report on the state of the throwable. Throwable th = record.getThrown(); sb.append(" <exception>\n"); sb.append(" <message>"); escape(sb, th.toString()); sb.append("</message>\n"); StackTraceElement trace[] = th.getStackTrace(); for (int i = 0; i < trace.length; i++) { StackTraceElement frame = trace[i]; sb.append(" <frame>\n"); sb.append(" <class>"); escape(sb, frame.getClassName()); sb.append("</class>\n"); sb.append(" <method>"); escape(sb, frame.getMethodName()); sb.append("</method>\n"); // Check for a line number. if (frame.getLineNumber() >= 0) { sb.append(" <line>"); sb.append(frame.getLineNumber()); sb.append("</line>\n"); } sb.append(" </frame>\n"); } sb.append(" </exception>\n"); } sb.append("</record>\n"); return sb.toString(); } /** * Return the header string for a set of XML formatted records. * * @param h The target handler (can be null) * @return a valid XML string */ public String getHead(Handler h) { StringBuffer sb = new StringBuffer(); String encoding; sb.append("<?xml version=\"1.0\""); if (h != null) { encoding = h.getEncoding(); } else { encoding = null; } if (encoding == null) { // Figure out the default encoding. encoding = java.nio.charset.Charset.defaultCharset().name(); } // Try to map the encoding name to a canonical name. try { Charset cs = Charset.forName(encoding); encoding = cs.name(); } catch (Exception ex) { // We hit problems finding a canonical name. // Just use the raw encoding name. } sb.append(" encoding=\""); sb.append(encoding); sb.append("\""); sb.append(" standalone=\"no\"?>\n"); sb.append("<!DOCTYPE log SYSTEM \"logger.dtd\">\n"); sb.append("<log>\n"); return sb.toString(); } /** * Return the tail string for a set of XML formatted records. * * @param h The target handler (can be null) * @return a valid XML string */ public String getTail(Handler h) { return "</log>\n"; } }