Class ServletContextRequestLoggingFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.web.filter.AbstractRequestLoggingFilter

org.springframework.web.filter.ServletContextRequestLoggingFilter

All Implemented Interfaces:

jakarta.servlet.Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware

public class ServletContextRequestLoggingFilter
extends AbstractRequestLoggingFilter

Simple request logging filter that writes the request URI (and optionally the query string) to the ServletContext log.

Since:

1.2.5

Author:

Juergen Hoeller

See Also:

• AbstractRequestLoggingFilter.setIncludeQueryString(boolean)
• AbstractRequestLoggingFilter.setBeforeMessagePrefix(String)
• AbstractRequestLoggingFilter.setBeforeMessageSuffix(String)
• AbstractRequestLoggingFilter.setAfterMessagePrefix(String)
• AbstractRequestLoggingFilter.setAfterMessageSuffix(String)
• ServletContext.log(String)

Field Summary

Fields inherited from class AbstractRequestLoggingFilter

DEFAULT_AFTER_MESSAGE_PREFIX, DEFAULT_AFTER_MESSAGE_SUFFIX, DEFAULT_BEFORE_MESSAGE_PREFIX, DEFAULT_BEFORE_MESSAGE_SUFFIX

Fields inherited from class OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class GenericFilterBean

logger

Constructor Summary

Constructors

Constructor	Description
ServletContextRequestLoggingFilter()

Method Summary

Modifier and Type	Method	Description
protected void	afterRequest(jakarta.servlet.http.HttpServletRequest request, String message)	Writes a log message after the request is processed.
protected void	beforeRequest(jakarta.servlet.http.HttpServletRequest request, String message)	Writes a log message before the request is processed.

Methods inherited from class AbstractRequestLoggingFilter

createMessage, doFilterInternal, getHeaderPredicate, getMaxPayloadLength, getMessagePayload, getQueryParamPredicate, isIncludeClientInfo, isIncludeHeaders, isIncludePayload, isIncludeQueryString, setAfterMessagePrefix, setAfterMessageSuffix, setBeforeMessagePrefix, setBeforeMessageSuffix, setHeaderPredicate, setIncludeClientInfo, setIncludeHeaders, setIncludePayload, setIncludeQueryString, setMaxPayloadLength, setQueryParamPredicate, shouldLog, shouldNotFilterAsyncDispatch

Methods inherited from class OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterErrorDispatch

Methods inherited from class GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class Object

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

Constructor Details

ServletContextRequestLoggingFilter

public ServletContextRequestLoggingFilter()

Method Details

beforeRequest

protected void beforeRequest(jakarta.servlet.http.HttpServletRequest request,
 String message)

Writes a log message before the request is processed.

Specified by:

beforeRequest in class AbstractRequestLoggingFilter

Parameters:

request - current HTTP request

message - the message to log

afterRequest

protected void afterRequest(jakarta.servlet.http.HttpServletRequest request,
 String message)

Writes a log message after the request is processed.

Specified by:

afterRequest in class AbstractRequestLoggingFilter

Parameters:

request - current HTTP request

message - the message to log