java.util.logging
Class Handler

java.lang.Object
  java.util.logging.Handler

Direct Known Subclasses:

MemoryHandler, StreamHandler

public abstract class Handler
extends Object

A Handler object accepts a logging request and exports the desired messages to a target, for example, a file, the console, etc. It can be disabled by setting its logging level to Level.OFF.

Constructor Summary

protected

Handler() Constructs a Handler object with a default error manager, the default encoding, and the default logging level Level.ALL.

Method Summary

abstract void	close() Closes this handler.
abstract void	flush() Flushes any buffered output.
String	getEncoding() Gets the character encoding used by this handler.
ErrorManager	getErrorManager() Gets the error manager used by this handler to report errors during logging.
Filter	getFilter() Gets the filter used by this handler.
Formatter	getFormatter() Gets the formatter used by this handler to format the logging messages.
Level	getLevel() Gets the logging level of this handler.
(package private) void	initProperties(String defaultLevel, String defaultFilter, String defaultFormatter, String defaultEncoding)
(package private) void	internalSetEncoding(String newEncoding) Sets the character encoding used by this handler.
(package private) void	internalSetFormatter(Formatter newFormatter) Sets the formatter to be used by this handler.
boolean	isLoggable(LogRecord record) Determines whether the supplied log record need to be logged.
(package private) void	printInvalidPropMessage(String key, String value, Exception e)
abstract void	publish(LogRecord record) Accepts an actual logging request.
protected void	reportError(String msg, Exception ex, int code) Report an error to the error manager associated with this handler.
void	setEncoding(String encoding) Sets the character encoding used by this handler.
void	setErrorManager(ErrorManager em) Sets the error manager for this handler.
void	setFilter(Filter newFilter) Sets the filter to be used by this handler.
void	setFormatter(Formatter newFormatter) Sets the formatter to be used by this handler.
void	setLevel(Level newLevel) Sets the logging level of this handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Handler

protected Handler()

Constructs a Handler object with a default error manager, the default encoding, and the default logging level Level.ALL. It has no filter and no formatter.

Method Detail

printInvalidPropMessage

void printInvalidPropMessage(String key,
                             String value,
                             Exception e)

initProperties

void initProperties(String defaultLevel,
                    String defaultFilter,
                    String defaultFormatter,
                    String defaultEncoding)

close

public abstract void close()

Closes this handler. A flush operation will usually be performed and all the associated resources will be freed. Client applications should not use a handler after closing it.

Throws:

SecurityException - If a security manager determines that the caller does not have the required permission.

flush

public abstract void flush()

Flushes any buffered output.

publish

public abstract void publish(LogRecord record)

Accepts an actual logging request.

Parameters:

record - the log record to be logged

getEncoding

public String getEncoding()

Gets the character encoding used by this handler.

Returns:

the character encoding used by this handler

getErrorManager

public ErrorManager getErrorManager()

Gets the error manager used by this handler to report errors during logging.

Returns:

the error manager used by this handler

Throws:

SecurityException - If a security manager determines that the caller does not have the required permission.

getFilter

public Filter getFilter()

Gets the filter used by this handler.

Returns:

the filter used by this handler

getFormatter

public Formatter getFormatter()

Gets the formatter used by this handler to format the logging messages.

Returns:

the formatter used by this handler

getLevel

public Level getLevel()

Gets the logging level of this handler.

Returns:

the logging level of this handler

isLoggable

public boolean isLoggable(LogRecord record)

Determines whether the supplied log record need to be logged. The logging levels will be checked as well as the filter.

Parameters:

record - the log record to be checked

Returns:

true if the supplied log record need to be logged, otherwise false

reportError

protected void reportError(String msg,
                           Exception ex,
                           int code)

Report an error to the error manager associated with this handler.

Parameters:

msg - the error message

ex - the associated exception

code - the error code

internalSetEncoding

void internalSetEncoding(String newEncoding)
                   throws UnsupportedEncodingException

Sets the character encoding used by this handler. A null value indicates the using of the default encoding. This internal method does not check security.

Parameters:

newEncoding - the character encoding to set

Throws:

UnsupportedEncodingException - If the specified encoding is not supported by the runtime.

setEncoding

public void setEncoding(String encoding)
                 throws SecurityException,
                        UnsupportedEncodingException

Sets the character encoding used by this handler. A null value indicates the using of the default encoding.

Parameters:

encoding - the character encoding to set

Throws:

SecurityException - If a security manager determines that the caller does not have the required permission.

UnsupportedEncodingException - If the specified encoding is not supported by the runtime.

setErrorManager

public void setErrorManager(ErrorManager em)

Sets the error manager for this handler.

Parameters:

em - the error manager to set

Throws:

SecurityException - If a security manager determines that the caller does not have the required permission.

setFilter

public void setFilter(Filter newFilter)

Sets the filter to be used by this handler.

Parameters:

newFilter - the filter to set

Throws:

SecurityException - If a security manager determines that the caller does not have the required permission.

internalSetFormatter

void internalSetFormatter(Formatter newFormatter)

Sets the formatter to be used by this handler. This internal method does not check security.

Parameters:

newFormatter - the formatter to set

setFormatter

public void setFormatter(Formatter newFormatter)

Sets the formatter to be used by this handler.

Parameters:

newFormatter - the formatter to set

Throws:

SecurityException - If a security manager determines that the caller does not have the required permission.

setLevel

public void setLevel(Level newLevel)

Sets the logging level of this handler.

Parameters:

newLevel - the logging level to set

Throws:

SecurityException - If a security manager determines that the caller does not have the required permission.