View Javadoc

1   /*
2    * $Id: SelectInclude.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.commons.logging.Log;
21  import org.apache.commons.logging.LogFactory;
22  import org.apache.struts.chain.contexts.ActionContext;
23  import org.apache.struts.config.ActionConfig;
24  
25  /***
26   * <p>Select and cache the include for this <code>ActionConfig</code> if
27   * specified.</p>
28   *
29   * @version $Rev: 421119 $ $Date: 2005-06-04 10:58:46 -0400 (Sat, 04 Jun 2005)
30   *          $
31   */
32  public class SelectInclude extends ActionCommandBase {
33      // ------------------------------------------------------ Instance Variables
34  
35      /***
36       * <p> Provide Commons Logging instance for this class. </p>
37       */
38      private static final Log LOG = LogFactory.getLog(SelectInclude.class);
39  
40      // ---------------------------------------------------------- Public Methods
41  
42      /***
43       * <p>Select and cache the include uri for this <code>ActionConfig</code>
44       * if specified.</p>
45       *
46       * @param actionCtx The <code>Context</code> for the current request
47       * @return <code>false</code> so that processing continues
48       * @throws Exception on any error
49       */
50      public boolean execute(ActionContext actionCtx)
51          throws Exception {
52          // Acquire configuration objects that we need
53          ActionConfig actionConfig = actionCtx.getActionConfig();
54  
55          // Cache an include uri if found
56          String include = actionConfig.getInclude();
57  
58          if (include != null) {
59              if (LOG.isDebugEnabled()) {
60                  LOG.debug("Including " + include);
61              }
62  
63              actionCtx.setInclude(include);
64          }
65  
66          return (false);
67      }
68  }