com.canoo.webtest.plugins.emailtest
Class AbstractMessageOperationStep

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

All Implemented Interfaces:

ISingleMessageStep, Serializable, Cloneable

Direct Known Subclasses:

AbstractEmailFilter, EmailDeleteMessage

public abstract class AbstractMessageOperationStep
extends AbstractBaseStep
implements ISingleMessageStep

Abstract class used by email steps that perform an operation on a single message.

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

protected

AbstractMessageOperationStep(boolean deleteOnExit)

Method Summary

void	doExecute() Called to perform the step's functionality.
String	getMessageId()
protected abstract void	performOperation(javax.mail.Message message)
void	setMessageId(String id) Sets the message id.
protected void	verifyParameters() Verifies the parameters

Methods inherited from class com.canoo.webtest.plugins.emailtest.AbstractBaseStep

getHelper, setHelper

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

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.plugins.emailtest.ISingleMessageStep

getContext

Constructor Detail

AbstractMessageOperationStep

protected AbstractMessageOperationStep(boolean deleteOnExit)

Method Detail

getMessageId

public String getMessageId()

Specified by:

getMessageId in interface ISingleMessageStep

setMessageId

public void setMessageId(String id)

Sets the message id.

Specified by:

setMessageId in interface ISingleMessageStep

Parameters:

id - The id of the message of interest

performOperation

protected abstract void performOperation(javax.mail.Message message)
                                  throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

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()

Verifies the parameters

Overrides:

verifyParameters in class AbstractBaseStep