View Javadoc

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