de.kune.sessionxs.matcher

Class AbstractHeaderMatcher

java.lang.Object

de.kune.sessionxs.matcher.AbstractSessionMatcher

de.kune.sessionxs.matcher.AbstractHeaderMatcher

All Implemented Interfaces:

SessionMatcher

Direct Known Subclasses:

UserAgentHeaderMatcher

public abstract class AbstractHeaderMatcher
extends AbstractSessionMatcher
implements SessionMatcher

An abstract header matcher that can be used by subclasses for simple header value-based matching.

Author:

Alexander Kune

Constructor Summary

Constructors

Constructor and Description
AbstractHeaderMatcher()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getHeaderKey() Specifies the header key to use for header-based matching.
SessionMatcherContext	init(javax.servlet.http.HttpServletRequest request) Initializes the session matcher from a request.
boolean	matches(SessionMatcherContext context, javax.servlet.http.HttpServletRequest request) Determines if a request actually meets the criteria represented by the specified session matcher context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHeaderMatcher

public AbstractHeaderMatcher()

Method Detail

init

public SessionMatcherContext init(javax.servlet.http.HttpServletRequest request)

Description copied from interface: SessionMatcher

Initializes the session matcher from a request. This is the initial call to a session matcher. Its purpose is to determine the parameters against which subsequent requests will be checked. These parameters have to be stored into the session matcher context returned by this method.

Specified by:

init in interface SessionMatcher

Specified by:

init in class AbstractSessionMatcher

Parameters:

request - the request

Returns:

a session matcher context

matches

public boolean matches(SessionMatcherContext context,
              javax.servlet.http.HttpServletRequest request)

Description copied from interface: SessionMatcher

Determines if a request actually meets the criteria represented by the specified session matcher context. The session matcher context is the on created by the SessionMatcher.init(HttpServletRequest) method.

Specified by:

matches in interface SessionMatcher

Specified by:

matches in class AbstractSessionMatcher

Parameters:

context - the session matcher context

request - the request

Returns:

true if the request meets the criteria represented by the session matcher context

getHeaderKey

protected abstract String getHeaderKey()

Specifies the header key to use for header-based matching.

Returns:

the header key