org.apache.logging.log4j.web.appender

Class ServletAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

org.apache.logging.log4j.web.appender.ServletAppender

All Implemented Interfaces:

Appender, Filterable, LifeCycle

@Plugin(name="Servlet",
        category="Core",
        elementType="appender",
        printObject=true)
public class ServletAppender
extends AbstractAppender

Logs using the ServletContext's log method

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

LOGGER

Method Summary

Modifier and Type	Method and Description
void	append(LogEvent event) Log in Appender specific way.
static ServletAppender	createAppender(Layout<? extends Serializable> layout, Filter filter, String name, String ignore) Create a Console Appender.

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toString

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, hasFilter, isFiltered, removeFilter, start, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

getState, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

isStarted, isStopped, start, stop

Method Detail

append

public void append(LogEvent event)

Description copied from interface: Appender

Log in Appender specific way. When appropriate, Loggers will call the doAppend method of appender implementations in order to log.

Parameters:

event - The LogEvent.

createAppender

@PluginFactory
public static ServletAppender createAppender(@PluginElement(value="Layout")
                                                            Layout<? extends Serializable> layout,
                                                            @PluginElement(value="Filter")
                                                            Filter filter,
                                                            @PluginAttribute(value="name")
                                                            String name,
                                                            @PluginAttribute(value="ignoreExceptions",defaultBoolean=true)
                                                            String ignore)

Create a Console Appender.

Parameters:

layout - The layout to use (required).

filter - The Filter or null.

name - The name of the Appender (required).

ignore - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.

Returns:

The ServletAppender.