Package org.apache.logging.log4j.web

Class Log4jServletFilter

java.lang.Object

org.apache.logging.log4j.web.Log4jServletFilter

All Implemented Interfaces:

jakarta.servlet.Filter

public class Log4jServletFilter
extends java.lang.Object
implements jakarta.servlet.Filter

This is responsible for the following:

• Clearing the logger context when the application has finished starting up.
• Setting the logger context before processing a request and clearing it after processing a request.
• Setting the logger context when the application is starting to shut down.

This filter is a once-per-request filter. It is capable of filtering all the different types of requests (standard, asynchronous, error, etc.) but will not apply processing if the filter matches multiple times on the same logical request.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	ALREADY_FILTERED_ATTRIBUTE
private Log4jWebLifeCycle	initializer
private static Logger	LOGGER
private jakarta.servlet.ServletContext	servletContext

Constructor Summary

Constructors

Constructor	Description
Log4jServletFilter()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
void	init(jakarta.servlet.FilterConfig filterConfig)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

ALREADY_FILTERED_ATTRIBUTE

static final java.lang.String ALREADY_FILTERED_ATTRIBUTE

servletContext

private jakarta.servlet.ServletContext servletContext

initializer

private Log4jWebLifeCycle initializer

Constructor Detail

Log4jServletFilter

public Log4jServletFilter()

Method Detail

init

public void init(jakarta.servlet.FilterConfig filterConfig)
          throws jakarta.servlet.ServletException

Specified by:

init in interface jakarta.servlet.Filter

Throws:

jakarta.servlet.ServletException

doFilter

public void doFilter(jakarta.servlet.ServletRequest request,
                     jakarta.servlet.ServletResponse response,
                     jakarta.servlet.FilterChain chain)
              throws java.io.IOException,
                     jakarta.servlet.ServletException

Specified by:

doFilter in interface jakarta.servlet.Filter

Throws:

java.io.IOException

jakarta.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Filter