org.restafarian.core.filters
Class FilterBase

java.lang.Object
  org.restafarian.core.filters.FilterBase

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

SecurityFilter

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

This is the base class for all servlet filters.

Field Summary

protected javax.servlet.ServletContext	context
protected org.apache.commons.logging.Log	log

Constructor Summary

FilterBase()

Method Summary

void	destroy() Filter destroy method.
abstract void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain) Filter "do filter" method.
void	init(javax.servlet.FilterConfig config) Filter init method.
protected void	sendError(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, int errorCode, java.lang.String errorMessage) Sends the HTTP error code and message, and logs the code and message if enabled.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected javax.servlet.ServletContext context

log

protected org.apache.commons.logging.Log log

Constructor Detail

FilterBase

public FilterBase()

Method Detail

doFilter

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

Filter "do filter" method.

Specified by:

doFilter in interface javax.servlet.Filter

Parameters:

req - the servlet request object

res - the servlet response object

chain - the filter chain object

Throws:

javax.servlet.ServletException

java.io.IOException

sendError

protected void sendError(javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res,
                         int errorCode,
                         java.lang.String errorMessage)
                  throws java.io.IOException

Sends the HTTP error code and message, and logs the code and message if enabled.

Parameters:

req - the HttpServletRequest object

res - the HttpServletResponse object

errorCode - the error code to send

errorMessage - the error message to send

Throws:

java.io.IOException

init

public void init(javax.servlet.FilterConfig config)

Filter init method.

Specified by:

init in interface javax.servlet.Filter

Parameters:

config - the FilterConfig object

destroy

public void destroy()

Filter destroy method.

Specified by:

destroy in interface javax.servlet.Filter