Class SocketHandler
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 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 toLevel.ALL
). - <handler-name>.filter
specifies the name of a
Filter
class to use (defaults to noFilter
). - <handler-name>.formatter
specifies the name of a
Formatter
class to use (defaults tojava.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.
- Since:
- 1.4
-
Constructor Summary
ConstructorDescriptionCreate aSocketHandler
, using onlyLogManager
properties (or their defaults).SocketHandler
(String host, int port) Construct aSocketHandler
using a specified host and port. -
Method Summary
Methods declared in class java.util.logging.StreamHandler
flush, isLoggable, setEncoding, setOutputStream
Methods declared in class java.util.logging.Handler
getEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setErrorManager, setFilter, setFormatter, setLevel
-
Constructor Details
-
SocketHandler
Create aSocketHandler
, using onlyLogManager
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
Construct aSocketHandler
using a specified host and port. TheSocketHandler
is configured based onLogManager
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 Details
-
close
Close this output stream.- Overrides:
close
in classStreamHandler
- Throws:
SecurityException
- if a security manager exists and if the caller does not haveLoggingPermission("control")
.
-
publish
Format and publish aLogRecord
.- Overrides:
publish
in classStreamHandler
- Parameters:
record
- description of the log event. A null record is silently ignored and is not published
-