Package 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, LocationAware, LifeCycle, LifeCycle2

@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

Modifier and Type	Class	Description
static class	ServletAppender.Builder<B extends ServletAppender.Builder<B>>

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

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	logThrowables
private jakarta.servlet.ServletContext	servletContext

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

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Appender

ELEMENT_TYPE, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ServletAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, jakarta.servlet.ServletContext servletContext, boolean ignoreExceptions, boolean logThrowables)

Method Summary

Modifier and Type	Method	Description
void	append(LogEvent event)	Logs a LogEvent using whatever logic this Appender wishes to use.
static ServletAppender	createAppender(Layout<? extends java.io.Serializable> layout, Filter filter, java.lang.String name, boolean ignoreExceptions)	Deprecated. Use newBuilder().
static <B extends ServletAppender.Builder<B>> B	newBuilder()

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

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

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

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

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

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

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

getState, initialize, isStarted, isStopped, start, stop

Field Detail

servletContext

private final jakarta.servlet.ServletContext servletContext

logThrowables

private final boolean logThrowables

Constructor Detail

ServletAppender

private ServletAppender(java.lang.String name,
                        Layout<? extends java.io.Serializable> layout,
                        Filter filter,
                        jakarta.servlet.ServletContext servletContext,
                        boolean ignoreExceptions,
                        boolean logThrowables)

Method Detail

newBuilder

@PluginBuilderFactory
public static <B extends ServletAppender.Builder<B>> B newBuilder()

append

public void append(LogEvent event)

Description copied from interface: Appender

Logs a LogEvent using whatever logic this Appender wishes to use. It is typically recommended to use a bridge pattern not only for the benefits from decoupling an Appender from its implementation, but it is also handy for sharing resources which may require some form of locking.

Parameters:

event - The LogEvent.

createAppender

@Deprecated
public static ServletAppender createAppender(Layout<? extends java.io.Serializable> layout,
                                             Filter filter,
                                             java.lang.String name,
                                             boolean ignoreExceptions)

Deprecated.

Use newBuilder().

Creates a Servlet Appender.

Parameters:

layout - The layout to use (required). Must extend AbstractStringLayout.

filter - The Filter or null.

name - The name of the Appender (required).

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

Returns:

The ServletAppender.