org.apache.struts.chain
Class AbstractExecuteAction

java.lang.Object
  org.apache.struts.chain.AbstractExecuteAction

All Implemented Interfaces:

org.apache.commons.chain.Command

Direct Known Subclasses:

ExecuteAction

public abstract class AbstractExecuteAction

extends java.lang.Object

implements org.apache.commons.chain.Command

Invoke the appropriate Action for this request, and cache the returned ActionForward.

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	actionConfigKey
private java.lang.String	actionFormKey
private java.lang.String	actionKey
private java.lang.String	forwardConfigKey
private java.lang.String	validKey

Constructor Summary

AbstractExecuteAction()

Method Summary

boolean	execute(org.apache.commons.chain.Context context) Invoke the appropriate Action for this request, and cache the returned ActionForward.
protected abstract org.apache.struts.config.ForwardConfig	execute(org.apache.commons.chain.Context context, org.apache.struts.action.Action action, org.apache.struts.config.ActionConfig actionConfig, org.apache.struts.action.ActionForm actionForm) Execute the specified Action, and return the resulting ForwardConfig.
java.lang.String	getActionConfigKey() Return the context attribute key under which the ActionConfig for the currently selected application action is stored.
java.lang.String	getActionFormKey() Return the context attribute key under which the ActionForm for the currently selected application action is stored.
java.lang.String	getActionKey() Return the context attribute key under which the Action for the currently selected application action is stored.
java.lang.String	getForwardConfigKey() Return the context attribute key under which the ForwardConfig for the currently selected application action is stored.
java.lang.String	getValidKey() Return the context attribute key under which the validity flag for this request is stored.
void	setActionConfigKey(java.lang.String actionConfigKey) Set the context attribute key under which the ActionConfig for the currently selected application action is stored.
void	setActionFormKey(java.lang.String actionFormKey) Set the context attribute key under which the ActionForm for the currently selected application action is stored.
void	setActionKey(java.lang.String actionKey) Set the context attribute key under which the Action for the currently selected application action is stored.
void	setForwardConfigKey(java.lang.String forwardConfigKey) Set the context attribute key under which the ForwardConfig for the currently selected application action is stored.
void	setValidKey(java.lang.String validKey) Set the context attribute key under which the validity flag for this request is stored.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

actionKey

private java.lang.String actionKey

actionConfigKey

private java.lang.String actionConfigKey

actionFormKey

private java.lang.String actionFormKey

forwardConfigKey

private java.lang.String forwardConfigKey

validKey

private java.lang.String validKey

Constructor Detail

AbstractExecuteAction

public AbstractExecuteAction()

Method Detail

getActionKey

public java.lang.String getActionKey()

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

setActionKey

public void setActionKey(java.lang.String actionKey)

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

Parameters:

actionKey - The new context attribute key

getActionConfigKey

public java.lang.String getActionConfigKey()

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

setActionConfigKey

public void setActionConfigKey(java.lang.String actionConfigKey)

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

Parameters:

actionConfigKey - The new context attribute key

getActionFormKey

public java.lang.String getActionFormKey()

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

setActionFormKey

public void setActionFormKey(java.lang.String actionFormKey)

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

Parameters:

actionFormKey - The new context attribute key

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

getValidKey

public java.lang.String getValidKey()

Return the context attribute key under which the validity flag for this request is stored.

setValidKey

public void setValidKey(java.lang.String validKey)

Set the context attribute key under which the validity flag for this request is stored.

Parameters:

validKey - The new context attribute key

execute

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

Invoke the appropriate Action for this request, and cache the returned ActionForward.

Specified by:

execute in interface org.apache.commons.chain.Command

Parameters:

context - The Context for the current request

Returns:

false so that processing continues

Throws:

InvalidPathException - if no valid action can be identified for this request

java.lang.Exception

execute

protected abstract org.apache.struts.config.ForwardConfig execute(org.apache.commons.chain.Context context,
                                                                  org.apache.struts.action.Action action,
                                                                  org.apache.struts.config.ActionConfig actionConfig,
                                                                  org.apache.struts.action.ActionForm actionForm)
                                                           throws java.lang.Exception

Execute the specified Action, and return the resulting ForwardConfig.

Parameters:

context - The Context for this request

action - The Action to be executed

actionConfig - The ActionConfig defining this action

actionForm - The ActionForm (if any) for this action

Throws:

java.lang.Exception - if thrown by the Action