com.itranswarp.jxrest

Class RestApiServlet

java.lang.Object

javax.servlet.GenericServlet

com.itranswarp.jxrest.RestApiServlet

All Implemented Interfaces:

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

public class RestApiServlet
extends javax.servlet.GenericServlet

A REST API filter to handle REST API calls.

Author:

Michael Liao

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestApiServlet()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	init()
void	service(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
void	setRestApiHandler(RestApiHandler handler) Set RestApiHandler to handle REST API.
void	setUrlPrefix(String prefix) Set URL prefix.

Methods inherited from class javax.servlet.GenericServlet

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

Constructor Detail

RestApiServlet

public RestApiServlet()

Method Detail

setRestApiHandler

public void setRestApiHandler(RestApiHandler handler)

Set RestApiHandler to handle REST API.

Parameters:

handler - Instance of RestApiHandler.

setUrlPrefix

public void setUrlPrefix(String prefix)

Set URL prefix. e.g. "/api/v1".

Parameters:

prefix - Prefix string, or null if no prefix.

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

service

public void service(javax.servlet.ServletRequest request,
                    javax.servlet.ServletResponse response)
             throws javax.servlet.ServletException,
                    IOException

Specified by:

service in interface javax.servlet.Servlet

Specified by:

service in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

IOException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet