de.kune.sessionxs.matcher

Interface SessionMatcher

All Known Implementing Classes:

AbstractHeaderMatcher, AbstractSessionMatcher, ClientIPAddressMatcher, UserAgentHeaderMatcher

public interface SessionMatcher

Specifies the interface for a session matcher. Session matchers will be called by the SessionMatcherFilter to match a SessionMatcherContext against a request. Please be aware that session matchers will be shared between different requests and sessions, so any state information should be stored into the session matcher context, only. If possible implementations of this interface should inherit from AbstractSessionMatcher to ensure compatibility with future releases.

Author:

Alexander Kune

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

init

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

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.

Parameters:

request - the request

Returns:

a session matcher context

matches

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

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 init(HttpServletRequest) method.

Parameters:

context - the session matcher context

request - the request

Returns:

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