votorola.s.mail

Class MailMetaService

java.lang.Object

VoterService

MailMetaService

@ThreadRestricted(value="holds lock()")
public final class MailMetaService
extends VoterService

The meta-service of the mail-based voter interface. It provides bootstrap instructions on accessing the voter services, as well as general information about the vote-server. In addition to replying to messages it receives at its own email address, it also replies to any misaddressed mail that lands in the inbox, and is not assignable to any other service.

See Also:

http://reluk.ca/project/votorola/s/mail/guide.xht#meta-service

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MailMetaService.ConstructionContext A context for configuring the mail interface's voter meta-service.

Nested classes/interfaces inherited from class VoterService

VoterService.IllegalNameException, VoterService.NoSuchServiceException

Field Summary

Fields inherited from class VoterService

constructionContext, lock, name, NAME_MAX_LENGTH, NAME_PATTERN, vsRun

Constructor Summary

Constructors

Constructor and Description
MailMetaService(VoteServer.Run run, MailMetaService.ConstructionContext cc)

Method Summary

Methods

Modifier and Type	Method and Description
Exception	help(String[] argv, CommandResponder.Session session) Responds to a help command on behalf of the nominal responder, per respond(argv,session).
static MailMetaService	newMetaService(VoteServer.Run vsRun, JavaScriptIncluder s) Constructs a MailMetaService.
JavaScriptIncluder	runtimeConfigurationScript() The runtime configuration file for this meta-service.
String	serviceEmail(VoterService service) Constructs the email address of a voter service.
String	serviceName(InternetAddress serviceEmail) Converts service email address into a service name.
File	startupConfigurationFile() The startup configuration file for this service.
String	summaryDescription() A brief description of this meta-service, same as the vote-server's.
String	title() The title of this meta-service, which is the same as the vote-server's title.

Methods inherited from class VoterService

dispatch, dispatch, equals, helpA_1, helpA_2, helpA_3, helpA, helpB, helpC, init, isNonPoll, lock, name, responderByClassName, responderForCommand, responders, serviceDirectory, toString, vsRun

Methods inherited from class java.lang.Object

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

Constructor Detail

MailMetaService

MailMetaService(VoteServer.Run run,
               MailMetaService.ConstructionContext cc)
          throws IOException,
                 ScriptException,
                 SQLException

Throws:

IOException

ScriptException

SQLException

Method Detail

newMetaService

@ThreadSafe
public static MailMetaService newMetaService(VoteServer.Run vsRun,
                                        JavaScriptIncluder s)
                                      throws IOException,
                                             ScriptException,
                                             SQLException

Constructs a MailMetaService.

Parameters:

s - the compiled startup configuration script

Throws:

IOException

ScriptException

SQLException

runtimeConfigurationScript

@Warning(value="thread restricted object, holds lock()")
public JavaScriptIncluder runtimeConfigurationScript()

The runtime configuration file for this meta-service. The language is JavaScript. There are restrictions on the character encoding.

See Also:

mail-meta-service-run.js (example script), ../manual.xht#mail-meta-service-run.js

serviceEmail

public String serviceEmail(VoterService service)

Constructs the email address of a voter service.

Returns:

canonical email address

See Also:

serviceName(InternetAddress), InternetAddressX.canonicalAddress(String)

serviceName

public String serviceName(InternetAddress serviceEmail)

Converts service email address into a service name.

See Also:

serviceEmail(VoterService)

help

public Exception help(String[] argv,
             CommandResponder.Session session)

Description copied from class: VoterService

Responds to a help command on behalf of the nominal responder, per respond(argv,session).

Overrides:

help in class VoterService

startupConfigurationFile

@ThreadSafe
public File startupConfigurationFile()

Description copied from class: VoterService

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

Specified by:

startupConfigurationFile in class VoterService

See Also:

../manual.xht#mail-meta-service.js

summaryDescription

public String summaryDescription()

A brief description of this meta-service, same as the vote-server's.

Specified by:

summaryDescription in class VoterService

See Also:

Pollwiki Property:Short_description

title

public String title()

The title of this meta-service, which is the same as the vote-server's title.

Specified by:

title in class VoterService