Class CommonsRequestLoggingFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.web.filter.AbstractRequestLoggingFilter

org.springframework.web.filter.CommonsRequestLoggingFilter

All Implemented Interfaces:

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

public class CommonsRequestLoggingFilter
extends AbstractRequestLoggingFilter

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

Since:

1.2.5

Author:

Rob Harrop, Juergen Hoeller

See Also:

• AbstractRequestLoggingFilter.setIncludeQueryString(boolean)
• AbstractRequestLoggingFilter.setBeforeMessagePrefix(String)
• AbstractRequestLoggingFilter.setBeforeMessageSuffix(String)
• AbstractRequestLoggingFilter.setAfterMessagePrefix(String)
• AbstractRequestLoggingFilter.setAfterMessageSuffix(String)
• Log.debug(Object)

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
CommonsRequestLoggingFilter()

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.
protected boolean	shouldLog(jakarta.servlet.http.HttpServletRequest request)	Determine whether to call the AbstractRequestLoggingFilter.beforeRequest(HttpServletRequest, String)/AbstractRequestLoggingFilter.afterRequest(HttpServletRequest, String) methods for the current request, i.e.

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, 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

CommonsRequestLoggingFilter

public CommonsRequestLoggingFilter()

Method Details

shouldLog

protected boolean shouldLog(jakarta.servlet.http.HttpServletRequest request)

Description copied from class: AbstractRequestLoggingFilter

Determine whether to call the AbstractRequestLoggingFilter.beforeRequest(HttpServletRequest, String)/AbstractRequestLoggingFilter.afterRequest(HttpServletRequest, String) methods for the current request, i.e. whether logging is currently active (and the log message is worth building).

The default implementation always returns true. Subclasses may override this with a log level check.

Overrides:

shouldLog in class AbstractRequestLoggingFilter

Parameters:

request - current HTTP request

Returns:

true if the before/after method should get called; false otherwise

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