lib/servlet-api/javax/servlet/FilterRegistration.java

   1 /*
   2 * Licensed to the Apache Software Foundation (ASF) under one or more
   3 * contributor license agreements.  See the NOTICE file distributed with
   4 * this work for additional information regarding copyright ownership.
   5 * The ASF licenses this file to You under the Apache License, Version 2.0
   6 * (the "License"); you may not use this file except in compliance with
   7 * the License.  You may obtain a copy of the License at
   8 *
   9 *     http://www.apache.org/licenses/LICENSE-2.0
  10 *
  11 * Unless required by applicable law or agreed to in writing, software
  12 * distributed under the License is distributed on an "AS IS" BASIS,
  13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 * See the License for the specific language governing permissions and
  15 * limitations under the License.
  16 */
  17 package javax.servlet;
  18
  19 import java.util.Collection;
  20 import java.util.EnumSet;
  21
  22 /**
  23  * @since Servlet 3.0
  24  * TODO SERVLET3 - Add comments
  25  */
  26 public interface FilterRegistration extends Registration {
  27
  28     /**
  29      *
  30      * @param dispatcherTypes
  31      * @param isMatchAfter
  32      * @param servletNames
  33      * @throws IllegalArgumentException
  34      * @throws IllegalStateException
  35      */
  36     public void addMappingForServletNames(
  37             EnumSet<DispatcherType> dispatcherTypes,
  38             boolean isMatchAfter, String... servletNames);
  39     /**
  40      *
  41      * @return TODO
  42      */
  43     public Collection<String> getServletNameMappings();
  44
  45     /**
  46      *
  47      * @param dispatcherTypes
  48      * @param isMatchAfter
  49      * @param urlPatterns
  50      * @throws IllegalArgumentException
  51      * @throws IllegalStateException
  52      */
  53     public void addMappingForUrlPatterns(
  54             EnumSet<DispatcherType> dispatcherTypes,
  55             boolean isMatchAfter, String... urlPatterns);
  56
  57     /**
  58      *
  59      * @return TODO
  60      */
  61     public Collection<String> getUrlPatternMappings();
  62
  63     public static interface Dynamic
  64     extends FilterRegistration, Registration.Dynamic {
  65         // No additional methods
  66     }
  67 }