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.struts.chain.commands;
22  
23  import org.apache.struts.Globals;
24  import org.apache.struts.chain.contexts.ActionContext;
25  
26  /**
27   * <p>Check to original uri is set, and if not, set it for this request.</p>
28   *
29   * @version $Rev$ $Date: 2005-06-04 07:58:46 -0700 (Sat, 04 Jun 2005)
30   *          $
31   */
32  public abstract class AbstractSetOriginalURI extends ActionCommandBase {
33      // ---------------------------------------------------------- Public Methods
34  
35      /**
36       * <p>Check to original uri is set, and if not, set it for this
37       * request.</p>
38       *
39       * @param actionCtx The <code>Context</code> for the current request
40       * @return <code>false</code> so that processing continues
41       * @throws Exception if thrown by the Action class
42       */
43      @Override
44      protected boolean execute_(ActionContext actionCtx)
45          throws Exception {
46          // Set the original uri if not already set
47          if (!actionCtx.getRequestScope().containsKey(Globals.ORIGINAL_URI_KEY)) {
48              setOriginalURI(actionCtx);
49          }
50  
51          return CONTINUE_PROCESSING;
52      }
53  
54      // ------------------------------------------------------- Protected Methods
55  
56      /**
57       * <p>Set the original uri.</p>
58       *
59       * @param context The <code>Context</code> for this request
60       */
61      protected abstract void setOriginalURI(ActionContext context);
62  }