org.finra.herd.ui

Class RequestLoggingFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.finra.herd.ui.RequestLoggingFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public class RequestLoggingFilter
extends org.springframework.web.filter.OncePerRequestFilter

A servlet filter that logs incoming HTTP requests. This approach is similar to the Spring CommonsRequestLoggingFilter, but is customized to ensure that the full request body is always read and logged. In addition, this filter only has the concept of "before" request logging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RequestLoggingFilter.RequestLoggingFilterWrapper A request wrapper that logs incoming requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AFTER_REQUEST_LOG_MESSAGE_PREFIX
static String	DEFAULT_LOG_MESSAGE_PREFIX
static String	DEFAULT_LOG_MESSAGE_SUFFIX

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor and Description
RequestLoggingFilter()

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)
protected Integer	getMaxPayloadLength() Return the maximum length of the payload body to be included in the log message.
protected boolean	isIncludeClientInfo() Return whether or not the client address and session id should be included in the log message.
protected boolean	isIncludePayload() Return whether or not the request payload (body) should be included in the log message.
protected boolean	isIncludeQueryString() Return whether or not the query string should be included in the log message.
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	setLogMessagePrefix(String logMessagePrefix) Set the value that should be prepended to the log message.
void	setLogMessageSuffix(String logMessageSuffix) Set the value that should be appended to the log message.
void	setMaxPayloadLength(Integer maxPayloadLength) Sets the maximum length of the payload body to be included in the log message.

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOG_MESSAGE_PREFIX

public static final String DEFAULT_LOG_MESSAGE_PREFIX

See Also:

Constant Field Values

DEFAULT_LOG_MESSAGE_SUFFIX

public static final String DEFAULT_LOG_MESSAGE_SUFFIX

See Also:

Constant Field Values

AFTER_REQUEST_LOG_MESSAGE_PREFIX

public static final String AFTER_REQUEST_LOG_MESSAGE_PREFIX

See Also:

Constant Field Values

Constructor Detail

RequestLoggingFilter

public RequestLoggingFilter()

Method Detail

setIncludeQueryString

public void setIncludeQueryString(boolean includeQueryString)

Set whether or not the query string should be included in the log message.

isIncludeQueryString

protected boolean isIncludeQueryString()

Return whether or not the query string should be included in the log message.

setIncludeClientInfo

public void setIncludeClientInfo(boolean includeClientInfo)

Set whether or not the client address and session id should be included in the log message.

isIncludeClientInfo

protected boolean isIncludeClientInfo()

Return whether or not the client address and session id should be included in the log message.

setIncludePayload

public void setIncludePayload(boolean includePayload)

Set whether or not the request payload (body) should be included in the log message.

isIncludePayload

protected boolean isIncludePayload()

Return whether or not the request payload (body) should be included in the log message.

setMaxPayloadLength

public void setMaxPayloadLength(Integer maxPayloadLength)

Sets the maximum length of the payload body to be included in the log message. Default (i.e. null) is unlimited characters.

getMaxPayloadLength

protected Integer getMaxPayloadLength()

Return the maximum length of the payload body to be included in the log message.

setLogMessagePrefix

public void setLogMessagePrefix(String logMessagePrefix)

Set the value that should be prepended to the log message.

setLogMessageSuffix

public void setLogMessageSuffix(String logMessageSuffix)

Set the value that should be appended to the log message.

doFilterInternal

protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

javax.servlet.ServletException

IOException