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.commons.chain.Command;
24  import org.apache.struts.chain.contexts.ActionContext;
25  import org.apache.struts.config.ForwardConfig;
26  
27  /**
28   * Look up and execute a commons-chain {@code Command} based on properties of
29   * the ActionContext's {@code forwardConfig} property.
30   */
31  public class ExecuteForwardCommand extends ExecuteCommand {
32  
33      /**
34       * Return the command specified by the {@code command} and {@code catalog}
35       * properties of the {@code forwardConfig} property of the given
36       * {@code ActionContext}. If {@code forwardConfig} is null, return null.
37       *
38       * @param context Our ActionContext
39       *
40       * @return Command to execute or null
41       */
42      protected Command<ActionContext> getCommand(ActionContext context) {
43          ForwardConfig forwardConfig = context.getForwardConfig();
44  
45          if (forwardConfig == null) {
46              return null;
47          }
48  
49          return getCommand(forwardConfig.getCommand(), forwardConfig.getCatalog());
50      }
51  
52      /**
53       * Determine whether the forwardConfig should be processed.
54       *
55       * @param context The ActionContext we are processing
56       *
57       * @return {@code true} if the given {@code ActionContext} has a non-null
58       *         {@code forwardConfig} property.
59       */
60      protected boolean shouldProcess(ActionContext context) {
61          return (context.getForwardConfig() != null);
62      }
63  }