org.apache.struts.chain
Class AbstractPerformForward

java.lang.Object
  extended byorg.apache.struts.chain.AbstractPerformForward
All Implemented Interfaces:
org.apache.commons.chain.Command
Direct Known Subclasses:
PerformForward

public abstract class AbstractPerformForward
extends java.lang.Object
implements org.apache.commons.chain.Command

Perform forwarding or redirection based on the specified ForwardConfig (if any).

Version:
$Rev: 54933 $ $Date: 2004-10-16 18:04:52 +0100 (Sat, 16 Oct 2004) $
Author:
Craig R. McClanahan

Field Summary
private  java.lang.String forwardConfigKey
           
private  java.lang.String moduleConfigKey
           
 
Constructor Summary
AbstractPerformForward()
           
 
Method Summary
 boolean execute(org.apache.commons.chain.Context context)
          Perform forwarding or redirection based on the specified ActionForward (if any).
 java.lang.String getForwardConfigKey()
          Return the context attribute key under which the ForwardConfig for the currently selected application action is stored.
 java.lang.String getModuleConfigKey()
          Return the context attribute key under which the ModuleConfig for the currently selected application module will be stored.
protected abstract  void perform(org.apache.commons.chain.Context context, org.apache.struts.config.ForwardConfig forwardConfig)
          Perform the appropriate processing on the specified ForwardConfig.
 void setForwardConfigKey(java.lang.String forwardConfigKey)
          Set the context attribute key under which the ForwardConfig for the currently selected application action is stored.
 void setModuleConfigKey(java.lang.String moduleConfigKey)
          Set the context attribute key under which the ModuleConfig for the currently selected application module will be stored.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

forwardConfigKey

private java.lang.String forwardConfigKey

moduleConfigKey

private java.lang.String moduleConfigKey
Constructor Detail

AbstractPerformForward

public AbstractPerformForward()
Method Detail

getForwardConfigKey

public java.lang.String getForwardConfigKey()

Return the context attribute key under which the ForwardConfig for the currently selected application action is stored.


setForwardConfigKey

public void setForwardConfigKey(java.lang.String forwardConfigKey)

Set the context attribute key under which the ForwardConfig for the currently selected application action is stored.

Parameters:
forwardConfigKey - The new context attribute key

getModuleConfigKey

public java.lang.String getModuleConfigKey()

Return the context attribute key under which the ModuleConfig for the currently selected application module will be stored.


setModuleConfigKey

public void setModuleConfigKey(java.lang.String moduleConfigKey)

Set the context attribute key under which the ModuleConfig for the currently selected application module will be stored.

Parameters:
moduleConfigKey - The new context attribute key

execute

public boolean execute(org.apache.commons.chain.Context context)
                throws java.lang.Exception

Perform forwarding or redirection based on the specified ActionForward (if any).

Specified by:
execute in interface org.apache.commons.chain.Command
Parameters:
context - The Context for the current request
Returns:
true so that processing completes
Throws:
java.lang.Exception

perform

protected abstract void perform(org.apache.commons.chain.Context context,
                                org.apache.struts.config.ForwardConfig forwardConfig)
                         throws java.lang.Exception

Perform the appropriate processing on the specified ForwardConfig.

Parameters:
context - The context for this request
forwardConfig - The forward to be performed
Throws:
java.lang.Exception


Copyright ? 2003 - Apache Software Foundation