Package edu.cornell.mannlib.vitro.webapp.controller.api

Class VitroApiServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

edu.cornell.mannlib.vitro.webapp.controller.api.VitroApiServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

IndividualListRdfController, SparqlQueryApiController, SparqlUpdateApiController

public class VitroApiServlet
extends javax.servlet.http.HttpServlet

The base class for Vitro servlets that implement the API. We don't want the API servlets to extend VitroHttpServlet, because we want the following behavior:

• No redirecting to the login page if not authorized
• No redirecting to the home page on insufficient authorization
• GET and POST requests are not necessarily equivalent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	VitroApiServlet.AuthException
protected static class	VitroApiServlet.BadParameterException

Constructor Summary

Constructors

Constructor	Description
VitroApiServlet()

Method Summary

Modifier and Type	Method	Description
protected void	confirmAuthorization(javax.servlet.http.HttpServletRequest req, AuthorizationRequest requiredActions)	If they have not provided an email/password combo that will authorize them for this action, throw an AuthException.
protected String	parseAcceptHeader(javax.servlet.http.HttpServletRequest req, Collection<String> availableTypes, String defaultType)
protected void	sendShortResponse(int statusCode, String message, Throwable e, javax.servlet.http.HttpServletResponse resp)
protected void	sendShortResponse(int statusCode, String message, javax.servlet.http.HttpServletResponse resp)

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

Constructor Detail

VitroApiServlet

public VitroApiServlet()

Method Detail

confirmAuthorization

protected void confirmAuthorization(javax.servlet.http.HttpServletRequest req,
                                    AuthorizationRequest requiredActions)
                             throws VitroApiServlet.AuthException

If they have not provided an email/password combo that will authorize them for this action, throw an AuthException.

Throws:

VitroApiServlet.AuthException

parseAcceptHeader

protected String parseAcceptHeader(javax.servlet.http.HttpServletRequest req,
                                   Collection<String> availableTypes,
                                   String defaultType)
                            throws AcceptHeaderParsingException,
                                   NotAcceptableException

Throws:

AcceptHeaderParsingException

NotAcceptableException

sendShortResponse

protected void sendShortResponse(int statusCode,
                                 String message,
                                 javax.servlet.http.HttpServletResponse resp)
                          throws IOException

Throws:

IOException

sendShortResponse

protected void sendShortResponse(int statusCode,
                                 String message,
                                 Throwable e,
                                 javax.servlet.http.HttpServletResponse resp)
                          throws IOException

Throws:

IOException