org.jboss.logmanager.log4j.handlers

Class Log4jAppenderHandler

java.lang.Object

java.util.logging.Handler

org.jboss.logmanager.ExtHandler

org.jboss.logmanager.log4j.handlers.Log4jAppenderHandler

All Implemented Interfaces:

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

public final class Log4jAppenderHandler
extends org.jboss.logmanager.ExtHandler

A handler which delegates to a log4j appender.

Field Summary

Fields inherited from class org.jboss.logmanager.ExtHandler

handlers, handlersUpdater

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
void	close() Close the handler and its corresponding appender.
protected void	doPublish(org.jboss.logmanager.ExtLogRecord record) Publish a log record.
void	flush() Do nothing (there is no equivalent method on log4j appenders).
org.apache.log4j.Appender	getAppender() Get the log4j appender.
void	setAppender(org.apache.log4j.Appender appender) Set the Log4j appender.
void	setFormatter(Formatter newFormatter)

Methods inherited from class org.jboss.logmanager.ExtHandler

addHandler, checkAccess, clearHandlers, getHandlers, isAutoFlush, publish, publish, removeHandler, setAutoFlush, setHandlers

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

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

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 Handler

Throws:

SecurityException

doPublish

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

Publish a log record.

Overrides:

doPublish in class org.jboss.logmanager.ExtHandler

Parameters:

record - the log record to publish

flush

public void flush()

Do nothing (there is no equivalent method on log4j appenders).

Specified by:

flush in interface Flushable

Specified by:

flush in class Handler

close

public void close()
           throws SecurityException

Close the handler and its corresponding appender.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Handler

Throws:

SecurityException - if you are not allowed to close a handler