java.util.logging

Class SocketHandler


public class SocketHandler
extends StreamHandler

A SocketHandler publishes log records to a TCP/IP socket.

Configuration: Values of the subsequent LogManager properties are taken into consideration when a SocketHandler is initialized. If a property is not defined, or if it has an invalid value, a default is taken without an exception being thrown.

Constructor Summary

SocketHandler()
Constructs a SocketHandler that publishes log records to a TCP/IP socket.
SocketHandler(String host, int port)
Constructs a SocketHandler that publishes log records to a TCP/IP socket.

Method Summary

void
publish(LogRecord record)
Publishes a LogRecord to the network socket, provided the record passes all tests for being loggable.

Methods inherited from class java.util.logging.StreamHandler

close, flush, isLoggable, publish, setEncoding, setOutputStream

Methods inherited from class java.util.logging.Handler

close, flush, getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, publish, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SocketHandler

public SocketHandler()
            throws IOException
Constructs a SocketHandler that publishes log records to a TCP/IP socket. Tthe initial configuration is determined by the LogManager properties described above.
Throws:
IOException - if the connection to the specified network host and port cannot be established.
IllegalArgumentException - if either the java.util.logging.SocketHandler.host or java.util.logging.SocketHandler.port LogManager properties is not defined, or specifies an invalid value.

SocketHandler

public SocketHandler(String host,
                     int port)
            throws IOException
Constructs a SocketHandler that publishes log records to a TCP/IP socket. With the exception of the internet host and port, the initial configuration is determined by the LogManager properties described above.
Parameters:
host - the Internet host to which log records will be forwarded.
port - the port at the host which will accept a request for a TCP/IP connection.
Throws:
IOException - if the connection to the specified network host and port cannot be established.
IllegalArgumentException - if either host or port specify an invalid value.

Method Details

publish

public void publish(LogRecord record)
Publishes a LogRecord to the network socket, provided the record passes all tests for being loggable. In addition, all data that may have been buffered will be forced to the network stream.

Most applications do not need to call this method directly. Instead, they will use a Logger instance, which will create LogRecords and distribute them to registered handlers.

In case of an I/O failure, the ErrorManager of this SocketHandler will be informed, but the caller of this method will not receive an exception.

Overrides:
publish in interface StreamHandler
Parameters:
record - the log event to be published.

SocketHandler.java -- a class for publishing log messages to network sockets Copyright (C) 2002 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.