1. /*
  2. * The Apache Software License, Version 1.1
  3. *
  4. * Copyright (c) 1999 The Apache Software Foundation. All rights
  5. * reserved.
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions
  9. * are met:
  10. *
  11. * 1. Redistributions of source code must retain the above copyright
  12. * notice, this list of conditions and the following disclaimer.
  13. *
  14. * 2. Redistributions in binary form must reproduce the above copyright
  15. * notice, this list of conditions and the following disclaimer in
  16. * the documentation and/or other materials provided with the
  17. * distribution.
  18. *
  19. * 3. The end-user documentation included with the redistribution, if
  20. * any, must include the following acknowlegement:
  21. * "This product includes software developed by the
  22. * Apache Software Foundation (http://www.apache.org/)."
  23. * Alternately, this acknowlegement may appear in the software itself,
  24. * if and wherever such third-party acknowlegements normally appear.
  25. *
  26. * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
  27. * Foundation" must not be used to endorse or promote products derived
  28. * from this software without prior written permission. For written
  29. * permission, please contact apache@apache.org.
  30. *
  31. * 5. Products derived from this software may not be called "Apache"
  32. * nor may "Apache" appear in their names without prior written
  33. * permission of the Apache Group.
  34. *
  35. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38. * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42. * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46. * SUCH DAMAGE.
  47. * ====================================================================
  48. *
  49. * This software consists of voluntary contributions made by many
  50. * individuals on behalf of the Apache Software Foundation. For more
  51. * information on the Apache Software Foundation, please see
  52. * <http://www.apache.org/>.
  53. *
  54. * ====================================================================
  55. *
  56. * This source code implements specifications defined by the Java
  57. * Community Process. In order to remain compliant with the specification
  58. * DO NOT add / change / or delete method signatures!
  59. */
  60. package javax.servlet;
  61. import java.util.Iterator;
  62. import java.util.Enumeration;
  63. /**
  64. *
  65. * A filter configuration object used by a servlet container
  66. * used to pass information to a filter during initialization.
  67. * @see Filter
  68. * @since Servlet 2.3
  69. *
  70. */
  71. public interface FilterConfig {
  72. /**
  73. * Returns the filter-name of this filter as defined in the deployment descriptor.
  74. */
  75. public String getFilterName();
  76. /**
  77. * Returns a reference to the {@link ServletContext} in which the caller
  78. * is executing.
  79. *
  80. *
  81. * @return a {@link ServletContext} object, used
  82. * by the caller to interact with its servlet
  83. * container
  84. *
  85. * @see ServletContext
  86. *
  87. */
  88. public ServletContext getServletContext();
  89. /**
  90. * Returns a <code>String</code> containing the value of the
  91. * named initialization parameter, or <code>null</code> if
  92. * the parameter does not exist.
  93. *
  94. * @param name a <code>String</code> specifying the name
  95. * of the initialization parameter
  96. *
  97. * @return a <code>String</code> containing the value
  98. * of the initialization parameter
  99. *
  100. */
  101. public String getInitParameter(String name);
  102. /**
  103. * Returns the names of the servlet's initialization parameters
  104. * as an <code>Enumeration</code> of <code>String</code> objects,
  105. * or an empty <code>Enumeration</code> if the servlet has
  106. * no initialization parameters.
  107. *
  108. * @return an <code>Enumeration</code> of <code>String</code>
  109. * objects containing the names of the servlet's
  110. * initialization parameters
  111. *
  112. *
  113. *
  114. */
  115. public Enumeration getInitParameterNames();
  116. }