java.util.logging: public class: SocketHandler

java.util.logging
public class: SocketHandler [javadoc | source]

java.lang.Object
   java.util.logging.Handler
      java.util.logging.StreamHandler
         java.util.logging.SocketHandler

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. 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 each LogRecord is written.

since: 1.4 -

Fields inherited from java.util.logging.Handler:
sealed

Constructor:

Constructor:
public SocketHandler() throws IOException { // We are going to use the logging defaults. sealed = false; configure(); try { connect(); } catch (IOException ix) { System.err.println("SocketHandler: connect failed to " + host + ":" + port); throw ix; } sealed = true; } Create a `SocketHandler`, using only `LogManager` properties (or their defaults). Throws: `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 { sealed = false; configure(); sealed = true; this.port = port; this.host = host; connect(); } 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` - if the host or port are invalid. `IOException` - if we are unable to connect to the target host and port.

 public SocketHandler() throws IOException {
        // We are going to use the logging defaults.
        sealed = false;
        configure();
        try {
            connect();
        } catch (IOException ix) {
            System.err.println("SocketHandler: connect failed to " + host + ":" + port);
            throw ix;
        }
        sealed = true;
}

SocketHandler

LogManager

Throws:

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 {
        sealed = false;
        configure();
        sealed = true;
        this.port = port;
        this.host = host;
        connect();
}

SocketHandler

LogManager

Parameters:

host - target host.

port - target port.

Throws:

IllegalArgumentException - if the host or port are invalid.

IOException - if we are unable to connect to the target host and port.

Method from java.util.logging.SocketHandler Summary:
close, publish

Methods from java.util.logging.StreamHandler:
close, flush, isLoggable, publish, setEncoding, setOutputStream

Methods from java.util.logging.Handler:
checkAccess, close, flush, getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, publish, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.util.logging.SocketHandler Detail:
public synchronized void close() throws SecurityException { super.close(); if (sock != null) { try { sock.close(); } catch (IOException ix) { // drop through. } } sock = null; } Close this output stream.
public synchronized void publish(LogRecord record) { if (!isLoggable(record)) { return; } super.publish(record); flush(); } Format and publish a `LogRecord`.

Method from java.util.logging.SocketHandler Detail:

 public synchronized  void close() throws SecurityException {
        super.close();
        if (sock != null) {
            try {
                sock.close();
            } catch (IOException ix) {
                // drop through.
            }
        }
        sock = null;
}

Close this output stream.

 public synchronized  void publish(LogRecord record) {
        if (!isLoggable(record)) {
            return;
        }
        super.publish(record);
        flush();
}

LogRecord