net.anotheria.moskito.web

Class MoskitoFilter

java.lang.Object

net.anotheria.moskito.web.MoskitoFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

AsyncSourceTldFilter, DomainFilter, MethodFilter, RefererFilter, RequestURIFilter, SourceIpSegmentFilter, SourceTldFilter, UserAgentFilter

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

Base class for filter based traffic monitoring.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INIT_PARAM_LIMIT Parameter name for the init parameter for the limit of dynamic case names (number of names) in the filter config.
protected org.slf4j.Logger	log Logger instance, available for all subclasses.
static String	OTHER Constant for use-cases which are over limit.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MoskitoFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain)
protected abstract String	extractCaseName(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) Overwrite this to provide a name allocation mechanism to make request -> name mapping.
protected String	getCategory() Overwrite this method to register the filter in a category of your choice.
protected Interval[]	getMonitoringIntervals()
protected FilterStats	getOtherStats()
protected OnDemandStatsProducer<FilterStats>	getProducer()
String	getProducerId() Returns the producer id.
protected String	getSubsystem() Override this to register the filter as specially defined subsystem.
void	init(javax.servlet.FilterConfig config)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.slf4j.Logger log

Logger instance, available for all subclasses.

INIT_PARAM_LIMIT

public static final String INIT_PARAM_LIMIT

Parameter name for the init parameter for the limit of dynamic case names (number of names) in the filter config. If the number of cases will exceed this limit, the new cases will be ignored (to prevent memory leakage).

See Also:

Constant Field Values

OTHER

public static final String OTHER

Constant for use-cases which are over limit. In case we gather all request urls and we set a limit of 1000 it may well happen, that we actually have more than the set limit. In this case it is good to know how many requests those, 'other' urls produce.

See Also:

Constant Field Values

Constructor Detail

MoskitoFilter

protected MoskitoFilter()

Method Detail

doFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

extractCaseName

protected abstract String extractCaseName(javax.servlet.ServletRequest req,
                     javax.servlet.ServletResponse res)

Overwrite this to provide a name allocation mechanism to make request -> name mapping.

Parameters:

req - ServletRequest.

res - ServletResponse.

Returns:

name of the use case for stat storage.

getProducerId

public String getProducerId()

Returns the producer id. Override this method if you want a useful name in your logs. Default is class name.

getCategory

protected String getCategory()

Overwrite this method to register the filter in a category of your choice. Default is 'filter'.

Returns:

the category of this producer.

getSubsystem

protected String getSubsystem()

Override this to register the filter as specially defined subsystem. Default is 'default'.

Returns:

the subsystem of this producer.

getMonitoringIntervals

protected Interval[] getMonitoringIntervals()

getProducer

protected OnDemandStatsProducer<FilterStats> getProducer()

getOtherStats

protected FilterStats getOtherStats()