org.kuali.kra.web.filter

Class RequestLoggingFilter

java.lang.Object

org.kuali.kra.web.filter.RequestLoggingFilter

All Implemented Interfaces:

javax.servlet.Filter

public class RequestLoggingFilter
extends Object
implements javax.servlet.Filter

Part of KRA's FilterChain that handles HttpServletRequest and HttpSession state. State information that is recorded in logs is:

• Currently logged in user
• Date/Time
• Intended Action
• Request Headers
• Target URI
• Client IP Address
• Request Parameters

Everything is logged at DEBUG except the following uses the INFO Log Level:

• Currently logged in user
• Date/Time
• Intended Action

Constructor Summary

Constructors

Constructor and Description
RequestLoggingFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) Does the actual logging.
void	init(javax.servlet.FilterConfig config)
protected boolean	isInfoNotAllowed() Determine if the logging is allowed by using Log.isInfoEnabled().

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestLoggingFilter

public RequestLoggingFilter()

Method Detail

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

See Also:

Filter.destroy()

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

See Also:

Filter.init(FilterConfig)

doFilter

public void doFilter(javax.servlet.ServletRequest request,
            javax.servlet.ServletResponse response,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Does the actual logging. The log4j.properties file already covers user and date/time logging for us, so the only thing that gets logged in INFO here is the intended action.

Inefficiency:Currently, an action map is being used to determine the intended action of the user.

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

See Also:

Filter.doFilter(ServletRequest,ServletResponse,FilterChain)

isInfoNotAllowed

protected boolean isInfoNotAllowed()

Determine if the logging is allowed by using Log.isInfoEnabled(). Currently the INFO level is required for logging here. It is possible that by extending this class and overriding #isLoggingAllowed() the required log level can be adjusted.

Returns:

the value of Log.isInfoEnabled() directly.