com.itranswarp.jxrest

Class RestApiFilter

java.lang.Object

com.itranswarp.jxrest.RestApiFilter

All Implemented Interfaces:

javax.servlet.Filter

public class RestApiFilter
extends Object
implements javax.servlet.Filter

A REST API filter to handle REST API calls.

Author:

Michael Liao

Constructor Summary

Constructors

Constructor and Description
RestApiFilter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RestApiFilter

public RestApiFilter()

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(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter