edu.cornell.mannlib.vitro.webapp.controller.freemarker

Class FreemarkerHttpServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

All Implemented Interfaces:

MultipartRequestWrapper.ParsingStrategy, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

AboutController, AdminLoginController, BaseSiteAdminController, BrowseController, ContactFormController, ContactMailController, DeleteIndividualController, DeletePropertyController, DumpRestoreController, DumpTestController, EditRequestDispatchController, FakeExternalAuthController, FileUploadController, FreemarkerComponentGenerator, GadgetController, HomePageController, ImageUploadController, IndexController, IndividualController, IndividualListController, ListClassGroupsController, ListDatatypePropertiesController, ListFauxPropertiesController, ListPropertyGroupsController, ListPropertyWebappsController, ListVClassWebappsController, ManageLabelsForIndividualController, ManageProxiesController, PageController, PagedSearchController, PostEditCleanupController, ProcessRdfFormController, RestrictLoginsController, RevisionInfoController, SamplesController, SearchHelpController, SearchServiceController, ShowAuthController, ShowBackgroundThreadsController, ShowClassHierarchyController, ShowConfiguration, ShowDataPropertyHierarchyController, ShowObjectPropertyHierarchyController, ShowSourcesController, SimpleReasonerRecomputeController, SparqlQueryController, StartupStatusController, StaticPageController, TermsOfUseController, TestController, UserAccountsAdminController, UserAccountsUserController, ViewLabelsServlet

public class FreemarkerHttpServlet
extends VitroHttpServlet

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FreemarkerHttpServlet.Template

Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

VitroHttpServlet.PickListSorter

Field Summary

Fields

Modifier and Type	Field and Description
static String	BODY_TEMPLATE_TYPE
static String	PAGE_TEMPLATE_TYPE

Fields inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

HTML_MIMETYPE, JSON_LD_MIMETYPE, JSON_MIMETYPE, N3_MIMETYPE, publicDateFormat, RDFXML_MIMETYPE, TTL_MIMETYPE, XHTML_MIMETYPE

Constructor Summary

Constructors

Constructor and Description
FreemarkerHttpServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doException(VitroRequest vreq, javax.servlet.http.HttpServletResponse response, ResponseValues values)
protected void	doForward(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ResponseValues values)
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) doGet does nothing.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) doPost does the same thing as the doGet method
protected void	doRdf(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ResponseValues values)
protected void	doRedirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ResponseValues values)
protected void	doResponse(VitroRequest vreq, javax.servlet.http.HttpServletResponse response, ResponseValues values)
protected void	doTemplate(VitroRequest vreq, javax.servlet.http.HttpServletResponse response, ResponseValues values)
protected freemarker.ext.beans.BeansWrapper	getBeansWrapper(int exposureLevel)
protected MainMenu	getDisplayModelMenu(VitroRequest vreq)
static void	getFreemarkerComponentsForJsp(javax.servlet.http.HttpServletRequest request)
protected String	getPageTemplateName()
protected Map<String,Object>	getPageTemplateValues(VitroRequest vreq) Add variables that are needed to generate the page template (they will also be accessible to the body template).
String	getThemeDir(ApplicationBean appBean)
protected String	getTitle(String siteName, VitroRequest vreq)
protected void	handleException(VitroRequest vreq, javax.servlet.http.HttpServletResponse response, Throwable t) In case of a processing error, display an error page.
protected ResponseValues	processRequest(VitroRequest vreq)
protected StringWriter	processTemplate(String templateName, Map<String,Object> map, javax.servlet.http.HttpServletRequest request)
protected String	processTemplateToString(String templateName, Map<String,Object> map, javax.servlet.http.HttpServletRequest request)
protected AuthorizationRequest	requiredActions(VitroRequest vreq) By default, a page requires authorization for no actions.
protected freemarker.template.TemplateModel	wrap(Object obj, freemarker.ext.beans.BeansWrapper wrapper)
protected freemarker.template.TemplateModel	wrap(Object obj, int exposureLevel)
protected void	write(StringWriter sw, javax.servlet.http.HttpServletResponse response, int statusCode)
protected void	writePage(Map<String,Object> root, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int statusCode, ResponseValues rv)
protected void	writeTemplate(String templateName, Map<String,Object> map, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	writeTemplate(String templateName, Map<String,Object> map, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int statusCode)

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

dumpRequestParameters, isAuthorizedToDisplayPage, maximumMultipartFileSize, redirectToInsufficientAuthorizationPage, redirectToLoginPage, redirectUnauthorizedRequest, service, sortForPickList, stashFileSizeException

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, 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

PAGE_TEMPLATE_TYPE

public static final String PAGE_TEMPLATE_TYPE

See Also:

Constant Field Values

BODY_TEMPLATE_TYPE

public static final String BODY_TEMPLATE_TYPE

See Also:

Constant Field Values

Constructor Detail

FreemarkerHttpServlet

public FreemarkerHttpServlet()

Method Detail

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws IOException,
                  javax.servlet.ServletException

Description copied from class: VitroHttpServlet

doGet does nothing.

Overrides:

doGet in class VitroHttpServlet

Throws:

IOException

javax.servlet.ServletException

handleException

protected void handleException(VitroRequest vreq,
                               javax.servlet.http.HttpServletResponse response,
                               Throwable t)
                        throws javax.servlet.ServletException

In case of a processing error, display an error page. To an authorized user, the page displays details of the error. Otherwise, these details are sent to the site administrator.

Throws:

javax.servlet.ServletException

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   IOException

Description copied from class: VitroHttpServlet

doPost does the same thing as the doGet method

Overrides:

doPost in class VitroHttpServlet

Throws:

javax.servlet.ServletException

IOException

requiredActions

protected AuthorizationRequest requiredActions(VitroRequest vreq)

By default, a page requires authorization for no actions. Subclasses that require authorization to process their page will override to return the actions that require authorization. In some cases, the choice of actions will depend on the contents of the request. NB This method can't be static, because then the superclass method gets called rather than the subclass method. For the same reason, it can't refer to a static or instance field REQUIRED_ACTIONS which is overridden in the subclass.

processRequest

protected ResponseValues processRequest(VitroRequest vreq)
                                 throws Exception

Throws:

Exception

doResponse

protected void doResponse(VitroRequest vreq,
                          javax.servlet.http.HttpServletResponse response,
                          ResponseValues values)
                   throws TemplateProcessingHelper.TemplateProcessingException

Throws:

TemplateProcessingHelper.TemplateProcessingException

doTemplate

protected void doTemplate(VitroRequest vreq,
                          javax.servlet.http.HttpServletResponse response,
                          ResponseValues values)
                   throws TemplateProcessingHelper.TemplateProcessingException

Throws:

TemplateProcessingHelper.TemplateProcessingException

doRedirect

protected void doRedirect(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          ResponseValues values)
                   throws javax.servlet.ServletException,
                          IOException

Throws:

javax.servlet.ServletException

IOException

doForward

protected void doForward(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         ResponseValues values)
                  throws javax.servlet.ServletException,
                         IOException

Throws:

javax.servlet.ServletException

IOException

doRdf

protected void doRdf(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     ResponseValues values)
              throws IOException

Throws:

IOException

doException

protected void doException(VitroRequest vreq,
                           javax.servlet.http.HttpServletResponse response,
                           ResponseValues values)
                    throws TemplateProcessingHelper.TemplateProcessingException

Throws:

TemplateProcessingHelper.TemplateProcessingException

getThemeDir

public String getThemeDir(ApplicationBean appBean)

wrap

protected freemarker.template.TemplateModel wrap(Object obj,
                                                 int exposureLevel)
                                          throws freemarker.template.TemplateModelException

Throws:

freemarker.template.TemplateModelException

wrap

protected freemarker.template.TemplateModel wrap(Object obj,
                                                 freemarker.ext.beans.BeansWrapper wrapper)
                                          throws freemarker.template.TemplateModelException

Throws:

freemarker.template.TemplateModelException

getBeansWrapper

protected freemarker.ext.beans.BeansWrapper getBeansWrapper(int exposureLevel)

getPageTemplateValues

protected Map<String,Object> getPageTemplateValues(VitroRequest vreq)

Add variables that are needed to generate the page template (they will also be accessible to the body template). These are specific to the request, so are not defined as shared variables in the Configuration. (Though we could reset them like other shared variables. These variables are not needed outside the page and body templates, however. If they are needed elsewhere, add to shared variables.

getDisplayModelMenu

protected MainMenu getDisplayModelMenu(VitroRequest vreq)

getTitle

protected String getTitle(String siteName,
                          VitroRequest vreq)

processTemplate

protected StringWriter processTemplate(String templateName,
                                       Map<String,Object> map,
                                       javax.servlet.http.HttpServletRequest request)
                                throws TemplateProcessingHelper.TemplateProcessingException

Throws:

TemplateProcessingHelper.TemplateProcessingException

processTemplateToString

protected String processTemplateToString(String templateName,
                                         Map<String,Object> map,
                                         javax.servlet.http.HttpServletRequest request)
                                  throws TemplateProcessingHelper.TemplateProcessingException

Throws:

TemplateProcessingHelper.TemplateProcessingException

writePage

protected void writePage(Map<String,Object> root,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         int statusCode,
                         ResponseValues rv)
                  throws TemplateProcessingHelper.TemplateProcessingException

Throws:

TemplateProcessingHelper.TemplateProcessingException

writeTemplate

protected void writeTemplate(String templateName,
                             Map<String,Object> map,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws TemplateProcessingHelper.TemplateProcessingException

Throws:

TemplateProcessingHelper.TemplateProcessingException

writeTemplate

protected void writeTemplate(String templateName,
                             Map<String,Object> map,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             int statusCode)
                      throws TemplateProcessingHelper.TemplateProcessingException

Throws:

TemplateProcessingHelper.TemplateProcessingException

write

protected void write(StringWriter sw,
                     javax.servlet.http.HttpServletResponse response,
                     int statusCode)

getPageTemplateName

protected String getPageTemplateName()

getFreemarkerComponentsForJsp

public static void getFreemarkerComponentsForJsp(javax.servlet.http.HttpServletRequest request)