votorola.a

Class VoteServer

java.lang.Object

VoteServer

@ThreadSafe
public final class VoteServer
extends Object

A server that provides polls and other voter services.

See Also:

../s/manual.xht#vote-server

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VoteServer.ConstructionContext A context for configuring the construction of a VoteServer.
static class	VoteServer.DatabaseCC A context for configuring the construction of a vote-server Database.
class	VoteServer.Run A run of the vote-server.
static class	VoteServer.TestUseMode A mode of test usage for a vote-server.

Constructor Summary

Constructors

Constructor and Description
VoteServer(String name) Constructs a VoteServer.

Method Summary

Methods

Modifier and Type	Method and Description
File	codeDirectory() The directory ~/votorola/code in which vote-server's runtime code is stored.
DiffCache	diffCache() The cache of diff output.
File	inDirectory() The base directory ~/votorola/in of the file portion of the input store.
String	name() The login name of the local host account, under which the vote-server's data is stored and its processes are run.
File	outDirectory() The base directory ~/votorola/out of the file portion of the output store.
PollwikiVS	pollwiki() The pollwiki associated with this vote-server.
Count.VoteServerScope	scopeCount() API for all counts within the scope of this vote-server.
PollService.VoteServerScope	scopePoll() API for all polls within the scope of this vote-server.
NetworkTrace.VoteServerScope	scopeTrace() API for all traces of trust networks within the scope of this vote-server.
String	serverName() The name of the computer on which this vote-server is hosted.
String	shortTitle() A short version of the title, restricted to roughly SHORT_STRING_LENGTH_MAX characters.
(package private) File	startupConfigurationFile() The startup configuration file for this vote-server.
String	summaryDescription() A brief description of this vote-server, in sentence form.
VoteServer.TestUseMode	testUseMode() The test use mode of this vote-server, which determines whether users may log in under aliases for test purposes.
String	title() The title of this vote-server, in wiki-style (first word only) title case.
File	votorolaDirectory() The base directory ~/votorola of all vote-server configuration files, where ~ is the home directory of the vote-server account.
URI	votorolaURI() The public location of the votorola directory without a trailing slash (/), or a local "file" URI if the directory is unpublished.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoteServer

public VoteServer(String name)
           throws IOException,
                  ScriptException,
                  URISyntaxException

Constructs a VoteServer.

Throws:

IOException

ScriptException

URISyntaxException

Method Detail

codeDirectory

public File codeDirectory()

The directory ~/votorola/code in which vote-server's runtime code is stored.

diffCache

public DiffCache diffCache()

The cache of diff output.

inDirectory

public File inDirectory()

The base directory ~/votorola/in of the file portion of the input store. It serves mostly as a cache of files fetched from external sources.

See Also:

InputStore

name

public String name()

The login name of the local host account, under which the vote-server's data is stored and its processes are run.

See Also:

serverName(), ../s/manual.xht#vote-server-name

outDirectory

public File outDirectory()

The base directory ~/votorola/out of the file portion of the output store.

See Also:

OutputStore

pollwiki

public PollwikiVS pollwiki()

The pollwiki associated with this vote-server.

scopeCount

public Count.VoteServerScope scopeCount()

API for all counts within the scope of this vote-server.

scopePoll

public PollService.VoteServerScope scopePoll()

API for all polls within the scope of this vote-server.

scopeTrace

public NetworkTrace.VoteServerScope scopeTrace()

API for all traces of trust networks within the scope of this vote-server.

serverName

public String serverName()

The name of the computer on which this vote-server is hosted. For example "localhost", "hostname" or (fully qualified) "hostname.mydomain.dom". It is used to construct service and return email addresses for the various "serviceEmail" methods. It is also used to construct the default URL to the wiki. In a public facing server, this should be a fully qualified name.

See Also:

name(), VoteServer.ConstructionContext.setServerName(String)

shortTitle

public String shortTitle()

A short version of the title, restricted to roughly SHORT_STRING_LENGTH_MAX characters. For example, "Toronto".

See Also:

title(), VoteServer.ConstructionContext.setTitle(String,String)

startupConfigurationFile

File startupConfigurationFile()

The startup configuration file for this vote-server. It is located at:

votorolaDirectory/vote-server.js

The language is JavaScript. There are restrictions on the character encoding.

summaryDescription

public String summaryDescription()

A brief description of this vote-server, in sentence form. It is intended for display, for example, as an introductory paragraph.

See Also:

VoteServer.ConstructionContext.setSummaryDescription(String)

testUseMode

public VoteServer.TestUseMode testUseMode()

The test use mode of this vote-server, which determines whether users may log in under aliases for test purposes.

See Also:

VoteServer.ConstructionContext.setTestUseMode(VoteServer.TestUseMode)

title

public String title()

The title of this vote-server, in wiki-style (first word only) title case. If the vote-server serves a single deployment area, such as a town or region, then it will normally take the title of that area. For example, "City of Toronto".

See Also:

shortTitle(), VoteServer.ConstructionContext.setTitle(String,String), Deployment areas

votorolaDirectory

public File votorolaDirectory()

The base directory ~/votorola of all vote-server configuration files, where ~ is the home directory of the vote-server account.

votorolaURI

public URI votorolaURI()

The public location of the votorola directory without a trailing slash (/), or a local "file" URI if the directory is unpublished. Not all files within the directory are necessarily visible or readable by everyone.

See Also:

VoteServer.ConstructionContext.setVotorolaLocation(String), VoteServer.ConstructionContext.setVotorolaURI(URI)