edu.cornell.mannlib.vitro.webapp.search.controller

Class IndexController

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

edu.cornell.mannlib.vitro.webapp.search.controller.IndexController

All Implemented Interfaces:

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

@WebServlet(name="IndexController",
            urlPatterns="/SearchIndex")
public class IndexController
extends FreemarkerHttpServlet

Accepts requests to display the current status of the search index, or to initiate a rebuild. A DISPLAY or REBUILD request is handled like any other FreemarkerHttpServlet. A STATUS is an AJAX request, we override doGet() so we can format the template without enclosing it in a body template. When initialized, this servlet adds a listener to the SearchIndexer, so it can maintain a history of activity. This will provide the contents of the display.

See Also:

Serialized Form

Nested Class Summary

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

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 RequestedAction	REQUIRED_ACTIONS

Fields inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

BODY_TEMPLATE_TYPE, 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
IndexController()

Method Summary

Modifier and Type	Method and Description
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) doGet does nothing.
protected String	getTitle(String siteName, VitroRequest vreq)
void	init()
protected ResponseValues	processRequest(VitroRequest vreq)
protected AuthorizationRequest	requiredActions(VitroRequest vreq) By default, a page requires authorization for no actions.
static void	setHistory(IndexHistory history) Called by SearchIndexerSetup to provide a history that dates from startup, not just from servlet load time.

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

doException, doForward, doPost, doRdf, doRedirect, doResponse, doTemplate, getBeansWrapper, getDisplayModelMenu, getFreemarkerComponentsForJsp, getPageTemplateName, getPageTemplateValues, getThemeDir, handleException, processTemplate, processTemplateToString, wrap, wrap, write, writePage, writeTemplate, writeTemplate

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, log, log

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_ACTIONS

public static final RequestedAction REQUIRED_ACTIONS

Constructor Detail

IndexController

public IndexController()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

setHistory

public static void setHistory(IndexHistory history)

Called by SearchIndexerSetup to provide a history that dates from startup, not just from servlet load time.

doGet

public void doGet(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.HttpServletResponse resp)
           throws IOException,
                  javax.servlet.ServletException

Description copied from class: VitroHttpServlet

doGet does nothing.

Overrides:

doGet in class FreemarkerHttpServlet

Throws:

IOException

javax.servlet.ServletException

getTitle

protected String getTitle(String siteName,
                          VitroRequest vreq)

Overrides:

getTitle in class FreemarkerHttpServlet

requiredActions

protected AuthorizationRequest requiredActions(VitroRequest vreq)

Description copied from class: FreemarkerHttpServlet

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.

Overrides:

requiredActions in class FreemarkerHttpServlet

processRequest

protected ResponseValues processRequest(VitroRequest vreq)

Overrides:

processRequest in class FreemarkerHttpServlet