KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > struts > chain > AbstractSelectForward


1 /*
2  * Copyright 2003,2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.apache.struts.chain;
18
19
20 import org.apache.commons.chain.Command;
21 import org.apache.commons.chain.Context;
22 import org.apache.commons.logging.Log;
23 import org.apache.commons.logging.LogFactory;
24 import org.apache.struts.config.ActionConfig;
25 import org.apache.struts.config.ForwardConfig;
26 import org.apache.struts.config.ModuleConfig;
27
28
29 /**
30  * <p>Select and cache the <code>ActionForward</code> for this
31  * <code>ActionConfig</code> if specified.</p>
32  *
33  * @author Don Brown
34  * @version $Rev: 54933 $ $Date: 2004-10-16 18:04:52 +0100 (Sat, 16 Oct 2004) $
35  */
36
37 public abstract class AbstractSelectForward implements Command {
38
39
40     // ------------------------------------------------------ Instance Variables
41
42
43     private String JavaDoc actionConfigKey = Constants.ACTION_CONFIG_KEY;
44     private String JavaDoc forwardConfigKey = Constants.FORWARD_CONFIG_KEY;
45     private String JavaDoc validKey = Constants.VALID_KEY;
46
47     private static final Log log =
48         LogFactory.getLog(AbstractSelectForward.class);
49
50
51     // -------------------------------------------------------------- Properties
52
53
54     /**
55      * <p>Return the context attribute key under which the
56      * <code>ActionConfig</code> for the currently selected application
57      * action is stored.</p>
58      */
59     public String JavaDoc getActionConfigKey() {
60
61         return (this.actionConfigKey);
62
63     }
64
65
66     /**
67      * <p>Set the context attribute key under which the
68      * <code>ActionConfig</code> for the currently selected application
69      * action is stored.</p>
70      *
71      * @param actionConfigKey The new context attribute key
72      */
73     public void setActionConfigKey(String JavaDoc actionConfigKey) {
74
75         this.actionConfigKey = actionConfigKey;
76
77     }
78
79
80     /**
81      * <p>Return the context attribute key under which the
82      * <code>ForwardConfig</code> for the currently selected application
83      * action is stored.</p>
84      */
85     public String JavaDoc getForwardConfigKey() {
86
87         return (this.forwardConfigKey);
88
89     }
90
91
92     /**
93      * <p>Set the context attribute key under which the
94      * <code>ForwardConfig</code> for the currently selected application
95      * action is stored.</p>
96      *
97      * @param forwardConfigKey The new context attribute key
98      */
99     public void setForwardConfigKey(String JavaDoc forwardConfigKey) {
100
101         this.forwardConfigKey = forwardConfigKey;
102
103     }
104
105
106     /**
107      * <p>Return the context attribute key under which the
108      * validity flag for this request is stored.</p>
109      */
110     public String JavaDoc getValidKey() {
111
112         return (this.validKey);
113
114     }
115
116
117     /**
118      * <p>Set the context attribute key under which the
119      * validity flag for this request is stored.</p>
120      *
121      * @param validKey The new context attribute key
122      */
123     public void setValidKey(String JavaDoc validKey) {
124
125         this.validKey = validKey;
126
127     }
128
129
130     // ---------------------------------------------------------- Public Methods
131
132
133     /**
134      * <p>Select and cache the <code>ActionForward</code> for this
135      * <code>ActionConfig</code> if specified.</p>
136      *
137      * @param context The <code>Context</code> for the current request
138      *
139      * @return <code>false</code> so that processing continues
140      */
141     public boolean execute(Context context) throws Exception JavaDoc {
142
143         // Skip processing if the current request is not valid
144 Boolean JavaDoc valid = (Boolean JavaDoc) context.get(getValidKey());
145         if ((valid == null) || !valid.booleanValue()) {
146             return (false);
147         }
148
149         // Acquire configuration objects that we need
150 ActionConfig actionConfig = (ActionConfig)
151                                     context.get(getActionConfigKey());
152         ModuleConfig moduleConfig = actionConfig.getModuleConfig();
153
154         ForwardConfig forwardConfig = null;
155         String JavaDoc forward = actionConfig.getForward();
156         if (forward != null) {
157             forwardConfig = forward(context, moduleConfig, forward);
158             if (log.isDebugEnabled()) {
159                 log.debug("Forwarding to " + forwardConfig);
160             }
161             context.put(getForwardConfigKey(), forwardConfig);
162         }
163         return (false);
164
165     }
166
167
168     // ------------------------------------------------------- Protected Methods
169
170
171     /**
172      * <p>Create and return a <code>ForwardConfig</code> representing the
173      * specified module-relative destination.</p>
174      *
175      * @param context The context for this request
176      * @param moduleConfig The <code>ModuleConfig</code> for this request
177      * @param uri The module-relative URI to be the destination
178      */
179     protected abstract ForwardConfig forward(Context context,
180                                              ModuleConfig moduleConfig,
181                                              String JavaDoc uri);
182
183
184
185 }
186
Popular Tags