org.tiogasolutions.lib.servlet.template

Class WebSiteTemplate

java.lang.Object

org.tiogasolutions.lib.servlet.template.WebSiteTemplate

All Implemented Interfaces:

javax.servlet.Filter

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

This class takes the requested page and processes it through the container. The resulting content is then stored in a request attribute (see PAGE_DATA and PrintPageContentTag while the request is frowarded to the specified JSP file which will then take responsibility for re-injecting the page data.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTUAL_QUERY_STRING
static java.lang.String	ACTUAL_REQUEST_DIR
static java.lang.String	ACTUAL_REQUEST_URI
protected javax.servlet.FilterConfig	filterConfig
static java.lang.String	PAGE_DATA The parameter name for the data being edited.
protected java.lang.String	templateFileName The file name of the template to be used.

Constructor Summary

Constructors

Constructor and Description
WebSiteTemplate()

Method Summary

Modifier and Type	Method and Description
protected boolean	canApplyDecorators(javax.servlet.http.HttpServletRequest request) This implementation always assumes we can apply the decorators
void	destroy()
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp, javax.servlet.FilterChain chain)
protected java.lang.String	getFileName(javax.servlet.http.HttpServletRequest request)
protected javax.servlet.ServletContext	getServletContext()
void	init(javax.servlet.FilterConfig newConfig)
protected void	injectAttributes(javax.servlet.http.HttpServletRequest request) The default implementation does not inject any new attributes
protected boolean	redirectResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This implementation always assumes we do not need to redirect

Methods inherited from class java.lang.Object

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

Field Detail

ACTUAL_REQUEST_URI

public static final java.lang.String ACTUAL_REQUEST_URI

See Also:

Constant Field Values

ACTUAL_REQUEST_DIR

public static final java.lang.String ACTUAL_REQUEST_DIR

See Also:

Constant Field Values

ACTUAL_QUERY_STRING

public static final java.lang.String ACTUAL_QUERY_STRING

See Also:

Constant Field Values

PAGE_DATA

public static final java.lang.String PAGE_DATA

The parameter name for the data being edited. This data differs from PAGE_CONTENT in that it is the raw content of the file, unprocessed by the Servlet Container

See Also:

Constant Field Values

filterConfig

protected javax.servlet.FilterConfig filterConfig

templateFileName

protected java.lang.String templateFileName

The file name of the template to be used.

Constructor Detail

WebSiteTemplate

public WebSiteTemplate()

Method Detail

init

public void init(javax.servlet.FilterConfig newConfig)

Specified by:

init in interface javax.servlet.Filter

getServletContext

protected javax.servlet.ServletContext getServletContext()

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

getFileName

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

redirectResponse

protected boolean redirectResponse(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws java.io.IOException

This implementation always assumes we do not need to redirect

Parameters:

request - The HttpServletRequest used to fetch attributes and parameters from.

response - The HttpServletResponse with which redirects are sent.

Returns:

true if the response was redirected in which case the doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) should return without futher processing.

Throws:

java.io.IOException - on exception

canApplyDecorators

protected boolean canApplyDecorators(javax.servlet.http.HttpServletRequest request)

This implementation always assumes we can apply the decorators

Parameters:

request - The HttpServletRequest used to fetch attributes and parameters from.

Returns:

true if the decorators can be applied.

injectAttributes

protected void injectAttributes(javax.servlet.http.HttpServletRequest request)
                         throws java.io.IOException

The default implementation does not inject any new attributes

Parameters:

request - The HttpServletRequest into which attributes will be injected

Throws:

java.io.IOException - on exception

doFilter

public void doFilter(javax.servlet.ServletRequest req,
                     javax.servlet.ServletResponse resp,
                     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