author | alanb |
Mon, 10 Jun 2013 12:58:32 +0100 | |
changeset 18156 | edb590d448c5 |
parent 14321 | 7f9f265ac11e |
child 19808 | 39cb79123ab2 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
14321
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
2 |
* Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
25 |
||
26 |
||
27 |
package java.util.logging; |
|
28 |
||
29 |
import java.io.*; |
|
30 |
import java.net.*; |
|
31 |
||
32 |
/** |
|
33 |
* This <tt>Handler</tt> publishes log records to <tt>System.err</tt>. |
|
34 |
* By default the <tt>SimpleFormatter</tt> is used to generate brief summaries. |
|
35 |
* <p> |
|
36 |
* <b>Configuration:</b> |
|
37 |
* By default each <tt>ConsoleHandler</tt> is initialized using the following |
|
18156 | 38 |
* <tt>LogManager</tt> configuration properties where {@code <handler-name>} |
14321
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
39 |
* refers to the fully-qualified class name of the handler. |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
40 |
* If properties are not defined |
2 | 41 |
* (or have invalid values) then the specified default values are used. |
42 |
* <ul> |
|
14321
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
43 |
* <li> <handler-name>.level |
2 | 44 |
* specifies the default level for the <tt>Handler</tt> |
14321
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
45 |
* (defaults to <tt>Level.INFO</tt>). </li> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
46 |
* <li> <handler-name>.filter |
2 | 47 |
* specifies the name of a <tt>Filter</tt> class to use |
14321
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
48 |
* (defaults to no <tt>Filter</tt>). </li> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
49 |
* <li> <handler-name>.formatter |
2 | 50 |
* specifies the name of a <tt>Formatter</tt> class to use |
14321
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
51 |
* (defaults to <tt>java.util.logging.SimpleFormatter</tt>). </li> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
52 |
* <li> <handler-name>.encoding |
2 | 53 |
* the name of the character set encoding to use (defaults to |
14321
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
54 |
* the default platform encoding). </li> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
55 |
* </ul> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
56 |
* <p> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
57 |
* For example, the properties for {@code ConsoleHandler} would be: |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
58 |
* <ul> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
59 |
* <li> java.util.logging.ConsoleHandler.level=INFO </li> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
60 |
* <li> java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter </li> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
61 |
* </ul> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
62 |
* <p> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
63 |
* For a custom handler, e.g. com.foo.MyHandler, the properties would be: |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
64 |
* <ul> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
65 |
* <li> com.foo.MyHandler.level=INFO </li> |
7f9f265ac11e
7159567: inconsistent configuration of MemoryHandler
jgish
parents:
5506
diff
changeset
|
66 |
* <li> com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter </li> |
2 | 67 |
* </ul> |
68 |
* <p> |
|
69 |
* @since 1.4 |
|
70 |
*/ |
|
71 |
public class ConsoleHandler extends StreamHandler { |
|
72 |
// Private method to configure a ConsoleHandler from LogManager |
|
73 |
// properties and/or default values as specified in the class |
|
74 |
// javadoc. |
|
75 |
private void configure() { |
|
76 |
LogManager manager = LogManager.getLogManager(); |
|
77 |
String cname = getClass().getName(); |
|
78 |
||
79 |
setLevel(manager.getLevelProperty(cname +".level", Level.INFO)); |
|
80 |
setFilter(manager.getFilterProperty(cname +".filter", null)); |
|
81 |
setFormatter(manager.getFormatterProperty(cname +".formatter", new SimpleFormatter())); |
|
82 |
try { |
|
83 |
setEncoding(manager.getStringProperty(cname +".encoding", null)); |
|
84 |
} catch (Exception ex) { |
|
85 |
try { |
|
86 |
setEncoding(null); |
|
87 |
} catch (Exception ex2) { |
|
88 |
// doing a setEncoding with null should always work. |
|
89 |
// assert false; |
|
90 |
} |
|
91 |
} |
|
92 |
} |
|
93 |
||
94 |
/** |
|
95 |
* Create a <tt>ConsoleHandler</tt> for <tt>System.err</tt>. |
|
96 |
* <p> |
|
97 |
* The <tt>ConsoleHandler</tt> is configured based on |
|
98 |
* <tt>LogManager</tt> properties (or their default values). |
|
99 |
* |
|
100 |
*/ |
|
101 |
public ConsoleHandler() { |
|
102 |
sealed = false; |
|
103 |
configure(); |
|
104 |
setOutputStream(System.err); |
|
105 |
sealed = true; |
|
106 |
} |
|
107 |
||
108 |
/** |
|
109 |
* Publish a <tt>LogRecord</tt>. |
|
110 |
* <p> |
|
111 |
* The logging request was made initially to a <tt>Logger</tt> object, |
|
112 |
* which initialized the <tt>LogRecord</tt> and forwarded it here. |
|
113 |
* <p> |
|
114 |
* @param record description of the log event. A null record is |
|
115 |
* silently ignored and is not published |
|
116 |
*/ |
|
117 |
public void publish(LogRecord record) { |
|
118 |
super.publish(record); |
|
119 |
flush(); |
|
120 |
} |
|
121 |
||
122 |
/** |
|
123 |
* Override <tt>StreamHandler.close</tt> to do a flush but not |
|
124 |
* to close the output stream. That is, we do <b>not</b> |
|
125 |
* close <tt>System.err</tt>. |
|
126 |
*/ |
|
127 |
public void close() { |
|
128 |
flush(); |
|
129 |
} |
|
130 |
} |