001// Licensed under the Apache License, Version 2.0 (the "License");
002// you may not use this file except in compliance with the License.
003// You may obtain a copy of the License at
004//
005// http://www.apache.org/licenses/LICENSE-2.0
006//
007// Unless required by applicable law or agreed to in writing, software
008// distributed under the License is distributed on an "AS IS" BASIS,
009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
010// See the License for the specific language governing permissions and
011// limitations under the License.
012package org.apache.tapestry5.http.internal;
013
014import javax.servlet.http.HttpServletRequest;
015import javax.servlet.http.HttpServletResponse;
016
017import org.apache.tapestry5.http.AsyncRequestHandler;
018import org.apache.tapestry5.http.AsyncRequestHandlerResponse;
019import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration;
020
021/**
022 * Service that handles Tapestry's support for asynchronous Servlet API requests.
023 * @see AsyncRequestHandler
024 */
025@UsesOrderedConfiguration(AsyncRequestHandler.class)
026public interface AsyncRequestService 
027{
028    /**
029     * Returns an {@linkplain AsyncRequestHandlerResponse} describing how to handle this
030     * request concering being async or not.
031     */
032    AsyncRequestHandlerResponse handle(HttpServletRequest request, HttpServletResponse response);
033}