XMLFormatter.java revision b4acb463582a510894aeb85f4fa8f35b339449c8
1f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes/* 2adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 3adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 4adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this work for additional information regarding copyright ownership. 5adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 6adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (the "License"); you may not use this file except in compliance with 7adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the License. You may obtain a copy of the License at 8f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 9adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 11adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 12adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 13adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * See the License for the specific language governing permissions and 15adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * limitations under the License. 16adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 17adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 18adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpackage java.util.logging; 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.text.MessageFormat; 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.util.Date; 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.util.ResourceBundle; 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Formatter to convert a {@link LogRecord} into an XML string. The DTD 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specified in Appendix A to the Java Logging APIs specification is used. 27adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code XMLFormatter} uses the output handler's encoding if it is specified, 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * otherwise the default platform encoding is used instead. UTF-8 is the 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * recommended encoding. 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic class XMLFormatter extends Formatter { 32adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 33f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes private static final String indent = " "; 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 35adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new {@code XMLFormatter}. 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public XMLFormatter() { 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project super(); 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 42adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Converts a {@code LogRecord} into an XML string. 449a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson * 45adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param r 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the log record to be formatted. 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the log record formatted as an XML string. 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 50adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String format(LogRecord r) { 519a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson // call a method of LogRecord to ensure not null 52adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project long time = r.getMillis(); 539a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson // format to date 54b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes String date = MessageFormat.format("{0, date} {0, time}", new Object[] { new Date(time) }); 55b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes String nl = System.lineSeparator(); 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project StringBuilder sb = new StringBuilder(); 58b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append("<record>").append(nl); 59b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "date", date); 60b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "millis", time); 61b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "sequence", r.getSequenceNumber()); 62b46dab348e2007bc08abaf7ecae34d89a2474e50Elliott Hughes if (r.getLoggerName() != null) { 63b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "logger", r.getLoggerName()); 64adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 65b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "level", r.getLevel().getName()); 66b46dab348e2007bc08abaf7ecae34d89a2474e50Elliott Hughes if (r.getSourceClassName() != null) { 67b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "class", r.getSourceClassName()); 68adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 69b46dab348e2007bc08abaf7ecae34d89a2474e50Elliott Hughes if (r.getSourceMethodName() != null) { 70b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "method", r.getSourceMethodName()); 71adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 72b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "thread", r.getThreadID()); 73adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project formatMessages(r, sb); 74b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes Object[] params = r.getParameters(); 75b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes if (params != null) { 76adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project for (Object element : params) { 77b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "param", element); 78adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 79adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 80adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project formatThrowable(r, sb); 81b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append("</record>").append(nl); 82adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return sb.toString(); 83adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 84adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 85adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private void formatMessages(LogRecord r, StringBuilder sb) { 869a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson // get localized message if has, but don't call Formatter.formatMessage 879a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson // to parse pattern string 88adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project ResourceBundle rb = r.getResourceBundle(); 89adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project String pattern = r.getMessage(); 90b46dab348e2007bc08abaf7ecae34d89a2474e50Elliott Hughes if (rb != null && pattern != null) { 91adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project String message; 92adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project try { 93adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project message = rb.getString(pattern); 94adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } catch (Exception e) { 95adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project message = null; 96adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 97adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 98adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (message == null) { 99adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project message = pattern; 100b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "message", message); 101adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } else { 102b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "message", message); 103b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "key", pattern); 104b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "catalog", r.getResourceBundleName()); 105adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 106b46dab348e2007bc08abaf7ecae34d89a2474e50Elliott Hughes } else if (pattern != null) { 107b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 1, "message", pattern); 1089a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson } else { 109b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(indent).append("<message/>"); 110adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 111adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 112adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 113adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private void formatThrowable(LogRecord r, StringBuilder sb) { 114adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Throwable t; 115adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if ((t = r.getThrown()) != null) { 116b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes String nl = System.lineSeparator(); 117b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(indent).append("<exception>").append(nl); 118b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 2, "message", t.toString()); 1199a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson // format throwable's stack trace 120adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project StackTraceElement[] elements = t.getStackTrace(); 121adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project for (StackTraceElement e : elements) { 122b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(indent).append(indent).append("<frame>").append(nl); 123b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 3, "class", e.getClassName()); 124b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 3, "method", e.getMethodName()); 125b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes append(sb, 3, "line", e.getLineNumber()); 126b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(indent).append(indent).append("</frame>").append(nl); 127adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 128b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(indent).append("</exception>").append(nl); 129b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes } 130b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes } 131b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes 132b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes private static void append(StringBuilder sb, int indentCount, String tag, Object value) { 133b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes for (int i = 0; i < indentCount; ++i) { 134b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(indent); 135adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 136b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append("<").append(tag).append(">"); 137b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(value); 138b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append("</").append(tag).append(">"); 139b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(System.lineSeparator()); 140adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 141adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 142adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 143adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the header string for a set of log records formatted as XML 144adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * strings, using the output handler's encoding if it is defined, otherwise 145adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * using the default platform encoding. 1469a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson * 147adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param h 148adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the output handler, may be {@code null}. 149adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the header string for log records formatted as XML strings. 150adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 151adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 152adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String getHead(Handler h) { 153adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project String encoding = null; 154b46dab348e2007bc08abaf7ecae34d89a2474e50Elliott Hughes if (h != null) { 155adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project encoding = h.getEncoding(); 156adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 157b46dab348e2007bc08abaf7ecae34d89a2474e50Elliott Hughes if (encoding == null) { 158ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes encoding = System.getProperty("file.encoding"); 159adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 160adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project StringBuilder sb = new StringBuilder(); 161b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append("<?xml version=\"1.0\" encoding=\"").append(encoding).append("\" standalone=\"no\"?>"); 162b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(System.lineSeparator()); 163b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append("<!DOCTYPE log SYSTEM \"logger.dtd\">"); 164b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append(System.lineSeparator()); 165b4acb463582a510894aeb85f4fa8f35b339449c8Elliott Hughes sb.append("<log>"); 166adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return sb.toString(); 167adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 168adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 169adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 170adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the tail string for a set of log records formatted as XML 171adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * strings. 1729a0fbe99031759393563ee69ac4640f66f182686Jesse Wilson * 173adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param h 174adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the output handler, may be {@code null}. 175adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the tail string for log records formatted as XML strings. 176adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 177adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project @Override 178adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String getTail(Handler h) { 179f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes return "</log>"; 180adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 181adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project} 182