com.canoo.webtest.plugins.emailtest

Class AbstractMessageStoreStep

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.AbstractStoreStep

com.canoo.webtest.plugins.emailtest.AbstractMessageStoreStep

All Implemented Interfaces:

ISingleMessageStep, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

EmailStoreHeader, EmailStoreMessageType, EmailStorePartCount, EmailStorePartFilename

public abstract class AbstractMessageStoreStep
extends AbstractStoreStep
implements ISingleMessageStep

Abstract class used by email steps that store a property related to 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

Constructors

Constructor and Description
AbstractMessageStoreStep()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessageId()
protected abstract java.lang.String	performOperation(javax.mail.Message message)
protected java.lang.String	processContent(javax.mail.Folder folder)
void	setMessageId(java.lang.String id) Sets the message id.
protected void	verifyParameters() Verifies the parameters

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

doExecute, getProperty, getPropertyType, setProperty, setPropertyType

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

AbstractMessageStoreStep

public AbstractMessageStoreStep()

Method Detail

setMessageId

public void setMessageId(java.lang.String id)

Sets the message id.

Specified by:

setMessageId in interface ISingleMessageStep

Parameters:

id - The id of the message of interest

getMessageId

public java.lang.String getMessageId()

Specified by:

getMessageId in interface ISingleMessageStep

verifyParameters

protected void verifyParameters()

Verifies the parameters

Overrides:

verifyParameters in class AbstractStoreStep

processContent

protected java.lang.String processContent(javax.mail.Folder folder)
                                   throws javax.mail.MessagingException

Specified by:

processContent in class AbstractStoreStep

Throws:

javax.mail.MessagingException

performOperation

protected abstract java.lang.String performOperation(javax.mail.Message message)
                                              throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException