Package sk.antons.web.filter.limiter

Class PathConf<T>

java.lang.Object

sk.antons.web.filter.limiter.PathConf<T>

public class PathConf<T>
extends Object

Helper class for configuring path matchers in limiter.

Author:

antons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PathConf.Combo
static class	PathConf.ComboConf

Field Summary

Fields

Modifier and Type	Field	Description
protected List<PathConf.Combo>	excludes
protected List<PathConf.Combo>	includes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PathConf(T parent)

Method Summary

Modifier and Type	Method	Description
T	and()	Back to limiter instance.
PathConf	exclude(String pattern)	Add exclude path matcher
PathConf	exclude(String pattern, String method)	Add exclude path matcher
PathConf	exclude(String pattern, String method, String ip, String host, String contenttype, ResponseStatusCheck responseStatusCheck)	Add exclude path matcher
PathConf	include(String pattern)	Add include path matcher
PathConf	include(String pattern, String method)	Add include path matcher
PathConf	include(String pattern, String method, String ip, String host, String contenttype, ResponseStatusCheck responseStatusCheck)	Add include path matcher
PathConf	reset(int max)	Clears all setting for path configuration.

Methods inherited from class java.lang.Object

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

Field Detail

includes

protected List<PathConf.Combo> includes

excludes

protected List<PathConf.Combo> excludes

Constructor Detail

PathConf

protected PathConf(T parent)

Method Detail

and

public T and()

Back to limiter instance.

Returns:

reset

public PathConf reset(int max)

Clears all setting for path configuration.

Parameters:

max - maximal number of path element which may occure.

Returns:

this path configuration instance

include

public PathConf include(String pattern)

Add include path matcher

Parameters:

pattern - pattern for path matcher (mandatory)

Returns:

this path configuration instance

include

public PathConf include(String pattern,
                        String method)

Add include path matcher

Parameters:

pattern - pattern for path matcher (mandatory)

method - method applied together with matcher if is is not null

Returns:

this path configuration instance

include

public PathConf include(String pattern,
                        String method,
                        String ip,
                        String host,
                        String contenttype,
                        ResponseStatusCheck responseStatusCheck)

Add include path matcher

Parameters:

pattern - pattern for path matcher (mandatory)

method - method applied together with matcher if is is not null

ip - ip address applied together with matcher if is is not null

host - host name applied together with matcher if is is not null

contenttype - content type applied together with matcher if is is not null

responseStatusCheck - method applied together with matcher if is is not null

Returns:

this path configuration instance

exclude

public PathConf exclude(String pattern)

Add exclude path matcher

Parameters:

pattern - pattern for path matcher (mandatory)

Returns:

this path configuration instance

exclude

public PathConf exclude(String pattern,
                        String method)

Add exclude path matcher

Parameters:

pattern - pattern for path matcher (mandatory)

method - method applied together with matcher if is is not null

Returns:

this path configuration instance

exclude

public PathConf exclude(String pattern,
                        String method,
                        String ip,
                        String host,
                        String contenttype,
                        ResponseStatusCheck responseStatusCheck)

Add exclude path matcher

Parameters:

pattern - pattern for path matcher (mandatory)

method - method applied together with matcher if is is not null

ip - ip address applied together with matcher if is is not null

host - host name applied together with matcher if is is not null

contenttype - content type applied together with matcher if is is not null

responseStatusCheck - method applied together with matcher if is is not null

Returns:

this path configuration instance