edu.cornell.mannlib.vitro.webapp.controller.ajax

Class VitroAjaxController

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

edu.cornell.mannlib.vitro.webapp.controller.ajax.VitroAjaxController

All Implemented Interfaces:

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

Direct Known Subclasses:

AutocompleteController, DataAutocompleteController, DeveloperSettingsServlet, ManageProxiesAjaxController, PrimitiveDelete, PrimitiveRdfEdit, ReorderController, SparqlQueryAjaxController, UserAccountsAjaxController

public abstract class VitroAjaxController
extends javax.servlet.http.HttpServlet

A base class for servlets that handle AJAX requests.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VitroAjaxController()

Method Summary

Modifier and Type	Method and Description
protected void	doError(javax.servlet.http.HttpServletResponse response, String errorMsg, int httpstatus)
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Sub-classes should not override this.
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Sub-classes should not override this.
protected abstract void	doRequest(VitroRequest vreq, javax.servlet.http.HttpServletResponse resp) Sub-classes must implement this method to handle both GET and POST requests.
protected AuthorizationRequest	requiredActions(VitroRequest vreq) By default, a controller requires authorization for no actions.
protected void	writeTemplate(String templateName, Map<String,Object> map, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse response) Process data through a Freemarker template and output the result.

Methods inherited from class javax.servlet.http.HttpServlet

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

Constructor Detail

VitroAjaxController

public VitroAjaxController()

Method Detail

doRequest

protected abstract void doRequest(VitroRequest vreq,
                                  javax.servlet.http.HttpServletResponse resp)
                           throws javax.servlet.ServletException,
                                  IOException

Sub-classes must implement this method to handle both GET and POST requests.

Throws:

javax.servlet.ServletException

IOException

doGet

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

Sub-classes should not override this. Instead, implement doRequest().

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

protected final void doPost(javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse resp)
                     throws javax.servlet.ServletException,
                            IOException

Sub-classes should not override this. Instead, implement doRequest().

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

requiredActions

protected AuthorizationRequest requiredActions(VitroRequest vreq)

By default, a controller 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.

writeTemplate

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

Process data through a Freemarker template and output the result.

doError

protected void doError(javax.servlet.http.HttpServletResponse response,
                       String errorMsg,
                       int httpstatus)