com.canoo.webtest.plugins.emailtest
Class EmailStoreMessageId

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.AbstractSelectStep
                          com.canoo.webtest.plugins.emailtest.EmailStoreMessageId

All Implemented Interfaces:

Serializable, Cloneable

public class EmailStoreMessageId
extends AbstractSelectStep

Stores the message's id into a property.

Author:

Paul King, ASERT

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

EmailStoreMessageId()

Method Summary

String	getMessageIndex()
protected String	processContent(javax.mail.Folder folder) Calculate the message id
void	setMessageIndex(String index) Sets the message index.
protected void	verifyParameters() Verifies the parameters

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

getCc, getFrom, getReplyTo, getSubject, getTo, isRegexMatch, retrieveMatchingMessages, setCc, setFrom, setReplyTo, setSubject, setTo

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

Constructor Detail

EmailStoreMessageId

public EmailStoreMessageId()

Method Detail

getMessageIndex

public String getMessageIndex()

setMessageIndex

public void setMessageIndex(String index)

Sets the message index.

Parameters:

index - The message index

processContent

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

Calculate the message id

Specified by:

processContent in class AbstractStoreStep

Parameters:

folder -

Returns:

The extracted count value

Throws:

javax.mail.MessagingException

verifyParameters

protected void verifyParameters()

Description copied from class: AbstractStoreStep

Verifies the parameters

Overrides:

verifyParameters in class AbstractStoreStep