org.alfresco.web.app.servlet

Class BaseTemplateContentServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.alfresco.web.app.servlet.BaseServlet

org.alfresco.web.app.servlet.BaseTemplateContentServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

GuestTemplateContentServlet, TemplateContentServlet

public abstract class BaseTemplateContentServlet
extends BaseServlet

Base class for the template content servlets. Provides common processing for the request.

Author:

Kevin Roast, gavinc

See Also:

TemplateContentServlet, GuestTemplateContentServlet, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseTemplateContentServlet.URLHelper Helper to return context path for generating urls

Nested classes/interfaces inherited from class org.alfresco.web.app.servlet.BaseServlet

BaseServlet.PathRefInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.service.cmr.repository.TemplateImageResolver	imageResolver Template Image resolver helper

Fields inherited from class org.alfresco.web.app.servlet.BaseServlet

FACES_SERVLET, KEY_ROOT_PATH, KEY_STORE

Constructor Summary

Constructors

Constructor and Description
BaseTemplateContentServlet()

Method Summary

Modifier and Type	Method and Description
protected abstract Map<String,Object>	buildModel(org.alfresco.service.ServiceRegistry services, javax.servlet.http.HttpServletRequest req, org.alfresco.service.cmr.repository.NodeRef templateRef) Builds the FreeMarker model
protected abstract org.apache.commons.logging.Log	getLogger() Gets the logger to use for this request.
protected void	processTemplateRequest(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean redirectToLogin) Processes the template request using the current context i.e.

Methods inherited from class org.alfresco.web.app.servlet.BaseServlet

checkAccess, getServiceRegistry, redirectToLoginPage, redirectToLoginPage, resolveNamePath, resolveWebDAVPath, resolveWebDAVPath, resolveWebDAVPath, resolveWebDAVPath, servletAuthenticate, servletAuthenticate, setNoCacheHeaders, validRedirectJSP

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

imageResolver

protected org.alfresco.service.cmr.repository.TemplateImageResolver imageResolver

Template Image resolver helper

Constructor Detail

BaseTemplateContentServlet

public BaseTemplateContentServlet()

Method Detail

getLogger

protected abstract org.apache.commons.logging.Log getLogger()

Gets the logger to use for this request.

This will show all debug entries from this class as though they came from the subclass.

Returns:

The logger

buildModel

protected abstract Map<String,Object> buildModel(org.alfresco.service.ServiceRegistry services,
                                                 javax.servlet.http.HttpServletRequest req,
                                                 org.alfresco.service.cmr.repository.NodeRef templateRef)

Builds the FreeMarker model

Parameters:

services - Service Registry instance

req - Http request

templateRef - The node ref of the template to process

Returns:

The FreeMarker model

processTemplateRequest

protected void processTemplateRequest(javax.servlet.http.HttpServletRequest req,
                                      javax.servlet.http.HttpServletResponse res,
                                      boolean redirectToLogin)
                               throws javax.servlet.ServletException,
                                      IOException

Processes the template request using the current context i.e. no authentication checks are made, it is presumed they have already been done.

Parameters:

req - The HTTP request

res - The HTTP response

redirectToLogin - Flag to determine whether to redirect to the login page if the user does not have the correct permissions

Throws:

javax.servlet.ServletException

IOException