Class Overview
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.
Summary
Public Constructors |
|
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.
|
Public Methods |
synchronized
void
|
close()
Close this output stream.
|
synchronized
void
|
publish(LogRecord record)
Format and publish a LogRecord.
|
[Expand]
Inherited Methods |
From class
java.util.logging.StreamHandler
synchronized
void
|
close()
Close the current output stream.
|
synchronized
void
|
flush()
Flush any buffered messages.
|
boolean
|
isLoggable(LogRecord record)
Check if this Handler would actually log a given LogRecord.
|
synchronized
void
|
publish(LogRecord record)
Format and publish a LogRecord.
|
void
|
setEncoding(String encoding)
Set (or change) the character encoding used by this Handler.
|
synchronized
void
|
setOutputStream(OutputStream out)
Change the output stream.
|
|
From class
java.util.logging.Handler
|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object.
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed.
|
|
Public Constructors
public
SocketHandler
()
Create a SocketHandler, using only LogManager properties
(or their defaults).
public
SocketHandler
(String host, int port)
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. |
Public Methods
public
synchronized
void
close
()
Close this output stream.
Throws
SecurityException
| if a security manager exists and if
the caller does not have LoggingPermission("control").
|
public
synchronized
void
publish
(LogRecord record)
Format and publish a LogRecord.
Parameters
record
| description of the log event. A null record is
silently ignored and is not published
|