org.mmbase.framework

Class FrameworkFilter

java.lang.Object

org.mmbase.framework.FrameworkFilter

All Implemented Interfaces:

javax.servlet.Filter, MMBaseStarter

public class FrameworkFilter
extends Object
implements javax.servlet.Filter, MMBaseStarter

Requestfilter that filters out all URL's looking for virtual 'userfriendly' links that have a corresponding page (technical URL) within the website. When the recieved URL is not recognized by the framework as an 'userfriendly' one, it just gets forwarded in its original form. The filtering and conversion to an URL pointing to an existing JSP template is done by an UrlConverter. Regular expressions that define URL's to be excluded from filtering should be listed in the 'excludes' parameter in web.xml.

Since:

MMBase-1.9

Version:

$Id$

Author:

André van Toly

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMS_KEY

Constructor Summary

Constructors

Constructor and Description
FrameworkFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy method
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) Filters a request and delegates it to UrlConverter if needed.
static long	getChainedRequests()
static long	getErrorRequests()
static long	getForwardedRequests()
static long	getIncludedRequests()
MMBase	getMMBase() Returns the currently set MMBase object.
static String	getPath(javax.servlet.http.HttpServletRequest request)
void	init(javax.servlet.FilterConfig config) Initialize the filter, called on webapp startup
void	setInitException(javax.servlet.ServletException se) If something went wrong (an exception occured), the caller may is informed by a call to this method.
void	setMMBase(MMBase mm) Set MMBase object after initializion, in the caller.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMS_KEY

public static final String PARAMS_KEY

See Also:

Constant Field Values

Constructor Detail

FrameworkFilter

public FrameworkFilter()

Method Detail

getForwardedRequests

public static long getForwardedRequests()

getIncludedRequests

public static long getIncludedRequests()

getChainedRequests

public static long getChainedRequests()

getErrorRequests

public static long getErrorRequests()

getMMBase

public MMBase getMMBase()

Description copied from interface: MMBaseStarter

Returns the currently set MMBase object.

Specified by:

getMMBase in interface MMBaseStarter

Returns:

the MMBase instance or null.

setMMBase

public void setMMBase(MMBase mm)

Description copied from interface: MMBaseStarter

Set MMBase object after initializion, in the caller.

Specified by:

setMMBase in interface MMBaseStarter

setInitException

public void setInitException(javax.servlet.ServletException se)

Description copied from interface: MMBaseStarter

If something went wrong (an exception occured), the caller may is informed by a call to this method. (It may ignore it).

Specified by:

setInitException in interface MMBaseStarter

init

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

Initialize the filter, called on webapp startup

Specified by:

init in interface javax.servlet.Filter

Parameters:

config - object containing init parameters specified

Throws:

javax.servlet.ServletException - thrown when an exception occurs in the web.xml

destroy

public void destroy()

Destroy method

Specified by:

destroy in interface javax.servlet.Filter

getPath

public static String getPath(javax.servlet.http.HttpServletRequest request)

doFilter

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

Filters a request and delegates it to UrlConverter if needed. URL conversion is only done when the URI does not match one of the excludes in web.xml. Waits for MMBase to be up.

Specified by:

doFilter in interface javax.servlet.Filter

Parameters:

request - incoming request

response - outgoing response

chain - a chain object, provided for by the servlet container

Throws:

javax.servlet.ServletException - thrown when an exception occurs

IOException - thrown when an exception occurs