org.apache.commons.workflow.io
Class GetStep

java.lang.Object
  org.apache.commons.workflow.base.BaseStep
      org.apache.commons.workflow.io.GetStep

All Implemented Interfaces:

org.apache.commons.workflow.Step

public class GetStep

extends BaseStep

Retrieve the contents of a specified URL resource, and push the contents as a String object onto the evaluation stack.

Supported Attributes:

• url - URL of the resource to be retrieved, or omitted to pop a computed String value from the top of the evaluation stack.

DESIGN QUESTION - What about binary content?

Version:

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

Field Summary

protected java.lang.String

url The URL of the resource to be retrieved.

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

id, nextStep, owner, previousStep

Constructor Summary

GetStep()
Construct a default instance of this Step.

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

GetStep(java.lang.String id, java.lang.String url)
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	getUrl()
void	setUrl(java.lang.String url)

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, toString, wait, wait, wait

Field Detail

url

protected java.lang.String url

The URL of the resource to be retrieved.

Constructor Detail

GetStep

public GetStep()

Construct a default instance of this Step.

GetStep

public GetStep(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

GetStep

public GetStep(java.lang.String id,
               java.lang.String url)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier

url - Resource url

Method Detail

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

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