votorola.a

Class VoteServer.Run

java.lang.Object

VoteServer.Run

Enclosing class:

VoteServer

@ThreadSafe
public final class VoteServer.Run
extends Object

A run of the vote-server.

Field Summary

Fields

Modifier and Type	Field and Description
AtomicReference<Thread>	constructionThreadA
(package private) ReentrantLock	singleServiceLock

Constructor Summary

Constructors

Constructor and Description
VoteServer.Run(boolean isSingleThreaded) Constructs a Run.

Method Summary

Methods

Modifier and Type	Method and Description
Database	database() The vote-server's relational database.
Geocode.Table	geocodeTable() The relational cache of geocoded residential addresses.
void	init_done() Records that initialization is complete - that no further calls will be made to init_ methods.
<S extends VoterService> S	init_ensureVoterService(File startupConfigurationFile, Class<S> serviceClass) Returns a voter service, creating it if necessary and storing it for later retrieval.
void	init_putVoterService(VoterService service) Stores a voter service in this run, for later retrieval.
boolean	isSingleThreaded() Returns true if this run is restricted to a single client thread, false if multiple client threads are allowed.
VoterService[]	newVoterServiceArray() Returns all non-poll voter services provided in this run.
PollService.VoteServerScope.Run	scopePoll() API for all polls within the scope of this vote-server run.
ReentrantLock	singleServiceLock() Returns the thread access lock shared by all services; or null if all services do not share the same lock.
Trustserver	trustserver() The trustserver for this vote-server.
UserSettings.Table	userTable() The relational store of service preferences and other settings, for the users of this vote-server.
VoterService	voterService(String name) Returns a non-poll voter service provided in this run; or null if the name designates no provided non-poll service.
VoteServer	voteServer() The vote-server for this run.

Methods inherited from class java.lang.Object

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

Field Detail

constructionThreadA

@Warning(value="non-API")
public final AtomicReference<Thread> constructionThreadA

singleServiceLock

final ReentrantLock singleServiceLock

Constructor Detail

VoteServer.Run

public VoteServer.Run(boolean isSingleThreaded)
               throws IOException,
                      ScriptException,
                      SQLException

Constructs a Run.

Parameters:

isSingleThreaded - per isSingleThreaded() - if false (multi-threaded), the client should call init_done() after initialization is complete.

Throws:

IOException

ScriptException

SQLException

Method Detail

init_done

public void init_done()

Records that initialization is complete - that no further calls will be made to init_ methods. Single-threaded clients need not call this method; it only enables thread-safety assertions in the init_ methods. [No longer true, as some late constructs will now throw an IllegalStateException if this method has not been called.]

init_ensureVoterService

@ThreadRestricted(value="constructor")
public <S extends VoterService> S init_ensureVoterService(File startupConfigurationFile,
                                                                       Class<S> serviceClass)
                                               throws IOException,
                                                      ScriptException,
                                                      SQLException

Returns a voter service, creating it if necessary and storing it for later retrieval.

Parameters:

startupConfigurationFile - the startup configuration file for the service.

serviceClass - the class of the service.

Throws:

VoterService.NoSuchServiceException - if startupConfigurationFile does not exist.

IOException

ScriptException

SQLException

See Also:

init_putVoterService(VoterService), voterService(String)

init_putVoterService

@ThreadRestricted(value="constructor")
public void init_putVoterService(VoterService service)

Stores a voter service in this run, for later retrieval.

Throws:

IllegalStateException - if an instance of the same service was already stored.

See Also:

voterService(String)

database

@Warning(value="thread restricted object")
public Database database()

The vote-server's relational database.

See Also:

VoteServer.ConstructionContext.database()

geocodeTable

public Geocode.Table geocodeTable()

The relational cache of geocoded residential addresses.

See Also:

VoteServer.ConstructionContext.database()

isSingleThreaded

public boolean isSingleThreaded()

Returns true if this run is restricted to a single client thread, false if multiple client threads are allowed.

newVoterServiceArray

public VoterService[] newVoterServiceArray()

Returns all non-poll voter services provided in this run.

Returns:

newly created array of voter services.

See Also:

voterService(String)

voteServer

public VoteServer voteServer()

The vote-server for this run.

scopePoll

public PollService.VoteServerScope.Run scopePoll()

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

singleServiceLock

public ReentrantLock singleServiceLock()

Returns the thread access lock shared by all services; or null if all services do not share the same lock. They share the same lock only if the run is single threaded.

See Also:

VoterService.lock()

trustserver

@Warning(value="thread restricted object")
public Trustserver trustserver()

The trustserver for this vote-server.

userTable

@Warning(value="thread restricted object")
public UserSettings.Table userTable()

The relational store of service preferences and other settings, for the users of this vote-server.

See Also:

VoteServer.ConstructionContext.database()

voterService

public VoterService voterService(String name)
                          throws IOException,
                                 ScriptException,
                                 SQLException

Returns a non-poll voter service provided in this run; or null if the name designates no provided non-poll service.

Parameters:

name - per VoterService.name().

Throws:

IOException

ScriptException

SQLException

See Also:

VoterService.isNonPoll(String), init_ensureVoterService(File,Class), newVoterServiceArray(), PollService.VoteServerScope.Run.ensurePoll(String)