io.katharsis.servlet

Class KatharsisFilter

java.lang.Object

io.katharsis.servlet.KatharsisFilter

All Implemented Interfaces:

javax.servlet.Filter

public class KatharsisFilter
extends Object
implements javax.servlet.Filter

Servlet filter class to integrate with Katharsis-core.

Child class can override createKatharsisInvoker() method with proper ObjectMapper, ResourceRegistry and RequestDispatcher.

If you want to deploy a filter, type of this, in a specific prefix path, then you should configure an init-parameter, "filterBasePath", with the prefix.

In Spring Framework based web application, you might want to inject a KatharsisInvoker bean using #setKatharsisInvoker(KatharsisInvoker) method if you can use org.springframework.web.filter.DelegatingFilterProxy.

Constructor Summary

Constructors

Constructor and Description
KatharsisFilter()

Method Summary

Modifier and Type	Method and Description
void	addModule(Module module)
protected KatharsisInvokerV2	createKatharsisInvoker()
protected KatharsisInvokerContext	createKatharsisInvokerContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	destroy()
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain)
String	getFilterBasePath()
KatharsisInvokerV2	getKatharsisInvoker()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
QuerySpecDeserializer	getQuerySpecDeserializer()
protected javax.servlet.ServletContext	getServletContext()
void	init(javax.servlet.FilterConfig filterConfig)
void	setDefaultPageLimit(Long defaultPageLimit)
void	setFilterBasePath(String filterBasePath)
void	setKatharsisInvoker(KatharsisInvokerV2 katharsisInvoker)

Methods inherited from class java.lang.Object

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

Constructor Detail

KatharsisFilter

public KatharsisFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

doFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

createKatharsisInvoker

protected KatharsisInvokerV2 createKatharsisInvoker()

getKatharsisInvoker

public KatharsisInvokerV2 getKatharsisInvoker()

setKatharsisInvoker

public void setKatharsisInvoker(KatharsisInvokerV2 katharsisInvoker)

addModule

public void addModule(Module module)

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

setDefaultPageLimit

public void setDefaultPageLimit(Long defaultPageLimit)

getQuerySpecDeserializer

public QuerySpecDeserializer getQuerySpecDeserializer()

getFilterBasePath

public String getFilterBasePath()

setFilterBasePath

public void setFilterBasePath(String filterBasePath)

getServletContext

protected javax.servlet.ServletContext getServletContext()

createKatharsisInvokerContext

protected KatharsisInvokerContext createKatharsisInvokerContext(javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response)