tapestry-core/src/main/java/org/apache/tapestry5/services/Dispatcher.java

// Copyright 2006, 2007, 2008 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry5.services;

import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration;

import java.io.IOException;

/**
 * A dispatcher is responsible for recognizing an incoming request. Dispatchers form an ordered chain of command, with
 * each dispatcher responsible for recognizing requests that it can process.  This is the interface for the
 * MasterDispatcher service, which takes an ordered configuration of Dispatchers (that is, the chain of command
 * pattern). If no dispatcher processes the request, it will ultimately be passed off to the servlet container.
 */
@UsesOrderedConfiguration(Dispatcher.class)
public interface Dispatcher
{
    /**
     * Analyzes the incoming request and performs an appropriate operation for each.
     *
     * @return true if a response was delivered, false if the dispatcher did not handle the request (and a search for a
     *         handler should continue)
     */
    boolean dispatch(Request request, Response response) throws IOException;
}