| |
|
| java.lang.Object
 java.util.logging.Handler
All known Subclasses: java.util.logging.StreamHandler, java.util.logging.MemoryHandler,
| Handler | | abstract public class Handler (Code) | | A Handler object takes log messages from a Logger and
exports them. It might for example, write them to a console
or write them to a file, or send them to a network logging service,
or forward them to an OS log, or whatever.
A Handler can be disabled by doing a setLevel(Level.OFF)
and can be re-enabled by doing a setLevel with an appropriate level.
Handler classes typically use LogManager properties to set
default values for the Handler's Filter, Formatter,
and Level. See the specific documentation for each concrete
Handler class.
version:
1.27, 05/05/07
since:
1.4 |
| Constructor Summary | |
| protected | Handler()
Default constructor. |
| Method Summary | |
| void | checkAccess()
| | abstract public void | close()
Close the Handler and free all associated resources.
The close method will perform a flush and then close the
Handler. | | abstract public void | flush()
Flush any buffered output. | | public String | getEncoding()
Return the character encoding for this Handler.
The encoding name. | | public ErrorManager | getErrorManager()
Retrieves the ErrorManager for this Handler. | | public Filter | getFilter()
Get the current Filter for this Handler. | | public Formatter | getFormatter()
Return the Formatter for this Handler. | | public synchronized Level | getLevel()
Get the log level specifying which messages will be
logged by this Handler. | | public boolean | isLoggable(LogRecord record)
Check if this Handler would actually log a given LogRecord.
This method checks if the LogRecord has an appropriate
Level and whether it satisfies any Filter. | | abstract public void | publish(LogRecord record)
Publish a LogRecord.
The logging request was made initially to a Logger object,
which initialized the LogRecord and forwarded it here.
The Handler is responsible for formatting the message, when and
if necessary. | | protected void | reportError(String msg, Exception ex, int code)
Protected convenience method to report an error to this Handler's
ErrorManager. | | public void | setEncoding(String encoding)
Set the character encoding used by this Handler. | | public void | setErrorManager(ErrorManager em)
Define an ErrorManager for this Handler. | | public void | setFilter(Filter newFilter)
Set a Filter to control output on this Handler. | | public void | setFormatter(Formatter newFormatter)
Set a Formatter. | | public synchronized void | setLevel(Level newLevel)
Set the log level specifying which message levels will be
logged by this Handler. |
| Handler | | protected Handler()(Code) | | Default constructor. The resulting Handler has a log
level of Level.ALL, no Formatter, and no
Filter. A default ErrorManager instance is installed
as the ErrorManager.
|
| close | | abstract public void close() throws SecurityException(Code) | | Close the Handler and free all associated resources.
The close method will perform a flush and then close the
Handler. After close has been called this Handler
should no longer be used. Method calls may either be silently
ignored or may throw runtime exceptions.
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control"). |
| flush | | abstract public void flush()(Code) | | Flush any buffered output.
|
| getEncoding | | public String getEncoding()(Code) | | Return the character encoding for this Handler.
The encoding name. May be null, which indicates thedefault encoding should be used. |
| getErrorManager | | public ErrorManager getErrorManager()(Code) | | Retrieves the ErrorManager for this Handler.
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control"). |
| getFilter | | public Filter getFilter()(Code) | | Get the current Filter for this Handler.
a Filter object (may be null) |
| getFormatter | | public Formatter getFormatter()(Code) | | Return the Formatter for this Handler.
the Formatter (may be null). |
| getLevel | | public synchronized Level getLevel()(Code) | | Get the log level specifying which messages will be
logged by this Handler. Message levels lower
than this level will be discarded.
the level of messages being logged. |
| isLoggable | | public boolean isLoggable(LogRecord record)(Code) | | Check if this Handler would actually log a given LogRecord.
This method checks if the LogRecord has an appropriate
Level and whether it satisfies any Filter. It also
may make other Handler specific checks that might prevent a
handler from logging the LogRecord. It will return false if
the LogRecord is Null.
Parameters:
record - a LogRecord true if the LogRecord would be logged. |
| publish | | abstract public void publish(LogRecord record)(Code) | | Publish a LogRecord.
The logging request was made initially to a Logger object,
which initialized the LogRecord and forwarded it here.
The Handler is responsible for formatting the message, when and
if necessary. The formatting should include localization.
Parameters:
record - description of the log event. A null record issilently ignored and is not published |
| reportError | | protected void reportError(String msg, Exception ex, int code)(Code) | | Protected convenience method to report an error to this Handler's
ErrorManager. Note that this method retrieves and uses the ErrorManager
without doing a security check. It can therefore be used in
environments where the caller may be non-privileged.
Parameters:
msg - a descriptive string (may be null)
Parameters:
ex - an exception (may be null)
Parameters:
code - an error code defined in ErrorManager |
| setEncoding | | public void setEncoding(String encoding) throws SecurityException, java.io.UnsupportedEncodingException(Code) | | Set the character encoding used by this Handler.
The encoding should be set before any LogRecords are written
to the Handler.
Parameters:
encoding - The name of a supported character encoding.May be null, to indicate the default platform encoding.
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control").
exception:
UnsupportedEncodingException - if the named encoding isnot supported. |
| setErrorManager | | public void setErrorManager(ErrorManager em)(Code) | | Define an ErrorManager for this Handler.
The ErrorManager's "error" method will be invoked if any
errors occur while using this Handler.
Parameters:
em - the new ErrorManager
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control"). |
| setFilter | | public void setFilter(Filter newFilter) throws SecurityException(Code) | | Set a Filter to control output on this Handler.
For each call of publish the Handler will call
this Filter (if it is non-null) to check if the
LogRecord should be published or discarded.
Parameters:
newFilter - a Filter object (may be null)
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control"). |
| setFormatter | | public void setFormatter(Formatter newFormatter) throws SecurityException(Code) | | Set a Formatter. This Formatter will be used
to format LogRecords for this Handler.
Some Handlers may not use Formatters, in
which case the Formatter will be remembered, but not used.
Parameters:
newFormatter - the Formatter to use (may not be null)
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control"). |
| setLevel | | public synchronized void setLevel(Level newLevel) throws SecurityException(Code) | | Set the log level specifying which message levels will be
logged by this Handler. Message levels lower than this
value will be discarded.
The intention is to allow developers to turn on voluminous
logging, but to limit the messages that are sent to certain
Handlers.
Parameters:
newLevel - the new value for the log level
exception:
SecurityException - if a security manager exists and ifthe caller does not have LoggingPermission("control"). |
|
|
|