Package org.jboss.as.logging.logmanager

Class Log4jAppenderHandler

java.lang.Object

java.util.logging.Handler

org.jboss.logmanager.ExtHandler

org.jboss.as.logging.logmanager.Log4jAppenderHandler

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, org.jboss.logmanager.handlers.FlushableCloseable, org.jboss.logmanager.Protectable

public class Log4jAppenderHandler
extends org.jboss.logmanager.ExtHandler

Wraps a log4j appender to a handler.

Author:

James R. Perkins

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Log4jAppenderHandler.FormatterLayout	An emulator for log4j Layouts.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACTIVATE_OPTIONS_METHOD_NAME
static String	ACTIVATOR_PROPERTY_METHOD_NAME

Fields inherited from class org.jboss.logmanager.ExtHandler

handlers, handlersUpdater

Constructor Summary

Constructors

Constructor	Description
Log4jAppenderHandler()
Log4jAppenderHandler(org.apache.log4j.Appender appender)	Construct a new instance.
Log4jAppenderHandler(org.apache.log4j.Appender appender, boolean applyLayout)	Construct a new instance, possibly applying a Layout to the given appender instance.

Method Summary

Modifier and Type	Method	Description
void	activate()	Activates the appender only if it's an option handler.
void	close()
protected void	doPublish(org.jboss.logmanager.ExtLogRecord record)
void	flush()
org.apache.log4j.Appender	getAppender()	Get the log4j appender.
void	setAppender(org.apache.log4j.Appender appender)	Set the Log4j appender.
void	setDummy(String ignore)	This method does nothing.
void	setFormatter(Formatter newFormatter)

Methods inherited from class org.jboss.logmanager.ExtHandler

addHandler, checkAccess, checkAccess, clearHandlers, disableAccess, enableAccess, getHandlers, isAutoFlush, isCallerCalculationRequired, isCloseChildren, isEnabled, protect, publish, publish, removeHandler, setAutoFlush, setCloseChildren, setEnabled, setEncoding, setErrorManager, setFilter, setHandlers, setLevel, unprotect

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVATE_OPTIONS_METHOD_NAME

public static final String ACTIVATE_OPTIONS_METHOD_NAME

See Also:

Constant Field Values

ACTIVATOR_PROPERTY_METHOD_NAME

public static final String ACTIVATOR_PROPERTY_METHOD_NAME

See Also:

Constant Field Values

Constructor Detail

Log4jAppenderHandler

public Log4jAppenderHandler()

Log4jAppenderHandler

public Log4jAppenderHandler(org.apache.log4j.Appender appender)

Construct a new instance.

Parameters:

appender - the appender to delegate to

Log4jAppenderHandler

public Log4jAppenderHandler(org.apache.log4j.Appender appender,
                            boolean applyLayout)

Construct a new instance, possibly applying a Layout to the given appender instance.

Parameters:

appender - the appender to delegate to

applyLayout - true to apply an emulated layout, false otherwise

Method Detail

getAppender

public org.apache.log4j.Appender getAppender()

Get the log4j appender.

Returns:

the log4j appender

setDummy

public void setDummy(String ignore)

This method does nothing. It's only purpose is to be invoked so the activate() method will be invoked when log4j appenders are also option handlers.

Parameters:

ignore - any string value or null

activate

public void activate()

Activates the appender only if it's an option handler.

setAppender

public void setAppender(org.apache.log4j.Appender appender)

Set the Log4j appender.

Parameters:

appender - the log4j appender

setFormatter

public void setFormatter(Formatter newFormatter)
                  throws SecurityException

Overrides:

setFormatter in class org.jboss.logmanager.ExtHandler

Throws:

SecurityException

doPublish

protected void doPublish(org.jboss.logmanager.ExtLogRecord record)

Overrides:

doPublish in class org.jboss.logmanager.ExtHandler

flush

public void flush()

Specified by:

flush in interface Flushable

Overrides:

flush in class org.jboss.logmanager.ExtHandler

close

public void close()
           throws SecurityException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class org.jboss.logmanager.ExtHandler

Throws:

SecurityException