151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 24ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.util.logging; 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This <tt>Handler</tt> publishes log records to <tt>System.err</tt>. 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * By default the <tt>SimpleFormatter</tt> is used to generate brief summaries. 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <b>Configuration:</b> 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * By default each <tt>ConsoleHandler</tt> is initialized using the following 354ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <tt>LogManager</tt> configuration properties where {@code <handler-name>} 364ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * refers to the fully-qualified class name of the handler. 374ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * If properties are not defined 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (or have invalid values) then the specified default values are used. 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 404ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <li> <handler-name>.level 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specifies the default level for the <tt>Handler</tt> 424ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * (defaults to <tt>Level.INFO</tt>). </li> 434ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <li> <handler-name>.filter 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specifies the name of a <tt>Filter</tt> class to use 454ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * (defaults to no <tt>Filter</tt>). </li> 464ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <li> <handler-name>.formatter 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specifies the name of a <tt>Formatter</tt> class to use 484ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * (defaults to <tt>java.util.logging.SimpleFormatter</tt>). </li> 494ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <li> <handler-name>.encoding 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the name of the character set encoding to use (defaults to 514ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * the default platform encoding). </li> 524ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * </ul> 534ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <p> 544ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * For example, the properties for {@code ConsoleHandler} would be: 554ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <ul> 564ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <li> java.util.logging.ConsoleHandler.level=INFO </li> 574ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <li> java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter </li> 584ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * </ul> 594ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <p> 604ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * For a custom handler, e.g. com.foo.MyHandler, the properties would be: 614ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <ul> 624ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <li> com.foo.MyHandler.level=INFO </li> 634ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak * <li> com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter </li> 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic class ConsoleHandler extends StreamHandler { 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Private method to configure a ConsoleHandler from LogManager 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // properties and/or default values as specified in the class 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // javadoc. 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void configure() { 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski LogManager manager = LogManager.getLogManager(); 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String cname = getClass().getName(); 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setLevel(manager.getLevelProperty(cname +".level", Level.INFO)); 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setFilter(manager.getFilterProperty(cname +".filter", null)); 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setFormatter(manager.getFormatterProperty(cname +".formatter", new SimpleFormatter())); 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setEncoding(manager.getStringProperty(cname +".encoding", null)); 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (Exception ex) { 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setEncoding(null); 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (Exception ex2) { 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // doing a setEncoding with null should always work. 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // assert false; 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Create a <tt>ConsoleHandler</tt> for <tt>System.err</tt>. 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The <tt>ConsoleHandler</tt> is configured based on 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>LogManager</tt> properties (or their default values). 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public ConsoleHandler() { 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sealed = false; 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski configure(); 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setOutputStream(System.err); 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sealed = true; 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Publish a <tt>LogRecord</tt>. 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The logging request was made initially to a <tt>Logger</tt> object, 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * which initialized the <tt>LogRecord</tt> and forwarded it here. 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param record description of the log event. A null record is 11251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * silently ignored and is not published 11351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 1144ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak @Override 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void publish(LogRecord record) { 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super.publish(record); 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski flush(); 11851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 11951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 12051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Override <tt>StreamHandler.close</tt> to do a flush but not 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to close the output stream. That is, we do <b>not</b> 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * close <tt>System.err</tt>. 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 1254ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cfPrzemyslaw Szczepaniak @Override 12651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void close() { 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski flush(); 12851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 12951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 130