org.objectweb.util.monolog.wrapper.javaLog
Class GenericHandler

java.lang.Object
  java.util.logging.Handler
      org.objectweb.util.monolog.wrapper.javaLog.GenericHandler

All Implemented Interfaces:

Handler

Direct Known Subclasses:

JMXGenericHandler

public class GenericHandler
extends Handler
implements Handler

Is a generic handler implementation used to wrapper java.util.logging.Handler instance.

Author:

S.Chassande-Barrioz

Field Summary

Handler	handler The real handler
protected String	name The name of the handler
protected String	type the type of the handler (see org.objectweb.util.monolog.api.Handler for the possible values)

Fields inherited from interface org.objectweb.util.monolog.api.Handler

APPEND_MODE_ATTRIBUTE, BUFFER_ATTRIBUTE, CONSOLE_HANDLER_TYPE, FILE_HANDLER_TYPE, FILE_NUMBER_ATTRIBUTE, GENERIC_HANDLER_TYPE, JMX_HANDLER_TYPE, LEVEL_ATTRIBUTE, LOGGER_HANDLER_TYPE, MAX_SIZE_ATTRIBUTE, OUTPUT_ATTRIBUTE, PATTERN_ATTRIBUTE, ROLLING_FILE_HANDLER_TYPE

Constructor Summary

GenericHandler()

GenericHandler(String name)

GenericHandler(String name, Handler h)
builds a generic handler since a real handler.

GenericHandler(String name, String type)
Builds a generic handler with its name and the type.

Method Summary

void	close() Close the Handler and free all associated resources.
void	flush() Flush any buffered output.
Object	getAttribute(String n) It retrieves the value of an attribute value of the handler.
String[]	getAttributeNames() It retrieves the attributes of the handler
String	getEncoding() Return the character encoding for this Handler.
Filter	getFilter() Get the current Filter for this Handler.
Formatter	getFormatter() Return the Formatter for this Handler.
Level	getLevel() Get the log level specifying which messages will be logged by this Handler.
String	getName() It retrieves the name of the handler
String	getType() It retrieves the Handler type
boolean	isLoggable(LogRecord record) Check if this Handler would actually log a given LogRecord.
void	publish(LogRecord record) Publish a LogRecord.
Object	setAttribute(String _name, Object value) It assigns an attributte to the handler.
void	setEncoding(String encoding) Set the character encoding used by this Handler.
protected void	setException(Exception exception) Set the most recent IO exception.
void	setFilter(Filter newFilter) Set a Filter to control output on this Handler.
void	setFormatter(Formatter newFormatter) Set a Formatter.
void	setLevel(Level newLevel) Set the log level specifying which message levels will be logged by this Handler.
void	setName(String name) It assigns the name of the handler

Methods inherited from class java.util.logging.Handler

getErrorManager, reportError, setErrorManager

Methods inherited from class java.lang.Object

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

Field Detail

handler

public Handler handler

The real handler

type

protected String type

the type of the handler (see org.objectweb.util.monolog.api.Handler for the possible values)

name

protected String name

The name of the handler

Constructor Detail

GenericHandler

public GenericHandler()

GenericHandler

public GenericHandler(String name)

GenericHandler

public GenericHandler(String name,
                      String type)

Builds a generic handler with its name and the type. The real handler will be instanciated after the configuration step.

Parameters:

name - is the name of the handler

type - is the type of the handler

GenericHandler

public GenericHandler(String name,
                      Handler h)

builds a generic handler since a real handler.

Parameters:

name - is the name of the handler

h - is the real handler

Method Detail

getName

public String getName()

It retrieves the name of the handler

Specified by:

getName in interface Handler

setName

public void setName(String name)

It assigns the name of the handler

Specified by:

setName in interface Handler

getType

public String getType()

It retrieves the Handler type

Specified by:

getType in interface Handler

getAttributeNames

public String[] getAttributeNames()

It retrieves the attributes of the handler

Specified by:

getAttributeNames in interface Handler

getAttribute

public Object getAttribute(String n)

It retrieves the value of an attribute value of the handler.

Specified by:

getAttribute in interface Handler

Parameters:

name - is an attribute name

setAttribute

public Object setAttribute(String _name,
                           Object value)

It assigns an attributte to the handler.

Specified by:

setAttribute in interface Handler

Parameters:

_name - is the attribute name

value - is the attribute value

Returns:

the old value is the attribute was already defined

close

public void close()

Close the Handler and free all associated resources.

Specified by:

close in class Handler

flush

public void flush()

Flush any buffered output.

Specified by:

flush in class Handler

getEncoding

public String getEncoding()

Return the character encoding for this Handler.

Overrides:

getEncoding in class Handler

getFilter

public Filter getFilter()

Get the current Filter for this Handler.

Overrides:

getFilter in class Handler

getFormatter

public Formatter getFormatter()

Return the Formatter for this Handler.

Overrides:

getFormatter in class Handler

getLevel

public Level getLevel()

Get the log level specifying which messages will be logged by this Handler.

Overrides:

getLevel in class Handler

isLoggable

public boolean isLoggable(LogRecord record)

Check if this Handler would actually log a given LogRecord.

Overrides:

isLoggable in class Handler

publish

public void publish(LogRecord record)

Publish a LogRecord.

Specified by:

publish in class Handler

setEncoding

public void setEncoding(String encoding)
                 throws SecurityException,
                        UnsupportedEncodingException

Set the character encoding used by this Handler.

Overrides:

setEncoding in class Handler

Throws:

SecurityException

UnsupportedEncodingException

setException

protected void setException(Exception exception)

Set the most recent IO exception.

setFilter

public void setFilter(Filter newFilter)

Set a Filter to control output on this Handler.

Overrides:

setFilter in class Handler

setFormatter

public void setFormatter(Formatter newFormatter)

Set a Formatter.

Overrides:

setFormatter in class Handler

setLevel

public void setLevel(Level newLevel)

Set the log level specifying which message levels will be logged by this Handler.

Overrides:

setLevel in class Handler