vaadin-framework/src/com/vaadin/terminal/RequestHandler.java

/*
@VaadinApache2LicenseForJavaFiles@
 */

package com.vaadin.terminal;

import java.io.IOException;
import java.io.Serializable;

import com.vaadin.Application;

/**
 * Handler for producing a response to non-UIDL requests. Handlers can be added
 * to applications using {@link Application#addRequestHandler(RequestHandler)}
 */
public interface RequestHandler extends Serializable {

    /**
     * Handles a non-UIDL request. If a response is written, this method should
     * return <code>false</code> to indicate that no more request handlers
     * should be invoked for the request.
     * 
     * @param application
     *            The application to which the request belongs
     * @param request
     *            The request to handle
     * @param response
     *            The response object to which a response can be written.
     * @return true if a response has been written and no further request
     *         handlers should be called, otherwise false
     * @throws IOException
     */
    boolean handleRequest(Application application, WrappedRequest request,
            WrappedResponse response) throws IOException;

}