votorola.s.mail

Class VOFaceMail

java.lang.Object

VOFaceMail

All Implemented Interfaces:

Runnable, VoterInterface

@ThreadSafe
public final class VOFaceMail
extends Object
implements Runnable, VoterInterface

The mail-based voter interface (mail interface).

See Also:

main(String[]), ../../s/manual.xht#mail

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VOFaceMail.ConstructionContext A context for configuring the mail interface.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) VOFaceMail.ConstructionContext	cc

Method Summary

Methods

Modifier and Type	Method and Description
static JavaScriptIncluder	compileConfigurationScript(VoteServer voteServer) Executes the configuration script of the mail interface (without making any configuration calls), thus compiling it for subsequent use.
(package private) static VOFaceMail	i() The single instance of VOFaceMail, if it was created.
(package private) int	inboxPollSleepSeconds() The delay prior to each poll of the inbox for new messages.
(package private) URLName	inboxStoreURLName() The protocol and location of the inbox.
(package private) boolean	isDryRun() Returns true if this interface is to run without making any persistent state changes.
static void	main(String[] argv) Creates the mail interface from the command line, and starts it.
void	run()
String	serviceAccessDescriptor(VoterService s) Constructs an access descriptor, such as a URL or email address, that is suitable for accessing the specified voter service within this voter interface.
(package private) File	startupConfigurationFile() The startup configuration file for this mail interface.
(package private) CountDownLatchX	stopLatch() A latch that zeroes when this interface is stopping.

Methods inherited from class java.lang.Object

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

Field Detail

cc

VOFaceMail.ConstructionContext cc

Method Detail

main

public static void main(String[] argv)

Creates the mail interface from the command line, and starts it.

Parameters:

argv - the command line argument array.

See Also:

i(), voface-mail

i

static VOFaceMail i()

The single instance of VOFaceMail, if it was created.

compileConfigurationScript

public static JavaScriptIncluder compileConfigurationScript(VoteServer voteServer)
                                                     throws IOException,
                                                            ScriptException

Executes the configuration script of the mail interface (without making any configuration calls), thus compiling it for subsequent use.

Throws:

IOException

ScriptException

inboxPollSleepSeconds

int inboxPollSleepSeconds()

The delay prior to each poll of the inbox for new messages. If the inbox gets busy, then this value is ignored and messages are read without delay.

See Also:

VOFaceMail.ConstructionContext.setInboxPollSleepSeconds(int)

inboxStoreURLName

URLName inboxStoreURLName()

The protocol and location of the inbox. Supported protocols are IMAP, Maildir and POP3. For example:

"imap:?" (actually, we're unsure of IMAP syntax, and have not tested it), per:
   http://java.sun.com/products/javamail/javadocs/com/sun/mail/imap/package-summary.html

 "maildir:/home/vote-serverName/.mail"
   http://javamaildir.sourceforge.net/

 "pop3://vote-serverName:password@host:port" (not yet tested), per:
   http://java.sun.com/products/javamail/javadocs/com/sun/mail/pop3/package-summary.html

See Also:

VOFaceMail.ConstructionContext.setInboxStoreURLName(String)

isDryRun

boolean isDryRun()

Returns true if this interface is to run without making any persistent state changes. It will run as usual, in that case, but without actually writing to any database; nor replying to any incoming message; nor altering any other significant state that would persist and affect the next run.

Consequently, each dry run will read the messages of the inbox over and over again, in an endless loop.

See Also:

VOFaceMail.ConstructionContext.setDryRun(boolean)

startupConfigurationFile

File startupConfigurationFile()

The startup configuration file for this mail interface. The language is JavaScript. There are restrictions on the character encoding.

See Also:

../manual.xht#voface-mail.js

serviceAccessDescriptor

public String serviceAccessDescriptor(VoterService s)

Description copied from interface: VoterInterface

Constructs an access descriptor, such as a URL or email address, that is suitable for accessing the specified voter service within this voter interface.

Specified by:

serviceAccessDescriptor in interface VoterInterface

Returns:

descriptive email address of s, including a personal part

See Also:

MailMetaService.serviceEmail(VoterService)

stopLatch

CountDownLatchX stopLatch()

A latch that zeroes when this interface is stopping.

run

public void run()

Specified by:

run in interface Runnable