net.ttddyy.dsproxy.support

Class AbstractQueryCountLoggingServletFilter

java.lang.Object

net.ttddyy.dsproxy.support.AbstractQueryCountLoggingServletFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

CommonsQueryCountLoggingServletFilter, JULQueryCountLoggingServletFilter, SLF4JQueryCountLoggingServletFilter, SystemOutQueryCountLoggingServletFilter

public abstract class AbstractQueryCountLoggingServletFilter
extends Object
implements javax.servlet.Filter

Servlet filter to output query statistics.

By default, after logging the query count, it resets the QueryCountHolder, so that each http request will have fresh set of query statistics. If you want to manage when to reset the counter, you can disable this filter to clear the counter by setting filter parameter clearQueryCounter to false.

loggerName parameter(Optional): create a logger instance by this name if specified.

 
   <filter>
     <filter-name>count</filter-name>
     <filter-class>net.ttddyy.dsproxy.support.CommonsQueryCountLoggingFilter</filter-class>
     <init-param>
       <param-name>logLevel</param-name>
       <param-value>INFO</param-value>
     <init-param>
     <init-param>
       <param-name>clearQueryCounter</param-name>
       <param-value>false</param-value>
     <init-param>
     <init-param>
       <param-name>loggerName</param-name>
       <param-value>myLogger</param-value>
     <init-param>
   </filter>
 
 

Since:

1.3

Author:

Tadaya Tsuyukubo

See Also:

CommonsQueryCountLoggingServletFilter, SLF4JQueryCountLoggingServletFilter

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLEAR_QUERY_COUNTER_PARAM
protected boolean	clearQueryCounter
static String	FORMAT_PARAM
static String	LOG_LEVEL_PARAM
protected QueryCountLogEntryCreator	logFormatter
static String	LOGGER_NAME
protected boolean	writeAsJson

Constructor Summary

Constructors

Constructor and Description
AbstractQueryCountLoggingServletFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)
protected abstract void	initLogLevelFromFilterConfigIfSpecified(String logLevelParam)
protected abstract void	resetLogger(String loggerName) Callback method to reset the logger object in concrete class when log name is specified.
void	setClearQueryCounter(boolean clearQueryCounter)
void	setLogFormatter(QueryCountLogEntryCreator logFormatter)
void	setWriteAsJson(boolean writeAsJson)
protected abstract void	writeLog(String message)

Methods inherited from class java.lang.Object

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

Field Detail

CLEAR_QUERY_COUNTER_PARAM

public static final String CLEAR_QUERY_COUNTER_PARAM

See Also:

Constant Field Values

LOG_LEVEL_PARAM

public static final String LOG_LEVEL_PARAM

See Also:

Constant Field Values

FORMAT_PARAM

public static final String FORMAT_PARAM

See Also:

Constant Field Values

LOGGER_NAME

public static final String LOGGER_NAME

See Also:

Constant Field Values

clearQueryCounter

protected boolean clearQueryCounter

writeAsJson

protected boolean writeAsJson

logFormatter

protected QueryCountLogEntryCreator logFormatter

Constructor Detail

AbstractQueryCountLoggingServletFilter

public AbstractQueryCountLoggingServletFilter()

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 request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

initLogLevelFromFilterConfigIfSpecified

protected abstract void initLogLevelFromFilterConfigIfSpecified(String logLevelParam)

writeLog

protected abstract void writeLog(String message)

resetLogger

protected abstract void resetLogger(String loggerName)

Callback method to reset the logger object in concrete class when log name is specified.

Parameters:

loggerName - logger name

Since:

1.4.1

setClearQueryCounter

public void setClearQueryCounter(boolean clearQueryCounter)

setLogFormatter

public void setLogFormatter(QueryCountLogEntryCreator logFormatter)

setWriteAsJson

public void setWriteAsJson(boolean writeAsJson)