View Javadoc

1   /*
2    * $Id: Controller.java 421151 2006-07-12 06:07:14Z wsmoak $
3    *
4    * Copyright 1999-2004 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *      http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.struts.tiles;
20  
21  import java.io.IOException;
22  
23  import javax.servlet.ServletContext;
24  import javax.servlet.ServletException;
25  import javax.servlet.http.HttpServletRequest;
26  import javax.servlet.http.HttpServletResponse;
27  
28  /***
29   * A controller is a piece of code called before rendering a jsp page.
30   * A controller can be associated to a tile. See <insert> or
31   * <definition> for association syntax.
32   */
33  public interface Controller {
34  
35      /***
36       * Method associated to a tile and called immediately before the tile
37       * is included.
38       *
39       * @param tileContext    Current tile context.
40       * @param request        Current request
41       * @param response       Current response
42       * @param servletContext Current servlet context
43       * @deprecated Use execute() instead.  This will be removed after
44       *             Struts 1.2.
45       */
46      public void perform(
47              ComponentContext tileContext,
48              HttpServletRequest request,
49              HttpServletResponse response,
50              ServletContext servletContext)
51              throws ServletException, IOException;
52  
53      /***
54       * Method associated to a tile and called immediately before the tile
55       * is included.
56       *
57       * @param tileContext    Current tile context.
58       * @param request        Current request
59       * @param response       Current response
60       * @param servletContext Current servlet context
61       */
62      public void execute(
63              ComponentContext tileContext,
64              HttpServletRequest request,
65              HttpServletResponse response,
66              ServletContext servletContext)
67              throws Exception;
68  }