org.apache.struts.chain.commands

Class ExecuteCommand

java.lang.Object

org.apache.struts.chain.commands.ActionCommandBase

org.apache.struts.chain.commands.ExecuteCommand

All Implemented Interfaces:

org.apache.commons.chain.Command, ActionCommand

Direct Known Subclasses:

ExecuteForwardCommand

public class ExecuteCommand
extends ActionCommandBase

Invoke the appropriate Command for this request. If the context's ActionConfig has no command property defined, no action will be taken. If the specified command cannot be found, a warning will be logged, but processing will continue. Depending on how the chain is configured, this can be used in place of an Action or as a method of performing pre-processing.

If used instead of an action, the command which is looked up should put an ActionForward into the context, unless it has already dealt with the response.

Version:

$Id: ExecuteCommand.java 471754 2006-11-06 14:55:09Z husted $

Field Summary

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

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

Constructors

Constructor and Description
ExecuteCommand()

Method Summary

Modifier and Type	Method and Description
boolean	execute(ActionContext actionCtx) If the context is "valid", lookup a command and execute it.
protected org.apache.commons.chain.Command	getCommand(ActionContext context) Find the ActionConfig in the current context and, if it is properly configured, lookup the appropriate commons-chain command.
protected org.apache.commons.chain.Command	getCommand(java.lang.String commandName, java.lang.String catalogName) Retrieve the specified Command from the specified Catalog.
protected boolean	shouldProcess(ActionContext context) Evaluate the current context to see if a command should even be executed.

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

ExecuteCommand

public ExecuteCommand()

Method Detail

execute

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

If the context is "valid", lookup a command and execute it.

Specified by:

execute in interface ActionCommand

Specified by:

execute in class ActionCommandBase

Parameters:

actionCtx - The Context for the current request

Returns:

the result of the lookup command's execute method, if executed, or false if it was not executed.

Throws:

java.lang.Exception - on any error

shouldProcess

protected boolean shouldProcess(ActionContext context)

Evaluate the current context to see if a command should even be executed.

Parameters:

context - A valid ActionContext

Returns:

TRUE if the pending Command should be executed

getCommand

protected org.apache.commons.chain.Command getCommand(ActionContext context)

Find the ActionConfig in the current context and, if it is properly configured, lookup the appropriate commons-chain command.

Parameters:

context - A valid ActionContext

Returns:

a Command to execute, or null if none is specified or if the specified command cannot be found.

getCommand

protected org.apache.commons.chain.Command getCommand(java.lang.String commandName,
                                                      java.lang.String catalogName)

Retrieve the specified Command from the specified Catalog.

Parameters:

commandName - The Command to retrieve.

catalogName - The Catalog to search.

Returns:

Instantiated Command, or null