com.canoo.webtest.plugins.emailtest
Class EmailStoreHeader

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

All Implemented Interfaces:

ISingleMessageStep, Serializable, Cloneable

public class EmailStoreHeader
extends AbstractMessageStoreStep

Stores the value of a header field within a message (or within a message part).

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

EmailStoreHeader()

Method Summary

String	getHeaderName()
String	getPartIndex()
protected String	performOperation(javax.mail.Message message) Calculate the result.
void	setHeaderName(String headerName) Sets the name of the header of interest.
void	setPartIndex(String partIndex) Sets the part index.
protected void	verifyParameters() Verifies the parameters

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

getMessageId, processContent, setMessageId

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

EmailStoreHeader

public EmailStoreHeader()

Method Detail

getHeaderName

public String getHeaderName()

setHeaderName

public void setHeaderName(String headerName)

Sets the name of the header of interest.

Parameters:

headerName - The header name

getPartIndex

public String getPartIndex()

setPartIndex

public void setPartIndex(String partIndex)

Sets the part index.

Parameters:

partIndex - The message part of interest

performOperation

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

Calculate the result.

Specified by:

performOperation in class AbstractMessageStoreStep

Parameters:

message -

Returns:

The result

Throws:

javax.mail.MessagingException

verifyParameters

protected void verifyParameters()

Description copied from class: AbstractMessageStoreStep

Verifies the parameters

Overrides:

verifyParameters in class AbstractMessageStoreStep