/*
* Copyright 2003,2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.struts.chain;
import org.apache.commons.chain.Command;
import org.apache.commons.chain.Context;
import org.apache.struts.config.ForwardConfig;
/**
* <p>Perform forwarding or redirection based on the specified
* <code>ForwardConfig</code> (if any).</p>
*
* @author Craig R. McClanahan
* @version $Revision: 1.6 $ $Date: 2004/04/29 03:08:44 $
*/
public abstract class AbstractPerformForward implements Command {
// ------------------------------------------------------ Instance Variables
private String forwardConfigKey = Constants.FORWARD_CONFIG_KEY;
private String moduleConfigKey = Constants.MODULE_CONFIG_KEY;
// -------------------------------------------------------------- Properties
/**
* <p>Return the context attribute key under which the
* <code>ForwardConfig</code> for the currently selected application
* action is stored.</p>
*/
public String getForwardConfigKey() {
return (this.forwardConfigKey);
}
/**
* <p>Set the context attribute key under which the
* <code>ForwardConfig</code> for the currently selected application
* action is stored.</p>
*
* @param forwardConfigKey The new context attribute key
*/
public void setForwardConfigKey(String forwardConfigKey) {
this.forwardConfigKey = forwardConfigKey;
}
/**
* <p>Return the context attribute key under which the
* <code>ModuleConfig</code> for the currently selected application
* module will be stored.</p>
*/
public String getModuleConfigKey() {
return (this.moduleConfigKey);
}
/**
* <p>Set the context attribute key under which the
* <code>ModuleConfig</code> for the currently selected application
* module will be stored.</p>
*
* @param moduleConfigKey The new context attribute key
*/
public void setModuleConfigKey(String moduleConfigKey) {
this.moduleConfigKey = moduleConfigKey;
}
// ---------------------------------------------------------- Public Methods
/**
* <p>Perform forwarding or redirection based on the specified
* <code>ActionForward</code> (if any).</p>
*
* @param context The <code>Context</code> for the current request
*
* @return <code>true</code> so that processing completes
*/
public boolean execute(Context context) throws Exception {
// Is there a ForwardConfig to be performed?
ForwardConfig forwardConfig = (ForwardConfig)
context.get(getForwardConfigKey());
if (forwardConfig == null) {
return (false);
}
// Perform the appropriate processing on this ActionForward
perform(context, forwardConfig);
return (true);
}
// ------------------------------------------------------- Protected Methods
/**
* <p>Perform the appropriate processing on the specified
* <code>ForwardConfig</code>.</p>
*
* @param context The context for this request
* @param forwardConfig The forward to be performed
*/
protected abstract void perform(Context context,
ForwardConfig forwardConfig)
throws Exception;
}