- java.lang.Object
-
- java.util.logging.Handler
-
- java.util.logging.StreamHandler
-
- java.util.logging.SocketHandler
-
public class SocketHandler extends StreamHandler
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
-
-
Constructor Summary
Constructors Constructor and Description SocketHandler()
Create a SocketHandler, using only LogManager properties (or their defaults).SocketHandler(String host, int port)
Construct a SocketHandler using a specified host and port.
-
Method Summary
Methods Modifier and Type Method and Description void
close()
Close this output stream.void
publish(LogRecord record)
Format and publish a LogRecord.-
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
-
-
-
-
Constructor Detail
-
SocketHandler
public SocketHandler() throws IOException
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.
-
SocketHandler
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
- 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 Detail
-
close
public void close() throws SecurityException
Close this output stream.- Overrides:
close
in classStreamHandler
- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control").
-
publish
public void publish(LogRecord record)
Format and publish a LogRecord.- Overrides:
publish
in classStreamHandler
- Parameters:
record
- description of the log event. A null record is silently ignored and is not published
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/util/logging/SocketHandler.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.