org.ow2.proactive.scheduler.common.util.logforwarder.appenders

Class AsyncAppenderWithStorage

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.apache.log4j.AsyncAppender

org.ow2.proactive.scheduler.common.util.logforwarder.appenders.AsyncAppenderWithStorage

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.AppenderAttachable, org.apache.log4j.spi.OptionHandler

public class AsyncAppenderWithStorage
extends org.apache.log4j.AsyncAppender

Class defines a log4j AsyncAppender that is able to store all appended event additionally to bufferize and send them to the added appenders.

Since:

ProActive Scheduling 0.9

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_STORAGE_SIZE Default buffer size.

Fields inherited from class org.apache.log4j.AsyncAppender

DEFAULT_BUFFER_SIZE

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
AsyncAppenderWithStorage() Create a AsyncAppenderWithStorage with default parameters.
AsyncAppenderWithStorage(int bufferSize) Create a AsyncAppenderWithStorage.
AsyncAppenderWithStorage(String name) Create a AsyncAppenderWithStorage.
AsyncAppenderWithStorage(String name, int storageSize) Create a AsyncAppenderWithStorage.

Method Summary

Modifier and Type	Method and Description
void	addAppender(org.apache.log4j.Appender newAppender) When an appender is added, then the content of the storage is append into the added appender.
void	append(org.apache.log4j.spi.LoggingEvent event)
void	appendStoredEvents(org.apache.log4j.Appender appender) Append stored events to the given appender.
void	close()
LinkedList<org.apache.log4j.spi.LoggingEvent>	getStorage() Return a clone of the current logging event storage.
boolean	requiresLayout()

Methods inherited from class org.apache.log4j.AsyncAppender

getAllAppenders, getAppender, getBlocking, getBufferSize, getLocationInfo, isAttached, removeAllAppenders, removeAppender, removeAppender, setBlocking, setBufferSize, setLocationInfo

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STORAGE_SIZE

public static final int DEFAULT_STORAGE_SIZE

Default buffer size. Infinite by default.

See Also:

Constant Field Values

Constructor Detail

AsyncAppenderWithStorage

public AsyncAppenderWithStorage()

Create a AsyncAppenderWithStorage with default parameters. See DEFAULT_BUFFER_SIZE for details.

AsyncAppenderWithStorage

public AsyncAppenderWithStorage(int bufferSize)

Create a AsyncAppenderWithStorage.

Parameters:

bufferSize - the size of the buffer. If the buffer is full, logs events are stored in FIFO manner.

AsyncAppenderWithStorage

public AsyncAppenderWithStorage(String name)

Create a AsyncAppenderWithStorage.

Parameters:

name - the name of the appender. activated

AsyncAppenderWithStorage

public AsyncAppenderWithStorage(String name,
                                int storageSize)

Create a AsyncAppenderWithStorage.

Parameters:

name - the name of the appender.

storageSize - the size of the buffer. If the buffer is full, logs events are stored in FIFO manner. activated

Method Detail

append

public void append(org.apache.log4j.spi.LoggingEvent event)

Overrides:

append in class org.apache.log4j.AsyncAppender

addAppender

public void addAppender(org.apache.log4j.Appender newAppender)

When an appender is added, then the content of the storage is append into the added appender.

Specified by:

addAppender in interface org.apache.log4j.spi.AppenderAttachable

Overrides:

addAppender in class org.apache.log4j.AsyncAppender

See Also:

AsyncAppender.addAppender(org.apache.log4j.Appender)

appendStoredEvents

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

Append stored events to the given appender.

getStorage

public LinkedList<org.apache.log4j.spi.LoggingEvent> getStorage()

Return a clone of the current logging event storage.

Returns:

a cloned linked list containing all logged events.

close

public void close()

Specified by:

close in interface org.apache.log4j.Appender

Overrides:

close in class org.apache.log4j.AsyncAppender

See Also:

Appender.close()

requiresLayout

public boolean requiresLayout()

Specified by:

requiresLayout in interface org.apache.log4j.Appender

Overrides:

requiresLayout in class org.apache.log4j.AsyncAppender

See Also:

Appender.requiresLayout()