public class Log
extends java.lang.Object
All log entries are preceded by the name of the currently executing thread, enclosed in {}'s, and the current time in hours, minutes, seconds, and milliseconds, enclosed in []'s. Example: {Thread-5} [20:14:03.244] Conn: Sending Request
When the class is loaded, two java system properties are read: HTTPClient.log.file and HTTPClient.log.mask. The first one, if set, causes all logging to be redirected to the file with the given name. The second one, if set, is used for setting which facilities are enabled; the value must be the bitwise OR ('|') of the values of the desired enabled facilities. E.g. a value of 3 would enable logging for the HTTPConnection and HTTPResponse, a value of 16 would enable cookie related logging, and a value of 8 would enable authorization related logging; a value of -1 would enable logging for all facilities. By default logging is disabled.
Modifier and Type | Field and Description |
---|---|
static int |
ALL
All the facilities - for use in
setLogging (-1) |
static int |
AUTH
The Authorization facility (8)
|
static int |
CONN
The HTTPConnection facility (1)
|
static int |
COOKI
The Cookies facility (16)
|
static int |
DEMUX
The StreamDemultiplexor facility (4)
|
static int |
MODS
The Modules facility (32)
|
static int |
RESP
The HTTPResponse facility (2)
|
static int |
SOCKS
The Socks facility (64)
|
static int |
URLC
The ULRConnection facility (128)
|
Modifier and Type | Method and Description |
---|---|
static boolean |
isEnabled(int facility)
Check whether logging for the given facility is enabled or not.
|
static void |
setLogging(int facilities,
boolean enable)
Enable or disable logging for the given facilities.
|
static void |
setLogWriter(java.io.Writer log,
boolean closeWhenDone)
Set the writer to which to log.
|
static void |
write(int facility,
java.lang.String msg)
Write the given message to the current log if logging for the given facility is
enabled.
|
static void |
write(int facility,
java.lang.String prefix,
java.io.ByteArrayOutputStream buf)
Write the contents of the given buffer to the current log if logging for
the given facility is enabled.
|
static void |
write(int facility,
java.lang.String prefix,
java.lang.Throwable t)
Write the stack trace of the given exception to the current log if logging for the
given facility is enabled.
|
public static final int CONN
public static final int RESP
public static final int DEMUX
public static final int AUTH
public static final int COOKI
public static final int MODS
public static final int SOCKS
public static final int URLC
public static final int ALL
setLogging
(-1)public static void write(int facility, java.lang.String msg)
facility
- the facility which is logging the messagemsg
- the message to logpublic static void write(int facility, java.lang.String prefix, java.lang.Throwable t)
facility
- the facility which is logging the messageprefix
- the string with which to prefix the stack trace; may be nullt
- the exception to logpublic static void write(int facility, java.lang.String prefix, java.io.ByteArrayOutputStream buf)
facility
- the facility which is logging the messageprefix
- the string with which to prefix the buffer contents;
may be nullbuf
- the buffer to dumppublic static boolean isEnabled(int facility)
facility
- the facility to checkpublic static void setLogging(int facilities, boolean enable)
facilities
- the facilities for which to enable or disable logging.
This is bitwise OR ('|') of all the desired
facilities; use ALL
to affect all facilitiesenable
- if true, enable logging for the chosen facilities; if
false, disable logging for them.public static void setLogWriter(java.io.Writer log, boolean closeWhenDone)
log
- the writer to log to; if null, nothing is changedcloseWhenDone
- if true, close this stream when a new stream is set
again