01: /*
02: * Copyright (c) 1998-2003 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: * Free SoftwareFoundation, Inc.
23: * 59 Temple Place, Suite 330
24: * Boston, MA 02111-1307 USA
25: *
26: * @author Scott Ferguson
27: *
28: * $Id: FilterConfig.java,v 1.2 2004/09/29 00:12:46 cvs Exp $
29: */
30:
31: package javax.servlet;
32:
33: import java.util.Enumeration;
34:
35: /**
36: * Configuration for a filter. The container will fill the
37: * FilterConfig with the init parameters before passing it to
38: * the filter.
39: *
40: * <p>Filter configuration in the web.xml looks like:
41: * <pre><code>
42: * <filter filter-name='myservlet'
43: * filter-class='test.MyServlet'>
44: * <init-param param1='value1'/>
45: * <init-param param2='value2'/>
46: * </filter>
47: * </code></pre>
48: *
49: * @since Servlet 2.3
50: */
51: public interface FilterConfig {
52: /**
53: * Returns the name of the filter.
54: */
55: public String getFilterName();
56:
57: /**
58: * Returns an initialization parameter. Initialization parameters
59: * are defined in the filter configuration (in resin.conf).
60: *
61: * @param name of the parameter
62: * @return the init parameter value
63: */
64: public String getInitParameter(String name);
65:
66: /**
67: * Returns an enumeration of the init-parameter names
68: */
69: public Enumeration getInitParameterNames();
70:
71: /**
72: * Returns the ServletContext for the servlet or filter.
73: */
74: public ServletContext getServletContext();
75: }
|