org.apache.struts.chain
Class AbstractPerformInclude

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

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

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

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

Field Summary
private  java.lang.String includeKey
           
private  java.lang.String moduleConfigKey
           
 
Constructor Summary
AbstractPerformInclude()
           
 
Method Summary
 boolean execute(org.apache.commons.chain.Context context)
          Perform an include based on the specified include uri (if any).
 java.lang.String getIncludeKey()
          Return the context attribute key under which the include uri 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 is stored.
protected abstract  void perform(org.apache.commons.chain.Context context, java.lang.String include)
          Perform the appropriate processing on the specified include uri.
 void setIncludeKey(java.lang.String includeKey)
          Set the context attribute key under which the include uri 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 is stored.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

includeKey

private java.lang.String includeKey

moduleConfigKey

private java.lang.String moduleConfigKey
Constructor Detail

AbstractPerformInclude

public AbstractPerformInclude()
Method Detail

getIncludeKey

public java.lang.String getIncludeKey()

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


setIncludeKey

public void setIncludeKey(java.lang.String includeKey)

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

Parameters:
includeKey - 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 is stored.


setModuleConfigKey

public void setModuleConfigKey(java.lang.String moduleConfigKey)

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

Parameters:
moduleConfigKey - The new context attribute key

execute

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

Perform an include based on the specified include uri (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,
                                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


Copyright ? 2003 - Apache Software Foundation