votorola.s.mail

Class VOFaceMail.ConstructionContext

java.lang.Object

VOFaceMail.ConstructionContext

Enclosing class:

VOFaceMail

@ThreadSafe
public static final class VOFaceMail.ConstructionContext
extends Object

A context for configuring the mail interface. The interface is configured by the responder's startup configuration file, which contains a script (s) for that purpose. During construction of the interface, an instance of this context (mailCC) is passed to s, via s::constructingVOFaceMail(mailCC).

Method Summary

Methods

Modifier and Type	Method and Description
static VOFaceMail.ConstructionContext	configure(VoteServer voteServer, JavaScriptIncluder s) Constructs the complete configuration of the mail interface.
int	getInboxPollSleepSeconds()
String	getInboxStoreURLName()
boolean	isDryRun()
void	setDryRun(boolean newDryRun) Sets whether the interface is to run without making any persistent state changes.
void	setInboxPollSleepSeconds(int inboxPollSleepSeconds) Sets the delay prior to each poll of the inbox.
void	setInboxStoreURLName(String inboxStoreURLName) Sets the protocol and location of the inbox.
SMTPTransportX.ConstructionContext	transferService() The context for configuring access to the mail transfer server, through which outgoing messages (such as replies to voters) are sent.

Methods inherited from class java.lang.Object

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

Method Detail

configure

public static VOFaceMail.ConstructionContext configure(VoteServer voteServer,
                                       JavaScriptIncluder s)
                                                throws ScriptException

Constructs the complete configuration of the mail interface.

Parameters:

s - the compiled startup configuration script.

Throws:

ScriptException

getInboxPollSleepSeconds

public int getInboxPollSleepSeconds()

See Also:

VOFaceMail.inboxPollSleepSeconds(), setInboxPollSleepSeconds(int)

setInboxPollSleepSeconds

@ThreadRestricted(value="constructor")
public void setInboxPollSleepSeconds(int inboxPollSleepSeconds)

Sets the delay prior to each poll of the inbox. The default value is 20 seconds.

See Also:

VOFaceMail.inboxPollSleepSeconds()

getInboxStoreURLName

public String getInboxStoreURLName()

See Also:

VOFaceMail.inboxStoreURLName(), setInboxStoreURLName(String)

setInboxStoreURLName

@ThreadRestricted(value="constructor")
public void setInboxStoreURLName(String inboxStoreURLName)

Sets the protocol and location of the inbox. The default value is "maildir:/home/vote-server-name/Maildir".

"maildir:/home/" + voteServer.name() + "/Maildir"

See Also:

VOFaceMail.inboxStoreURLName()

isDryRun

public final boolean isDryRun()

See Also:

VOFaceMail.isDryRun(), setDryRun(boolean)

setDryRun

public final void setDryRun(boolean newDryRun)

Sets whether the interface is to run without making any persistent state changes.

See Also:

VOFaceMail.isDryRun()

transferService

public SMTPTransportX.ConstructionContext transferService()

The context for configuring access to the mail transfer server, through which outgoing messages (such as replies to voters) are sent.