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.chain.contexts.ActionContext;
24 import org.apache.struts.config.ModuleConfig;
25
26 /**
27 * <p>Perform forwarding or redirection based on the specified
28 * <code>String</code> (if any).</p>
29 *
30 * @version $Rev$ $Date: 2005-06-04 10:58:46 -0400 (Sat, 04 Jun 2005)
31 * $
32 */
33 public abstract class AbstractPerformInclude extends ActionCommandBase {
34 // ---------------------------------------------------------- Public Methods
35
36 /**
37 * <p>Perform an include based on the specified include uri (if any).</p>
38 *
39 * @param actionCtx The <code>Context</code> for the current request
40 * @return <code>true</code> so that processing completes
41 * @throws Exception if thrown by the <code>Action</code>
42 */
43 @Override
44 protected boolean execute_(ActionContext actionCtx)
45 throws Exception {
46
47 // Is there an include to be performed?
48 String include = actionCtx.getInclude();
49
50 if (include == null) {
51 return CONTINUE_PROCESSING;
52 }
53
54 // Determine the currect uri
55 String uri = includePath(actionCtx, include);
56
57 // Perform the appropriate processing on this include uri
58 perform(actionCtx, uri);
59
60 return PROCESSING_COMPLETE;
61 }
62
63 // ------------------------------------------------------- Protected Methods
64
65 /**
66 * <p>Returns the path to perform the include. Override this method to provide
67 * a different path.</p>
68 *
69 * @param actionContext The context for this request
70 * @param include The forward to be performed
71 * @since Struts 1.3.6
72 */
73 protected String includePath(ActionContext actionContext, String include) {
74 ModuleConfig moduleConfig = actionContext.getModuleConfig();
75 return moduleConfig.getPrefix() + include;
76 }
77
78 /**
79 * <p>Perform the appropriate processing on the specified include
80 * uri.</p>
81 *
82 * @param context The context for this request
83 * @param include The forward to be performed
84 * @throws Exception if thrown by the <code>Action</code>
85 */
86 protected abstract void perform(ActionContext context, String include)
87 throws Exception;
88 }