SocketHandler (Java Platform SE 6) (original) (raw)
java.util.logging
Class SocketHandler
java.lang.Object
java.util.logging.Handler
java.util.logging.StreamHandler
java.util.logging.SocketHandler
public class SocketHandler
extends StreamHandler
Simple network logging Handler.
LogRecords are published to a network stream connection. By default the XMLFormatter class is used for formatting.
Configuration: By default each SocketHandler is initialized using the followingLogManager configuration properties. If properties are not defined (or have invalid values) then the specified default values are used.
- java.util.logging.SocketHandler.level specifies the default level for the Handler (defaults to Level.ALL).
- java.util.logging.SocketHandler.filter specifies the name of a Filter class to use (defaults to no Filter).
- java.util.logging.SocketHandler.formatter specifies the name of a Formatter class to use (defaults to java.util.logging.XMLFormatter).
- java.util.logging.SocketHandler.encoding the name of the character set encoding to use (defaults to the default platform encoding).
- java.util.logging.SocketHandler.host specifies the target host name to connect to (no default).
- java.util.logging.SocketHandler.port specifies the target TCP port to use (no default).
The output IO stream is buffered, but is flushed after eachLogRecord is written.
Since:
1.4
| Constructor Summary |
|---|
| SocketHandler() Create a SocketHandler, using only LogManager properties (or their defaults). |
| [SocketHandler](../../../java/util/logging/SocketHandler.html#SocketHandler%28java.lang.String, int%29)(String host, int port) Construct a SocketHandler using a specified host and port. |
| Method Summary | |
|---|---|
| void | close() Close this output stream. |
| void | publish(LogRecord record) Format and publish a LogRecord. |
| Methods inherited from class java.util.logging.StreamHandler |
|---|
| flush, isLoggable, setEncoding, setOutputStream |
| Methods inherited from class java.util.logging.Handler |
|---|
| getEncoding, getErrorManager, getFilter, getFormatter, getLevel, [reportError](../../../java/util/logging/Handler.html#reportError%28java.lang.String, java.lang.Exception, int%29), setErrorManager, setFilter, setFormatter, setLevel |
| Methods inherited from class java.lang.Object |
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29) |
| Constructor Detail |
|---|
SocketHandler
public SocketHandler() throws IOException
Create a SocketHandler, using only LogManager properties (or their defaults).
Throws:
[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if the host or port are invalid or are not specified as LogManager properties.
[IOException](../../../java/io/IOException.html "class in java.io") - if we are unable to connect to the target host and port.
SocketHandler
public SocketHandler(String host, int port) throws IOException
Construct a SocketHandler using a specified host and port. The SocketHandler is configured based on LogManager properties (or their default values) except that the given target host and port arguments are used. If the host argument is empty, but not null String then the localhost is used.
Parameters:
host - target host.
port - target port.
Throws:
[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if the host or port are invalid.
[IOException](../../../java/io/IOException.html "class in java.io") - if we are unable to connect to the target host and port.
| Method Detail |
|---|
close
public void close() throws SecurityException
Close this output stream.
Overrides:
[close](../../../java/util/logging/StreamHandler.html#close%28%29) in class [StreamHandler](../../../java/util/logging/StreamHandler.html "class in java.util.logging")
Throws:
[SecurityException](../../../java/lang/SecurityException.html "class in java.lang") - if a security manager exists and if the caller does not have LoggingPermission("control").
publish
public void publish(LogRecord record)
Format and publish a LogRecord.
Overrides:
[publish](../../../java/util/logging/StreamHandler.html#publish%28java.util.logging.LogRecord%29) in class [StreamHandler](../../../java/util/logging/StreamHandler.html "class in java.util.logging")
Parameters:
record - description of the log event. A null record is silently ignored and is not published
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.