    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.
    012
    013package org.apache.tapestry5.services;
    014
    015import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration;
    016
    017import java.io.IOException;
    018
    019/**
    020 * Handles a invocation related to rendering out a pages complete content.
    021 *
    022 * The PageRenderRequestHandler service is an extensible {@linkplain org.apache.tapestry5.ioc.services.PipelineBuilder
    023 * pipeline}.
    024 */
    025@UsesOrderedConfiguration(PageRenderRequestFilter.class)
    026public interface PageRenderRequestHandler
    027{
    028    /**
    029     * Invoked to activate and render a page. In certain cases, based on values returned when activating the page, a
    030     * {@link org.apache.tapestry5.services.ComponentEventResultProcessor} may be used to send an alternate response
    031     * (typically, a redirect).
    032     *
    033     * @param parameters defines the page name and activation context
    034     */
    035    void handle(PageRenderRequestParameters parameters) throws IOException;
    036}