org.apache.struts.chain.commands

Class AbstractPerformInclude

java.lang.Object

org.apache.struts.chain.commands.ActionCommandBase

org.apache.struts.chain.commands.AbstractPerformInclude

All Implemented Interfaces:

org.apache.commons.chain.Command, ActionCommand

Direct Known Subclasses:

PerformInclude

public abstract class AbstractPerformInclude
extends ActionCommandBase

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

Version:

$Rev: 471754 $ $Date: 2005-06-04 10:58:46 -0400 (Sat, 04 Jun 2005) $

Field Summary

Fields inherited from interface org.apache.commons.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

Constructors

Constructor and Description
AbstractPerformInclude()

Method Summary

Modifier and Type	Method and Description
boolean	execute(ActionContext actionCtx) Perform an include based on the specified include uri (if any).
protected java.lang.String	includePath(ActionContext actionContext, java.lang.String include) Returns the path to perform the include.
protected abstract void	perform(ActionContext context, java.lang.String include) Perform the appropriate processing on the specified include uri.

Methods inherited from class org.apache.struts.chain.commands.ActionCommandBase

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPerformInclude

public AbstractPerformInclude()

Method Detail

execute

public boolean execute(ActionContext actionCtx)
                throws java.lang.Exception

Perform an include based on the specified include uri (if any).

Specified by:

execute in interface ActionCommand

Specified by:

execute in class ActionCommandBase

Parameters:

actionCtx - The Context for the current request

Returns:

true so that processing completes

Throws:

java.lang.Exception - if thrown by the Action

includePath

protected java.lang.String includePath(ActionContext actionContext,
                                       java.lang.String include)

Returns the path to perform the include. Override this method to provide a different path.

Parameters:

actionContext - The context for this request

include - The forward to be performed

Since:

Struts 1.3.6

perform

protected abstract void perform(ActionContext context,
                                java.lang.String include)
                         throws java.lang.Exception

Perform the appropriate processing on the specified include uri.

Parameters:

context - The context for this request

include - The forward to be performed

Throws:

java.lang.Exception - if thrown by the Action