org.apache.commons.workflow.web
Class IncludeStep23

java.lang.Object
  org.apache.commons.workflow.base.BaseStep
      org.apache.commons.workflow.web.IncludeStep23

All Implemented Interfaces:

org.apache.commons.workflow.Step

public class IncludeStep23

extends BaseStep

Perform a RequestDispatcher.include() operation on the specified context relative path, and push the response data (as a String onto the evaluation stack.

Supported Attributes:

• page - Context relative URL (starting with a slash) of the application resource to be retrieved, or omitted to pop a computed String value from the top of the evaluation stack.

WARNING - This implementation requires a Servlet 2.3 based container, because it uses the new response wrapper facilities.

DESIGN QUESTION - What about binary content?

Version:

$Revision: 1.5 $ $Date: 2004/02/28 03:35:55 $

Field Summary

protected java.lang.String

page The context-relative URL (starting with '/') of the resource to be retrieved.

Fields inherited from class org.apache.commons.workflow.base.BaseStep

id, nextStep, owner, previousStep

Constructor Summary

IncludeStep23()
Construct a default instance of this Step.

IncludeStep23(java.lang.String id)
Construct an instance of this Step with the specified identifier.

IncludeStep23(java.lang.String id, java.lang.String page)
Construct a fully configured instance of this Step.

Method Summary

void	execute(org.apache.commons.workflow.Context context) Perform the executable actions related to this Step, in the context of the specified Context.
java.lang.String	getPage()
void	setPage(java.lang.String page)
java.lang.String	toString() Render a string representation of this Step.

Methods inherited from class org.apache.commons.workflow.base.BaseStep

getId, getNextStep, getOwner, getPreviousStep, setId, setNextStep, setOwner, setPreviousStep

Methods inherited from class java.lang.Object

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

Field Detail

page

protected java.lang.String page

The context-relative URL (starting with '/') of the resource to be retrieved.

Constructor Detail

IncludeStep23

public IncludeStep23()

Construct a default instance of this Step.

IncludeStep23

public IncludeStep23(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

IncludeStep23

public IncludeStep23(java.lang.String id,
                     java.lang.String page)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier

page - Context-relative url

Method Detail

getPage

public java.lang.String getPage()

setPage

public void setPage(java.lang.String page)

execute

public void execute(org.apache.commons.workflow.Context context)
             throws org.apache.commons.workflow.StepException

Perform the executable actions related to this Step, in the context of the specified Context.

Specified by:

execute in interface org.apache.commons.workflow.Step

Specified by:

execute in class BaseStep

Parameters:

context - The Context that is tracking our execution state

Throws:

org.apache.commons.workflow.StepException - if a processing error has occurred

toString

public java.lang.String toString()

Render a string representation of this Step.