    001// Copyright 2009 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 java.io.IOException;
    020
    021/**
    022 * A facade around {@link org.apache.tapestry5.services.ComponentEventRequestHandler} and {@link
    023 * org.apache.tapestry5.services.PageRenderRequestHandler} that allows for simplified filters that cover both types of
    024 * requests.
    025 *
    026 * @since 5.1.0.0
    027 */
    028@UsesOrderedConfiguration(ComponentRequestFilter.class)
    029public interface ComponentRequestHandler
    030{
    031    /**
    032     * Handler for a component action request which will trigger an event on a component and use the return value to
    033     * send a response to the client (typically, a redirect to a page render URL).
    034     *
    035     * @param parameters defining the request
    036     */
    037    void handleComponentEvent(ComponentEventRequestParameters parameters) throws IOException;
    038
    039    /**
    040     * Invoked to activate and render a page. In certain cases, based on values returned when activating the page, a
    041     * {@link org.apache.tapestry5.services.ComponentEventResultProcessor} may be used to send an alternate response
    042     * (typically, a redirect).
    043     *
    044     * @param parameters defines the page name and activation context
    045     */
    046    void handlePageRender(PageRenderRequestParameters parameters) throws IOException;
    047}