001// Copyright 2006 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.http.services;
016
017import javax.servlet.http.HttpServletRequest;
018import javax.servlet.http.HttpServletResponse;
019
020import java.io.IOException;
021
022/**
023 * Filter interface for {@link org.apache.tapestry5.http.services.HttpServletRequestHandler}.
024 */
025public interface HttpServletRequestFilter
026{
027    /**
028     * Filter interface for the HttpServletRequestHandler pipeline. A filter should delegate to the handler. It may
029     * perform operations before or after invoking the handler, and may modify the request and response passed in to the
030     * handler.
031     *
032     * @return true if the request has been handled, false otherwise
033     */
034    boolean service(HttpServletRequest request, HttpServletResponse response, HttpServletRequestHandler handler)
035            throws IOException;
036}