OpenJDK 27 · java.util.logging.SocketHandler · APIdia, the JavaDoc alternative

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 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-name>.level specifies the default level for the Handler (defaults to Level.ALL).
<handler-name>.filter specifies the name of a Filter class to use (defaults to no Filter).
<handler-name>.formatter specifies the name of a Formatter class to use (defaults to java.util.logging.XMLFormatter).
<handler-name>.encoding the name of the character set encoding to use (defaults to the default platform encoding).
<handler-name>.host specifies the target host name to connect to (no default).
<handler-name>.port specifies the target TCP port to use (no default).

For example, the properties for SocketHandler would be:

java.util.logging.SocketHandler.level=INFO
java.util.logging.SocketHandler.formatter=java.util.logging.SimpleFormatter

For a custom handler, e.g. com.foo.MyHandler, the properties would be:

com.foo.MyHandler.level=INFO
com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter

The output IO stream is buffered, but is flushed after each LogRecord is written.

Modifier and Type	Field and Description
private String	host
private int	port
private Socket	sock

Constructor Summary

Access	Constructor and Description
public	SocketHandler() Create a `SocketHandler`, using only `LogManager` properties (or their defaults).
public	SocketHandler(String target host. host, int target port. port) Construct a `SocketHandler` using a specified host and port.

Method Summary

Modifier and Type	Method and Description
public synchronized void	close() Overrides java.util.logging.StreamHandler.close. Close this output stream.
private void	connect()
public void	publish(LogRecord description of the log event. A null record is silently ignored and is not published record) Overrides java.util.logging.StreamHandler.publish. Format and publish a `LogRecord`.

Inherited from java.util.logging.StreamHandler:: flush isLoggable setEncoding setOutputStream synchronousPostWriteHook

host	back to summary
private String host

port	back to summary
private int port

sock	back to summary
private Socket sock

Constructor Detail

SocketHandler back to summary

SocketHandler	back to summary
public SocketHandler() throws IOException Create a `SocketHandler`, using only `LogManager` properties (or their defaults). Exceptions IOException: if we are unable to connect to the target host and port. IllegalArgumentException: if the host or port are invalid or are not specified as LogManager properties.

public SocketHandler() throws IOException

Create a SocketHandler, using only LogManager properties (or their defaults).

Exceptions

IOException:: if we are unable to connect to the target host and port.
IllegalArgumentException:: if the host or port are invalid or are not specified as LogManager properties.

SocketHandler back to summary

SocketHandler	back to summary
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:String target host. port:int target port. Exceptions IOException: if we are unable to connect to the target host and port. IllegalArgumentException: if the host or port are invalid.

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:String: target host.
port:int: target port.

Exceptions

IOException:: if we are unable to connect to the target host and port.
IllegalArgumentException:: if the host or port are invalid.

Method Detail

close	back to summary
public synchronized void close() Overrides java.util.logging.StreamHandler.close. Close this output stream. Annotations @Override

back to summary

public synchronized void close()

Overrides java.util.logging.StreamHandler.close.

Close this output stream.

Annotations

@Override

connect	back to summary
private void connect() throws IOException

publish back to summary

publish	back to summary
public void publish(LogRecord record) Overrides java.util.logging.StreamHandler.publish. Format and publish a `LogRecord`. Implementation Specification This method is not synchronized, and subclasses must not define overridden `publish()` methods to be `synchronized` if they call `super.publish()` or format user arguments. See the discussion in java.util.logging.Handler for more information. Parameters record:LogRecord description of the log event. A null record is silently ignored and is not published Annotations @Override

public void publish(LogRecord record)

Overrides java.util.logging.StreamHandler.publish.

Format and publish a LogRecord.

Implementation Specification

This method is not synchronized, and subclasses must not define overridden publish() methods to be synchronized if they call super.publish() or format user arguments. See the discussion in java.util.logging.Handler for more information.

Parameters

record:LogRecord: description of the log event. A null record is silently ignored and is not published

Annotations

@Override

public Class SocketHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail