001// Copyright 2006, 2008 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.services;
016
017import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration;
018
019import javax.servlet.http.HttpServletRequest;
020import javax.servlet.http.HttpServletResponse;
021import java.io.IOException;
022
023/**
024 * The first step in handing an incoming request to the {@linkplain org.apache.tapestry5.TapestryFilter servlet filter},
025 * this constructed as a {@linkplain org.apache.tapestry5.ioc.services.PipelineBuilder pipeline}.  The main
026 * implementation hands off to the {@link org.apache.tapestry5.services.RequestHandler} service.
027 */
028@UsesOrderedConfiguration(HttpServletRequestFilter.class)
029public interface HttpServletRequestHandler
030{
031    /**
032     * Returns true if the request was handled, false otherwise.
033     */
034    boolean service(HttpServletRequest request, HttpServletResponse response) throws IOException;
035}