Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.util
Class JiveServletFilter

java.lang.Object
  extended by com.jivesoftware.util.JiveServletFilter
All Implemented Interfaces:
javax.servlet.Filter
Direct Known Subclasses:
JiveAdminActionFilter, MaintenanceFilter, SetCharacterEncodingFilter, SetRequestCharacterEncodingFilter, SetResponseCharacterEncodingFilter

public abstract class JiveServletFilter
extends java.lang.Object
implements javax.servlet.Filter

A base Jive servlet filter class. All Jive filters *should* extend this class but are not required to. Extending this class provides your filter with automatic support for older Servlet 2.3 implementations (like WebLogic 6.1). Those implementations will look for the getFilterConfig() and setFilterConfig(String) methods. Failing to implement those classes will result in a AbstractMethodError at runtime.


Field Summary
protected  javax.servlet.FilterConfig filterConfig
           
 
Constructor Summary
JiveServletFilter()
           
 
Method Summary
 void destroy()
           
abstract  void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
           
 javax.servlet.FilterConfig getFilterConfig()
           
 void init(javax.servlet.FilterConfig filterConfig)
           
 void setFilterConfig(javax.servlet.FilterConfig filterConfig)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

filterConfig

protected javax.servlet.FilterConfig filterConfig
Constructor Detail

JiveServletFilter

public JiveServletFilter()
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

doFilter

public abstract void doFilter(javax.servlet.ServletRequest request,
                              javax.servlet.ServletResponse response,
                              javax.servlet.FilterChain chain)
                       throws java.io.IOException,
                              javax.servlet.ServletException
Specified by:
doFilter in interface javax.servlet.Filter
Throws:
java.io.IOException
javax.servlet.ServletException

destroy

public void destroy()
Specified by:
destroy in interface javax.servlet.Filter

getFilterConfig

public javax.servlet.FilterConfig getFilterConfig()

setFilterConfig

public void setFilterConfig(javax.servlet.FilterConfig filterConfig)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.