com.canoo.webtest.plugins.emailtest
Class EmailSetConfig

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.canoo.webtest.steps.Step
              com.canoo.webtest.plugins.emailtest.EmailSetConfig

All Implemented Interfaces:

Serializable, Cloneable

public class EmailSetConfig
extends Step

Sets Email Configuration information.

Author:

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

EmailSetConfig()

Method Summary

void	doExecute() Called to perform the step's functionality.
String	getDelay()
Map	getParameterDictionary() Gets a snapshot of the values.
String	getPassword()
String	getServer()
String	getType()
String	getUsername()
void	setDelay(String delay) Sets the delay to use between email steps.
void	setPassword(String password) Sets the email account password.
void	setServer(String server) Sets the email server.
void	setType(String type) Sets the email server type.
void	setUsername(String username) Sets the email account username.
protected void	verifyParameters() Called to let the step's implementation validate its parameters.

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

addComputedParameters, clone, emptyParamCheck, execute, getComputedParameters, getContext, getDefaultPropertyType, getDescription, getDuration, 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

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

Constructor Detail

EmailSetConfig

public EmailSetConfig()

Method Detail

getServer

public String getServer()

setServer

public void setServer(String server)

Sets the email server.

Parameters:

server - The Server domain name (and optional port)

getType

public String getType()

setType

public void setType(String type)

Sets the email server type.

Parameters:

type - The server type

getUsername

public String getUsername()

setDelay

public void setDelay(String delay)

Sets the delay to use between email steps.

Parameters:

delay - The delay between operaitons in seconds

getDelay

public String getDelay()

setUsername

public void setUsername(String username)

Sets the email account username.

Parameters:

username -

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

Sets the email account password.

Parameters:

password -

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

verifyParameters

protected void verifyParameters()

Description copied from class: Step

Called to let the step's implementation validate its parameters. The method is called after parameter extensions but before Step.doExecute(). This implementation does nothing, overwrite as needed.

Overrides:

verifyParameters in class Step

getParameterDictionary

public Map getParameterDictionary()

Description copied from class: Step

Gets a snapshot of the values. As the value of the attributes can change over time, it is not possible to fill and cache the Map. Either fill the Map everytime, or skip the fields and use only the Map.

This method returns all the parameters that were discovered at build time and stored in the .attributes resource. Overwrite this method if your step doesn't have a .attributes resource

Overrides:

getParameterDictionary in class Step

Returns:

A Map of (attribute name, attribute value) for this step.