This project has retired. For details please refer to its Attic page.
DispatchRequest xref
View Javadoc

1   /*
2    * $Id$
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.tiles.request;
22  
23  import java.io.IOException;
24  
25  
26  /**
27   * Encapsulation of request information.
28   *
29   * @version $Rev$ $Date$
30   */
31  public interface DispatchRequest extends Request {
32  
33      /**
34       * Dispatches the request to a specified path.
35       *
36       * @param path The path to dispatch to.
37       * @throws IOException If something goes wrong during dispatching.
38       */
39      void dispatch(String path) throws IOException;
40  
41      /**
42       * Includes the response from the specified URL in the current response output.
43       *
44       * @param path The path to include.
45       * @throws IOException If something goes wrong during inclusion.
46       */
47      void include(String path) throws IOException;
48  
49      /**
50       * Sets the content type when rendering the result.
51       *
52       * @param contentType The content type. It should follow the specifications
53       * from W3C about content types.
54       */
55      void setContentType(String contentType);
56  }