public class SocketHandler extends StreamHandler
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 following LogManager
configuration properties where <handler-name>
refers to the fully-qualified class name of the handler. If properties are not defined (or have invalid values) then the specified default values are used.
Handler
(defaults to Level.ALL
). Filter
class to use (defaults to no Filter
). Formatter
class to use (defaults to java.util.logging.XMLFormatter
). For example, the properties for SocketHandler
would be:
For a custom handler, e.g. com.foo.MyHandler, the properties would be:
The output IO stream is buffered, but is flushed after each LogRecord
is written.
Constructor | Description |
---|---|
SocketHandler() |
Create a SocketHandler , using only LogManager properties (or their defaults). |
SocketHandler |
Construct a SocketHandler using a specified host and port. |
flush, isLoggable, setEncoding, setOutputStream
getEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setErrorManager, setFilter, setFormatter, setLevel
public SocketHandler() throws IOException
SocketHandler
, using only LogManager
properties (or their defaults).IllegalArgumentException
- if the host or port are invalid or are not specified as LogManager properties.IOException
- if we are unable to connect to the target host and port.public SocketHandler(String host, int port) throws IOException
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.host
- target host.port
- target port.IllegalArgumentException
- if the host or port are invalid.IOException
- if we are unable to connect to the target host and port.public void close() throws SecurityException
close
in class StreamHandler
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control")
.public void publish(LogRecord record)
LogRecord
.publish
in class StreamHandler
record
- description of the log event. A null record is silently ignored and is not published
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.logging/java/util/logging/SocketHandler.html