View Javadoc

1   /*
2    * $Id: ProcessOptionsAction.java 471754 2006-11-06 14:55:09Z husted $
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  
22  package examples.options;
23  
24  import javax.servlet.http.HttpServletRequest;
25  import javax.servlet.http.HttpServletResponse;
26  
27  import org.apache.struts.action.Action;
28  import org.apache.struts.action.ActionForm;
29  import org.apache.struts.action.ActionForward;
30  import org.apache.struts.action.ActionMapping;
31  
32  /**
33   * Retrieve and process data from the submitted form
34   *
35   * @version $Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $
36   */
37  public class ProcessOptionsAction extends Action {
38  
39      // ------------------------------------------------------------ Constructors
40  
41      /**
42       * Constructor for ProcessOptionsAction.
43       */
44      public ProcessOptionsAction() {
45          super();
46      }
47  
48      // ---------------------------------------------------------- Action Methods
49  
50      /**
51       * Process the request and return an <code>ActionForward</code> instance
52       * describing where and how control should be forwarded, or
53       * <code>null</code>if the response has already been completed.
54       *
55       * @param mapping The ActionMapping used to select this instance
56       * @param form The optional ActionForm bean for this request (if any)
57       * @param request The HTTP request we are processing
58       * @param response The HTTP response we are creating
59       *
60       * @exception Exception if the application logic throws an exception
61       *
62       * @return the ActionForward for the next view
63       */
64      public ActionForward execute(
65          ActionMapping mapping,
66          ActionForm form,
67          HttpServletRequest request,
68          HttpServletResponse response)
69          throws Exception {
70  
71          // If user pressed 'Cancel' button,
72          // return to home page
73          if (isCancelled(request)) {
74              return mapping.findForward("home");
75          }
76  
77          // Forward to result page
78          return mapping.findForward("success");
79      }
80  
81  }