Package 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

A handler that writes log messages to a socket connection.

This handler reads the following properties from the log manager to initialize itself:

• java.util.logging.ConsoleHandler.level specifies the logging level, defaults to Level.ALL if this property is not found or has an invalid value.
• java.util.logging.SocketHandler.filter specifies the name of the filter class to be associated with this handler, defaults to null if this property is not found or has an invalid value.
• java.util.logging.SocketHandler.formatter specifies the name of the formatter class to be associated with this handler, defaults to java.util.logging.XMLFormatter if this property is not found or has an invalid value.
• java.util.logging.SocketHandler.encoding specifies the encoding this handler will use to encode log messages, defaults to null if this property is not found or has an invalid value.
• java.util.logging.SocketHandler.host specifies the name of the host that this handler should connect to. There's no default value for this property.
• java.util.logging.SocketHandler.encoding specifies the port number that this handler should connect to. There's no default value for this property.

This handler buffers the outgoing messages, but flushes each time a log record has been published.

This class is not thread-safe.

Constructor Summary

Constructors

Constructor	Description
SocketHandler()	Constructs a SocketHandler object using the properties read by the log manager, including the host name and port number.
SocketHandler(String host, int port)	Constructs a SocketHandler object using the specified host name and port number together with other properties read by the log manager.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this handler.
void	publish(LogRecord record)	Logs a record if necessary.

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, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SocketHandler

public SocketHandler()
              throws IOException

Constructs a SocketHandler object using the properties read by the log manager, including the host name and port number. Default formatting uses the XMLFormatter class and level is set to ALL.

Throws:

IOException - if failed to connect to the specified host and port.

IllegalArgumentException - if the host name or port number is illegal.

SocketHandler

public SocketHandler(String host,
int port)
              throws IOException

Constructs a SocketHandler object using the specified host name and port number together with other properties read by the log manager. Default formatting uses the XMLFormatter class and level is set to ALL.

Parameters:

host - the host name

port - the port number

Throws:

IOException - if failed to connect to the specified host and port.

IllegalArgumentException - if the host name or port number is illegal.

Method Details

close

public void close()

Closes this handler. The network connection to the host is also closed.

Overrides:

close in class StreamHandler

publish

public void publish(LogRecord record)

Logs a record if necessary. A flush operation will be done afterwards.

Overrides:

publish in class StreamHandler

Parameters:

record - the log record to be logged.