Package org.intermine.webservice.server.core

Class WebServiceServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.intermine.webservice.server.core.WebServiceServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

AvailableListsServlet, BGPropertiesServlet, ConfigurableWebServiceServlet, DeregistrationTokenServlet, FacetServlet, IdResolutionServlet, JaccardIndexServlet, ListRenameServlet, ListShareServlet, ListSharingInvitationServlet, ListUpgradingServlet, NewUserServlet, PermaTokensServlet, QueryUploadServlet, QuickSearchServlet, RestfulServlet, TemplateResultServlet, TemplateToListServlet, TemplateUploadServlet, WhoAmIServlet

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

A servlet which can be easily configured to define how to route requests, using standard RESTful semantics.

Author:

Alex Kalderimis

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebServiceServlet.Method

Field Summary

Fields

Modifier and Type	Field	Description
protected InterMineAPI	api

Constructor Summary

Constructors

Constructor	Description
WebServiceServlet()	Constructor

Method Summary

Modifier and Type	Method	Description
void	doDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected abstract WebService	getService(WebServiceServlet.Method method)	Implement this to route requests.
protected void	respond(WebServiceServlet.Method method, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Respond to a request.

Methods inherited from class javax.servlet.http.HttpServlet

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

api

protected final InterMineAPI api

Constructor Detail

WebServiceServlet

public WebServiceServlet()

Constructor

Method Detail

respond

protected void respond(WebServiceServlet.Method method,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
                       java.io.IOException

Respond to a request.

Parameters:

method - The current method.

request - The request.

response - The response.

Throws:

javax.servlet.ServletException - Well it could I suppose.

java.io.IOException - Entirely possible really.

getService

protected abstract WebService getService(WebServiceServlet.Method method)
                                  throws NoServiceException

Implement this to route requests.

Parameters:

method - The current method.

Returns:

A webservice handler.

Throws:

NoServiceException - If no handler matches the method.

doGet

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

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

doPost

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

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

doPut

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

Overrides:

doPut in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

doDelete

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

Overrides:

doDelete in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException