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