lib/servlet-api/javax/servlet/FilterChain.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.io.IOException;
  20
  21 /**
  22  * A FilterChain is an object provided by the servlet container to the developer
  23  * giving a view into the invocation chain of a filtered request for a resource.
  24  * Filters use the FilterChain to invoke the next filter in the chain, or if the
  25  * calling filter is the last filter in the chain, to invoke the resource at the
  26  * end of the chain.
  27  *
  28  * @see Filter
  29  * @since Servlet 2.3
  30  **/
  31
  32 public interface FilterChain {
  33
  34     /**
  35      * Causes the next filter in the chain to be invoked, or if the calling
  36      * filter is the last filter in the chain, causes the resource at the end of
  37      * the chain to be invoked.
  38      *
  39      * @param request
  40      *            the request to pass along the chain.
  41      * @param response
  42      *            the response to pass along the chain.
  43      *
  44      * @since 2.3
  45      */
  46     public void doFilter(ServletRequest request, ServletResponse response)
  47             throws IOException, ServletException;
  48
  49 }