cdx.scorebot.net.tests.email
Class Sendmail

java.lang.Object
  cdx.scorebot.net.tests.Test<EmailService>
      cdx.scorebot.net.tests.email.Sendmail

All Implemented Interfaces:

java.io.Serializable

public class Sendmail
extends Test<EmailService>
implements java.io.Serializable

tries to send an email

Author:

Sean Sullivan

See Also:

Serialized Form

Constructor Summary

	Sendmail(EmailService service) Instantiates a test (with no configuration) for the purpose of instantiating tests of this type with different configurations later.
protected	Sendmail(EmailService service, java.util.HashMap<java.lang.String,ConfigOption> config) Instantiates a test with the specified config (it will verify that it includes all needed configuration options).

Method Summary

protected java.util.HashMap<java.lang.String,ConfigOption>	getDefaultConfigValues() gets a key-value pair of what options are available for configuration
Test	instantiate(java.util.HashMap<java.lang.String,ConfigOption> config) Instantiates a test of this type with the specified config (verify that it includes all needed configuration options).
static void	main(java.lang.String[] args)
protected void	prepareDefaultResults(TestEvent results) give all results the test returns some default value
void	run(TestEvent results) run the test and put all results into results
void	verifyConfigValue(java.lang.String optionName, ConfigOption optionValue) Determine whether the specified configuration option is a valid value.

Methods inherited from class cdx.scorebot.net.tests.Test

equals, getConfig, getConfig, getDefaultConfigValuesCopy, getInitialConfigCopy, getService, run, setService, verifyConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Sendmail

public Sendmail(EmailService service)

Instantiates a test (with no configuration) for the purpose of instantiating tests of this type with different configurations later.

Parameters:

service - the service this test will run against

Sendmail

protected Sendmail(EmailService service,
                   java.util.HashMap<java.lang.String,ConfigOption> config)

Instantiates a test with the specified config (it will verify that it includes all needed configuration options).

Parameters:

service - the service this test will run against

config - the test configuration information used when the test is run (warning: these options may change when verified)

Method Detail

getDefaultConfigValues

protected java.util.HashMap<java.lang.String,ConfigOption> getDefaultConfigValues()

gets a key-value pair of what options are available for configuration

Specified by:

getDefaultConfigValues in class Test<EmailService>

Returns:

a key-value pair of what options are available for configuration

instantiate

public Test instantiate(java.util.HashMap<java.lang.String,ConfigOption> config)

Instantiates a test of this type with the specified config (verify that it includes all needed configuration options).

Specified by:

instantiate in class Test<EmailService>

Parameters:

config - the test configuration information used when the test is run (warning: these options may change when verified)

Returns:

a new instance of this Test with the specified configuration

prepareDefaultResults

protected void prepareDefaultResults(TestEvent results)

Description copied from class: Test

give all results the test returns some default value

Specified by:

prepareDefaultResults in class Test<EmailService>

run

public void run(TestEvent results)

run the test and put all results into results

Specified by:

run in class Test<EmailService>

Parameters:

results - the TestEvent into which all results will be stored

verifyConfigValue

public void verifyConfigValue(java.lang.String optionName,
                              ConfigOption optionValue)
                       throws TestMisconfigurationException

Determine whether the specified configuration option is a valid value.

Specified by:

verifyConfigValue in class Test<EmailService>

Parameters:

optionName - the name of the option (the key in the config HashMap)

optionValue - the value of the option (the value in the config HashMap)

Throws:

TestMisconfigurationException - thrown if a config value is invalid (the message describes the problem)

main

public static void main(java.lang.String[] args)