votorola.a

Class VoteServer.ConstructionContext

java.lang.Object

VoteServer.ConstructionContext

Enclosing class:

VoteServer

@ThreadSafe
public static final class VoteServer.ConstructionContext
extends Object

A context for configuring the construction of a VoteServer. The construction is configured by the vote-server's startup configuration file, which contains a script (s) for that purpose. During construction, an instance of this context (vsCC) is passed to s via s::constructingVoteServer(vsCC).

Method Summary

Methods

Modifier and Type	Method and Description
VoteServer.DatabaseCC	database() The context for configuring the vote-server's relational database.
int	getPollCacheCapacity()
String	getServerName()
String	getShortTitle()
String	getSummaryDescription()
VoteServer.TestUseMode	getTestUseMode()
String	getTitle()
URI	getVotorolaURI() The public location of the votorola directory, or null for the default.
String	name() The name of the vote-server.
PollwikiVS.ConstructionContext	pollwiki() The context for configuring the vote-server's pollwiki.
void	setPollCacheCapacity(int _pollCacheCapacity) Sets the maximum number of entries in the poll cache.
void	setServerName(String serverName) Specifies the fully qualified name of the computer on which this vote-server is hosted.
void	setSummaryDescription(String summaryDescription) Sets the summary description of the vote-server.
void	setTestUseMode(VoteServer.TestUseMode testUseMode) Sets the test use mode of the vote-server.
void	setTitle(String title, String shortTitle) Sets the title of the vote-server.
void	setVotorolaLocation(String s) Sets the public location of the votorola directory.
void	setVotorolaURI(URI u) Sets the public location of the votorola directory.

Methods inherited from class java.lang.Object

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

Method Detail

database

public VoteServer.DatabaseCC database()

The context for configuring the vote-server's relational database.

getPollCacheCapacity

public int getPollCacheCapacity()

See Also:

PollService.VoteServerScope.pollCacheCapacity(), setPollCacheCapacity(int)

setPollCacheCapacity

@ThreadRestricted(value="constructor")
public void setPollCacheCapacity(int _pollCacheCapacity)

Sets the maximum number of entries in the poll cache. The default value is 500 polls.

See Also:

PollService.VoteServerScope.pollCacheCapacity()

getServerName

public String getServerName()

See Also:

VoteServer.serverName(), setServerName(String)

setServerName

@ThreadRestricted(value="constructor")
public void setServerName(String serverName)

Specifies the fully qualified name of the computer on which this vote-server is hosted. The default value is the system hostname as determined at runtime, or failing that "localhost". It is recommended that you explicitly set "localhost" or a fully qualified name.

See Also:

VoteServer.serverName()

getShortTitle

public String getShortTitle()

See Also:

VoteServer.shortTitle(), setTitle(String,String)

getSummaryDescription

public String getSummaryDescription()

See Also:

VoteServer.summaryDescription(), setSummaryDescription(String)

setSummaryDescription

@ThreadRestricted(value="constructor")
public void setSummaryDescription(String summaryDescription)

Sets the summary description of the vote-server. The default value is a placeholder with configuration instructions for the administrator.

Throws:

IllegalArgumentException - if the description contains any newline characters, because they might render inconsistently across different types of user interface.

See Also:

VoteServer.summaryDescription()

getTestUseMode

public VoteServer.TestUseMode getTestUseMode()

See Also:

VoteServer.testUseMode(), setTestUseMode(VoteServer.TestUseMode)

setTestUseMode

@ThreadRestricted(value="constructor")
public void setTestUseMode(VoteServer.TestUseMode testUseMode)

Sets the test use mode of the vote-server. The default value is TestUseMode.OFF.

See Also:

VoteServer.testUseMode()

getTitle

public String getTitle()

See Also:

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

setTitle

@ThreadRestricted(value="constructor")
public void setTitle(String title,
                                  String shortTitle)

Sets the title of the vote-server. The default values for the long and short titles are "Votorola vote-server" and "Votorola".

See Also:

VoteServer.title(), VoteServer.shortTitle()

name

public String name()

The name of the vote-server.

See Also:

VoteServer.name()

pollwiki

public PollwikiVS.ConstructionContext pollwiki()

The context for configuring the vote-server's pollwiki.

getVotorolaURI

public URI getVotorolaURI()

The public location of the votorola directory, or null for the default.

See Also:

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

setVotorolaLocation

@ThreadRestricted(value="constructor")
public void setVotorolaLocation(String s)
                         throws URISyntaxException

Sets the public location of the votorola directory. The default value is null, which translates at runtime to a local "file" URI.

Throws:

IllegalArgumentException - if the URI ends with a slash '/' character.

URISyntaxException

See Also:

VoteServer.votorolaURI()

setVotorolaURI

@ThreadRestricted(value="constructor")
public void setVotorolaURI(URI u)

Sets the public location of the votorola directory. The default value is null, which translates at runtime to a local "file" URI.

Throws:

IllegalArgumentException - if the URI ends with a slash '/' character.

See Also:

VoteServer.votorolaURI()