GenericHandler (Monolog API)

Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  org.objectweb.util.monolog.wrapper.log4j.GenericHandler

All Implemented Interfaces:: org.apache.log4j.Appender, Handler

public class GenericHandler
extends java.lang.Object
implements org.apache.log4j.Appender, Handler

This class is a generic implementation of the Handler interface. This class delegates all calls on a log4j Appender. It is also an Appender interceptor. This class can therefore be referenced into the log4j struture as an Appender. There are three ways to specify the inner Appender:

by the construstor with the appender instance
by the setAppender method with the appender instance
by the setAttribute method with the appender class name. This method tries to instanciate the class, and initializes the new Appender with all attribute which has been specified before. Even the filters and the layout are memorized.

Author:: Sebastien Chassande-Barrioz

Field Summary
`protected org.apache.log4j.Appender`	`appender` The inner appender
`static java.lang.String`	`APPENDER_CLASS_NAME_ATTR` This constant can be used to specify the class name of the inner appender
`protected java.util.ArrayList`	`filters`
`protected org.apache.log4j.Layout`	`layout`
`protected java.lang.String`	`name` The appender name
`protected java.util.HashMap`	`prop` The properties of the appender

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(org.apache.log4j.Appender a)`
`GenericHandler(java.lang.String name)`

Method Summary
`void`	`addFilter(org.apache.log4j.spi.Filter newFilter)`
`void`	`clearFilters()`
`void`	`close()`
`void`	`doAppend(org.apache.log4j.spi.LoggingEvent event)`
`org.apache.log4j.Appender`	`getAppender()`
`java.lang.Object`	`getAttribute(java.lang.String key)` It retrieves the value of an attribute value of the handler.
`java.lang.String[]`	`getAttributeNames()` It retrieves the attributes of the handler
`org.apache.log4j.spi.ErrorHandler`	`getErrorHandler()`
`org.apache.log4j.spi.Filter`	`getFilter()`
`org.apache.log4j.Layout`	`getLayout()`
`java.lang.String`	`getName()` It retrieves the name of the handler
`java.lang.String`	`getType()` It retrieves the Handler type
`boolean`	`requiresLayout()`
`void`	`setAppender(org.apache.log4j.Appender a)`
`java.lang.Object`	`setAttribute(java.lang.String key, java.lang.Object value)` It assigns an attributte to the handler.
`void`	`setErrorHandler(org.apache.log4j.spi.ErrorHandler errorHandler)`
`void`	`setLayout(org.apache.log4j.Layout layout)`
`void`	`setName(java.lang.String n)` It assigns the name of the handler

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

APPENDER_CLASS_NAME_ATTR

public static final java.lang.String APPENDER_CLASS_NAME_ATTR

This constant can be used to specify the class name of the inner appender

See Also:: Constant Field Values

appender

protected org.apache.log4j.Appender appender

The inner appender

name

protected java.lang.String name

The appender name

prop

protected java.util.HashMap prop

The properties of the appender

filters

protected java.util.ArrayList filters

layout

protected org.apache.log4j.Layout layout

Constructor Detail

GenericHandler

public GenericHandler()

GenericHandler

public GenericHandler(java.lang.String name)

GenericHandler

public GenericHandler(org.apache.log4j.Appender a)

Method Detail

getAppender

public org.apache.log4j.Appender getAppender()