org.apache.wicket.protocol.http
Class WicketFilter

java.lang.Object
  org.apache.wicket.protocol.http.WicketFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

ReloadingWicketFilter

public class WicketFilter
extends java.lang.Object
implements javax.servlet.Filter

Filter for initiating handling of Wicket requests.

Author:

jcompagner

Field Summary

static java.lang.String	APP_FACT_PARAM The name of the context parameter that specifies application factory class
static java.lang.String	FILTER_MAPPING_PARAM The name of the root path parameter that specifies the root dir of the app.

Constructor Summary

WicketFilter()

Method Summary

protected void	createRequestContext(WebRequest request, WebResponse response)
void	destroy() Servlet cleanup.
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
boolean	doGet(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Handles servlet page requests.
protected IWebApplicationFactory	getApplicationFactory() Creates the web application factory instance.
protected java.lang.ClassLoader	getClassLoader()
javax.servlet.FilterConfig	getFilterConfig()
protected java.lang.String	getFilterPath(javax.servlet.http.HttpServletRequest request)
java.lang.String	getRelativePath(javax.servlet.http.HttpServletRequest request) Returns a relative path from an HttpServletRequest Use this to resolve a Wicket request.
void	init(javax.servlet.FilterConfig filterConfig)
protected boolean	isPortletContextAvailable(javax.servlet.FilterConfig config)
protected WicketFilterPortletContext	newWicketFilterPortletContext()

Methods inherited from class java.lang.Object

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

Field Detail

APP_FACT_PARAM

public static final java.lang.String APP_FACT_PARAM

The name of the context parameter that specifies application factory class

See Also:

Constant Field Values

FILTER_MAPPING_PARAM

public static final java.lang.String FILTER_MAPPING_PARAM

The name of the root path parameter that specifies the root dir of the app.

See Also:

Constant Field Values

Constructor Detail

WicketFilter

public WicketFilter()

Method Detail

destroy

public void destroy()

Servlet cleanup.

Specified by:

destroy in interface javax.servlet.Filter

doFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException

See Also:

Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)

doGet

public boolean doGet(javax.servlet.http.HttpServletRequest servletRequest,
                     javax.servlet.http.HttpServletResponse servletResponse)
              throws javax.servlet.ServletException,
                     java.io.IOException

Handles servlet page requests.

Parameters:

servletRequest - Servlet request object

servletResponse - Servlet response object

Returns:

true if the request was handled by wicket, false otherwise

Throws:

javax.servlet.ServletException - Thrown if something goes wrong during request handling

java.io.IOException

getFilterConfig

public javax.servlet.FilterConfig getFilterConfig()

Returns:

The filter config of this WicketFilter

getRelativePath

public java.lang.String getRelativePath(javax.servlet.http.HttpServletRequest request)

Returns a relative path from an HttpServletRequest Use this to resolve a Wicket request.

Parameters:

request -

Returns:

Path requested, minus query string, context path, and filterPath. Relative, no leading '/'.

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

See Also:

Filter.init(javax.servlet.FilterConfig)

isPortletContextAvailable

protected boolean isPortletContextAvailable(javax.servlet.FilterConfig config)
                                     throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

newWicketFilterPortletContext

protected WicketFilterPortletContext newWicketFilterPortletContext()

createRequestContext

protected void createRequestContext(WebRequest request,
                                    WebResponse response)

getApplicationFactory

protected IWebApplicationFactory getApplicationFactory()

Creates the web application factory instance. If no APP_FACT_PARAM is specified in web.xml ContextParamWebApplicationFactory will be used by default.

Returns:

application factory instance

See Also:

ContextParamWebApplicationFactory

getClassLoader

protected java.lang.ClassLoader getClassLoader()

Returns:

The class loader

getFilterPath

protected java.lang.String getFilterPath(javax.servlet.http.HttpServletRequest request)