com.canoo.webtest.steps.request
Class AbstractTargetAction

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.canoo.webtest.steps.Step
              com.canoo.webtest.steps.AbstractBrowserAction
                  com.canoo.webtest.steps.request.AbstractTargetAction

All Implemented Interfaces:

IBrowserAction, Serializable, Cloneable

Direct Known Subclasses:

AbstractIdOrLabelTarget, ClickElement, InvokePage

public abstract class AbstractTargetAction
extends AbstractBrowserAction

This is the abstract base class for all test specification steps that initiate a request.

It offers common functionality like preparing the request, handling dynamic parameters and captures HTML parser errors generated by JTidy by providing the required HTML error listeners.

Author:

Carsten Seibert, Marc Guillemot, Paul King

See Also:

Serialized Form

Field Summary

Fields inherited from class com.canoo.webtest.steps.Step

DEFAULT_DESCRIPTION, ELEMENT_ATTRIBUTE_ID, ELEMENT_ATTRIBUTE_NAME, PROPERTY_TYPE_ANT, PROPERTY_TYPE_ANT_STRICT, PROPERTY_TYPE_DEFAULT, PROPERTY_TYPE_DYNAMIC

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

AbstractTargetAction()

Method Summary

void	doExecute() Called to perform the step's functionality.
protected abstract com.gargoylesoftware.htmlunit.Page	findTarget() Fetch the target URL specified byu the step.
protected abstract String	getLogMessageForTarget()
String	getPassword()
protected com.gargoylesoftware.htmlunit.Page	getResponse(com.gargoylesoftware.htmlunit.WebRequest settings)
String	getSave() Placeholder for a getter.
String	getUsername()
void	setPassword(String password)
void	setUsername(String userName)

Methods inherited from class com.canoo.webtest.steps.AbstractBrowserAction

setSave, setSavePrefix, setSaveResponse

Methods inherited from class com.canoo.webtest.steps.Step

addComputedParameters, clone, emptyParamCheck, execute, getComputedParameters, getContext, getDefaultPropertyType, getDescription, getDuration, getParameterDictionary, getStepLabel, getVerifier, getWebtestProperties, getWebtestProperties, getWebtestProperty, getWebtestProperty, handleException, hasDescription, integerParamCheck, isCompleted, isPerformingAction, isStarted, isSuccessful, notifyCompleted, notifyStarted, notifyStepResultsListeners, notifySuccess, nullParamCheck, nullResponseCheck, optionalIntegerParamCheck, paramCheck, positiveOrZeroParamCheck, setStepid, setWebtestProperty, setWebtestProperty, toString, verifyParameters

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.canoo.webtest.interfaces.IBrowserAction

getTaskName

Constructor Detail

AbstractTargetAction

public AbstractTargetAction()

Method Detail

setUsername

public void setUsername(String userName)

Parameters:

userName -

getUsername

public String getUsername()

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

Parameters:

password -

getSave

public String getSave()

Placeholder for a getter. Since this is a synthetic attribute, the getter returns null and it won't be reported.

Returns:

null.

getResponse

protected com.gargoylesoftware.htmlunit.Page getResponse(com.gargoylesoftware.htmlunit.WebRequest settings)
                                                  throws IOException,
                                                         SAXException

Throws:

IOException

SAXException

doExecute

public void doExecute()
               throws Exception

Description copied from class: Step

Called to perform the step's functionality. Before calling this method, the step has been completely initialized (including expanding and verifying the parameters) and the environment notified of the start.

Specified by:

doExecute in class Step

Throws:

Exception

findTarget

protected abstract com.gargoylesoftware.htmlunit.Page findTarget()
                                                          throws Exception

Fetch the target URL specified byu the step.

Returns:

A new Page for the target URL.

Throws:

Exception

getLogMessageForTarget

protected abstract String getLogMessageForTarget()