org.apache.struts.chain
Class AbstractSelectForward

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

All Implemented Interfaces:

org.apache.commons.chain.Command

Direct Known Subclasses:

SelectForward

public abstract class AbstractSelectForward

extends java.lang.Object

implements org.apache.commons.chain.Command

Select and cache the ActionForward for this ActionConfig if specified.

Version:

$Rev: 54933 $ $Date: 2004-10-16 18:04:52 +0100 (Sat, 16 Oct 2004) $

Author:

Don Brown

Field Summary

private java.lang.String	actionConfigKey
private java.lang.String	forwardConfigKey
private static org.apache.commons.logging.Log	log
private java.lang.String	validKey

Constructor Summary

AbstractSelectForward()

Method Summary

boolean	execute(org.apache.commons.chain.Context context) Select and cache the ActionForward for this ActionConfig if specified.
protected abstract org.apache.struts.config.ForwardConfig	forward(org.apache.commons.chain.Context context, org.apache.struts.config.ModuleConfig moduleConfig, java.lang.String uri) Create and return a ForwardConfig representing the specified module-relative destination.
java.lang.String	getActionConfigKey() Return the context attribute key under which the ActionConfig 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	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

actionConfigKey

private java.lang.String actionConfigKey

forwardConfigKey

private java.lang.String forwardConfigKey

validKey

private java.lang.String validKey

log

private static final org.apache.commons.logging.Log log

Constructor Detail

AbstractSelectForward

public AbstractSelectForward()

Method Detail

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

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

Select and cache the ActionForward for this ActionConfig if specified.

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:

java.lang.Exception

forward

protected abstract org.apache.struts.config.ForwardConfig forward(org.apache.commons.chain.Context context,
                                                                  org.apache.struts.config.ModuleConfig moduleConfig,
                                                                  java.lang.String uri)

Create and return a ForwardConfig representing the specified module-relative destination.

Parameters:

context - The context for this request

moduleConfig - The ModuleConfig for this request

uri - The module-relative URI to be the destination