public class

Log4jNestedDiagnosticContextFilter

extends AbstractRequestLoggingFilter

java.lang.Object
↳	org.springframework.web.filter.GenericFilterBean
	↳	org.springframework.web.filter.OncePerRequestFilter
		↳	org.springframework.web.filter.AbstractRequestLoggingFilter
			↳	org.springframework.web.filter.Log4jNestedDiagnosticContextFilter

Class Overview

Request logging filter that adds the request log message to the Log4J nested diagnostic context (NDC) before the request is processed, removing it again after the request is processed.

Summary

[Expand]

Inherited Constants

From class org.springframework.web.filter.AbstractRequestLoggingFilter

From class org.springframework.web.filter.OncePerRequestFilter

Fields
protected final Logger	log4jLogger	Logger available to subclasses

[Expand]

Inherited Fields

From class org.springframework.web.filter.GenericFilterBean

Public Constructors
	Log4jNestedDiagnosticContextFilter()

Protected Methods
void	afterRequest(HttpServletRequest request, String message) Removes the log message from the Log4J NDC after the request is processed and logs the after-request message through Log4J.
void	beforeRequest(HttpServletRequest request, String message) Logs the before-request message through Log4J and adds a message the Log4J NDC before the request is processed.
String	getNestedDiagnosticContextMessage(HttpServletRequest request) Determine the message to be pushed onto the Log4J nested diagnostic context.

[Expand]

Inherited Methods

From class org.springframework.web.filter.AbstractRequestLoggingFilter

abstract void	afterRequest(HttpServletRequest request, String message) Concrete subclasses should implement this method to write a log message after the request is processed.
abstract void	beforeRequest(HttpServletRequest request, String message) Concrete subclasses should implement this method to write a log message before the request is processed.
String	createMessage(HttpServletRequest request, String prefix, String suffix) Create a log message for the given request, prefix and suffix.
void	doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) Forwards the request to the next filter in the chain and delegates down to the subclasses to perform the actual request logging both before and after the request is processed.
int	getMaxPayloadLength() Return the maximum length of the payload body to be included in the log message.
boolean	isIncludeClientInfo() Return whether or not the client address and session id should be included in the log message.
boolean	isIncludePayload() Return whether or not the request payload (body) should be included in the log message.
boolean	isIncludeQueryString() Return whether or not the query string should be included in the log message.
void	setAfterMessagePrefix(String afterMessagePrefix) Set the value that should be prepended to the log message written after a request is processed.
void	setAfterMessageSuffix(String afterMessageSuffix) Set the value that should be appended to the log message written after a request is processed.
void	setBeforeMessagePrefix(String beforeMessagePrefix) Set the value that should be prepended to the log message written before a request is processed.
void	setBeforeMessageSuffix(String beforeMessageSuffix) Set the value that should be apppended to the log message written before a request is processed.
void	setIncludeClientInfo(boolean includeClientInfo) Set whether or not the client address and session id should be included in the log message.
void	setIncludePayload(boolean includePayload) Set whether or not the request payload (body) should be included in the log message.
void	setIncludeQueryString(boolean includeQueryString) Set whether or not the query string should be included in the log message.
void	setMaxPayloadLength(int maxPayloadLength) Sets the maximum length of the payload body to be included in the log message.

From class org.springframework.web.filter.OncePerRequestFilter

From class org.springframework.web.filter.GenericFilterBean

final void	addRequiredProperty(String property) Subclasses can invoke this method to specify that this property (which must match a JavaBean property they expose) is mandatory, and must be supplied as a config parameter.
void	afterPropertiesSet() Calls the `initFilterBean()` method that might contain custom initialization of a subclass.
void	destroy() Subclasses may override this to perform custom filter shutdown.
final FilterConfig	getFilterConfig() Make the FilterConfig of this filter available, if any.
final String	getFilterName() Make the name of this filter available to subclasses.
final ServletContext	getServletContext() Make the ServletContext of this filter available to subclasses.
final void	init(FilterConfig filterConfig) Standard way of initializing this filter.
void	initBeanWrapper(BeanWrapper bw) Initialize the BeanWrapper for this GenericFilterBean, possibly with custom editors.
void	initFilterBean() Subclasses may override this to perform custom initialization.
final void	setBeanName(String beanName) Stores the bean name as defined in the Spring bean factory.
void	setEnvironment(Environment environment) Set the `Environment` that this object runs in. Any environment set here overrides the `DefaultWebEnvironment` provided by default.
final void	setServletContext(ServletContext servletContext) Stores the ServletContext that the bean factory runs in.

From class java.lang.Object

From interface javax.servlet.Filter

From interface org.springframework.beans.factory.BeanNameAware

From interface org.springframework.beans.factory.DisposableBean

From interface org.springframework.beans.factory.InitializingBean

From interface org.springframework.context.EnvironmentAware

From interface org.springframework.web.context.ServletContextAware

Fields

protected final Logger log4jLogger

Logger available to subclasses

Public Constructors

public Log4jNestedDiagnosticContextFilter ()

Protected Methods

protected void afterRequest (HttpServletRequest request, String message)

Removes the log message from the Log4J NDC after the request is processed and logs the after-request message through Log4J.

Parameters

request	current HTTP request
message	the message to log

protected void beforeRequest (HttpServletRequest request, String message)

Logs the before-request message through Log4J and adds a message the Log4J NDC before the request is processed.

Parameters

request	current HTTP request
message	the message to log

protected String getNestedDiagnosticContextMessage (HttpServletRequest request)

Determine the message to be pushed onto the Log4J nested diagnostic context.

Default is a plain request log message without prefix or suffix.

Parameters

request	current HTTP request

Returns

the message to be pushed onto the Log4J NDC

Classes

Log4jNestedDiagnosticContextFilter

Class Overview

See Also

Summary

Fields

protected final Logger log4jLogger

Public Constructors

public Log4jNestedDiagnosticContextFilter ()

Protected Methods

protected void afterRequest (HttpServletRequest request, String message)

Parameters

protected void beforeRequest (HttpServletRequest request, String message)

Parameters

protected String getNestedDiagnosticContextMessage (HttpServletRequest request)

Parameters

Returns

See Also