org.owasp.security.logging.mdc

Class MDCFilter

java.lang.Object

org.owasp.security.logging.mdc.MDCFilter

All Implemented Interfaces:

javax.servlet.Filter

public class MDCFilter
extends Object
implements javax.servlet.Filter

J2EE filter to add request information to the logging context. Adding data to the MDC is accomplished through implementations of the IPlugin interface. This filter adds the following information to the MDC:

• %X{ipAddress} - The remote IP address of the request (using IPAddressPlugin)
• %X{session} - A hash of the J2EE session ID (using SessionPlugin)
• %X{productName} - A product name identifier (specified in web.xml)
• %X{hostname} - The server hostname (from HttpServletRequest)
• %X{locale} - The preferred Locale of the client (from HttpServletRequest.getLocale())

Author:

August Detlefsen [augustd@codemagi.com]

See Also:

IPlugin

Field Summary

Fields

Modifier and Type	Field and Description
static String	IPADDRESS
static String	LOGIN_ID
static String	SESSION

Constructor Summary

Constructors

Constructor and Description
MDCFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain) Sample filter that populates the MDC on every request.
void	init(javax.servlet.FilterConfig filterConfig)

Methods inherited from class java.lang.Object

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

Field Detail

IPADDRESS

public static final String IPADDRESS

See Also:

Constant Field Values

LOGIN_ID

public static final String LOGIN_ID

See Also:

Constant Field Values

SESSION

public static final String SESSION

See Also:

Constant Field Values

Constructor Detail

MDCFilter

public MDCFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest servletRequest,
                     javax.servlet.ServletResponse servletResponse,
                     javax.servlet.FilterChain filterChain)
              throws IOException,
                     javax.servlet.ServletException

Sample filter that populates the MDC on every request.

Specified by:

doFilter in interface javax.servlet.Filter

Parameters:

servletRequest - The request to filter

servletResponse - The response to filter

filterChain - The filter chain for this context

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter