01: /*
02: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: *
23: * Free Software Foundation, Inc.
24: * 59 Temple Place, Suite 330
25: * Boston, MA 02111-1307 USA
26: *
27: * @author Scott Ferguson
28: */
29:
30: package javax.servlet;
31:
32: import java.io.IOException;
33:
34: /**
35: * Filters the request or response to a servlet. Filters will
36: * typically call the next filter in the chain, eventually reaching
37: * the servlet at the bottom.
38: *
39: * @since Servlet 2.3
40: */
41: public interface Filter {
42: /**
43: * Initialize the filter.
44: */
45: public void init(FilterConfig filterConfig) throws ServletException;
46:
47: /**
48: * doFilter performs the actual work of a filter, either modifying
49: * the request or the response. It will typically call the
50: * chain.doFilter() to invoke the next filter in the chain.
51: *
52: * @param request the servlet request
53: * @param response the servlet response
54: * @param chain the next filter in the chain
55: */
56: public void doFilter(ServletRequest request,
57: ServletResponse response, FilterChain chain)
58: throws ServletException, IOException;
59:
60: /**
61: * Cleanup the filter.
62: */
63: public void destroy();
64: }
|