Package org.springframework.web.filter
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:
Filter,Aware,BeanNameAware,DisposableBean,InitializingBean,EnvironmentAware,EnvironmentCapable,ServletContextAware
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(java.lang.String)AbstractRequestLoggingFilter.setBeforeMessageSuffix(java.lang.String)AbstractRequestLoggingFilter.setAfterMessagePrefix(java.lang.String)AbstractRequestLoggingFilter.setAfterMessageSuffix(java.lang.String)Log.debug(Object)
-
Field Summary
Fields inherited from class org.springframework.web.filter.AbstractRequestLoggingFilter
DEFAULT_AFTER_MESSAGE_PREFIX, DEFAULT_AFTER_MESSAGE_SUFFIX, DEFAULT_BEFORE_MESSAGE_PREFIX, DEFAULT_BEFORE_MESSAGE_SUFFIXFields inherited from class org.springframework.web.filter.OncePerRequestFilter
ALREADY_FILTERED_SUFFIXFields inherited from class org.springframework.web.filter.GenericFilterBean
logger -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidafterRequest(HttpServletRequest request, String message) Writes a log message after the request is processed.protected voidbeforeRequest(HttpServletRequest request, String message) Writes a log message before the request is processed.protected booleanshouldLog(HttpServletRequest request) Determine whether to call theAbstractRequestLoggingFilter.beforeRequest(jakarta.servlet.http.HttpServletRequest, java.lang.String)/AbstractRequestLoggingFilter.afterRequest(jakarta.servlet.http.HttpServletRequest, java.lang.String)methods for the current request, i.e.Methods inherited from class org.springframework.web.filter.AbstractRequestLoggingFilter
createMessage, doFilterInternal, getHeaderPredicate, getMaxPayloadLength, getMessagePayload, isIncludeClientInfo, isIncludeHeaders, isIncludePayload, isIncludeQueryString, setAfterMessagePrefix, setAfterMessageSuffix, setBeforeMessagePrefix, setBeforeMessageSuffix, setHeaderPredicate, setIncludeClientInfo, setIncludeHeaders, setIncludePayload, setIncludeQueryString, setMaxPayloadLength, shouldNotFilterAsyncDispatchMethods inherited from class org.springframework.web.filter.OncePerRequestFilter
doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterErrorDispatchMethods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext
-
Constructor Details
-
CommonsRequestLoggingFilter
public CommonsRequestLoggingFilter()
-
-
Method Details
-
shouldLog
Description copied from class:AbstractRequestLoggingFilterDetermine whether to call theAbstractRequestLoggingFilter.beforeRequest(jakarta.servlet.http.HttpServletRequest, java.lang.String)/AbstractRequestLoggingFilter.afterRequest(jakarta.servlet.http.HttpServletRequest, java.lang.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:
shouldLogin classAbstractRequestLoggingFilter- Parameters:
request- current HTTP request- Returns:
trueif the before/after method should get called;falseotherwise
-
beforeRequest
Writes a log message before the request is processed.- Specified by:
beforeRequestin classAbstractRequestLoggingFilter- Parameters:
request- current HTTP requestmessage- the message to log
-
afterRequest
Writes a log message after the request is processed.- Specified by:
afterRequestin classAbstractRequestLoggingFilter- Parameters:
request- current HTTP requestmessage- the message to log
-