votorola.a

Class VoterService

java.lang.Object

VoterService

Direct Known Subclasses:

MailMetaService, PollService, Trustserver

@ThreadRestricted(value="holds lock()")
public abstract class VoterService
extends Object

A facility for voters to access and maintain a category of data on a vote-server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VoterService.ConstructionContext A context for configuring a voter serivce.
static class	VoterService.IllegalNameException Thrown when a service with an illegal name is requested.
static class	VoterService.NoSuchServiceException Thrown when an unknown voter service is requested.

Field Summary

Fields

Modifier and Type	Field and Description
protected VoterService.ConstructionContext	constructionContext Stored as a convenience for subclass initialization, may be nulled afterwards by subclass.
protected ReentrantLock	lock
protected String	name
static int	NAME_MAX_LENGTH The maximum length of a service name.
static Pattern	NAME_PATTERN The allowable pattern of a service name.
protected VoteServer.Run	vsRun

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VoterService(VoteServer.Run _vsRun, VoterService.ConstructionContext cc) Partially creates a VoterService.

Method Summary

Methods

Modifier and Type	Method and Description
Exception	dispatch(String[] argArray, CommandResponder.Session commandSession) Looks up the responder of the specified command, and sends the command to it.
Exception	dispatch(String[] argArray, CommandResponder.Session commandSession, CommandResponder responder) Sends a command to its responder, if one is specified.
boolean	equals(Object o) Returns true iff o is a voter service of the same class with the same name.
Exception	help(String[] argv, CommandResponder.Session session) Responds to a help command on behalf of the nominal responder, per respond(argv,session).
protected void	helpA_1(CommandResponder.Session session)
protected void	helpA_2(CommandResponder.Session session)
protected void	helpA_3(CommandResponder.Session session)
protected void	helpA(CommandResponder.Session session)
protected void	helpB(CommandResponder.Session session)
protected void	helpC(CommandResponder.Session session)
protected void	init(ArrayList<CommandResponder> responderList)
static boolean	isNonPoll(String name) Answers whether the named service is (or would be) a non-poll service.
ReentrantLock	lock() Returns the thread access lock for this service.
String	name() The local name of this service.
CommandResponder	responderByClassName(String className) Returns the responder of a particular class name, or null if there is none.
CommandResponder	responderForCommand(String[] argArray, CommandResponder.Session commandSession) Returns the responder for the specified command, or null if there is none.
CommandResponder[]	responders() An array of all responders.
File	serviceDirectory() The directory containing this service's configuration files.
abstract File	startupConfigurationFile() The startup configuration file for this service.
abstract String	summaryDescription() A short description that summarizes this service.
abstract String	title() The title of this service in wiki-style title case.
String	toString() Returns the service name.
VoteServer.Run	vsRun() The vote-server run, in which this service is provided.

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected final ReentrantLock lock

name

protected final String name

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

The maximum length of a service name.

See Also:

name(), zelea.com/w/Category:Poll, Constant Field Values

NAME_PATTERN

public static final Pattern NAME_PATTERN

The allowable pattern of a service name. The name may contain the ASCII letters (A-Z, a-z), digits (0-9), and the punctuation characters underscore (_), slash (/), period (.) and dash (-). It must begin with a letter or an underscore, and must not end with a slash. Double slashes are not allowed.

See Also:

name(), zelea.com/w/Category:Poll

vsRun

protected final VoteServer.Run vsRun

constructionContext

protected VoterService.ConstructionContext constructionContext

Stored as a convenience for subclass initialization, may be nulled afterwards by subclass.

Constructor Detail

VoterService

protected VoterService(VoteServer.Run _vsRun,
            VoterService.ConstructionContext cc)

Partially creates a VoterService. To complete it, call init(responderList).

Method Detail

init

@ThreadRestricted(value="constructor")
protected final void init(ArrayList<CommandResponder> responderList)

Parameters:

responderList - listing only the service-specific responders; the general responders will be added by this method.

dispatch

public Exception dispatch(String[] argArray,
                 CommandResponder.Session commandSession)

Looks up the responder of the specified command, and sends the command to it. Or, if the look-up fails, replies that the command is unrecognized.

Parameters:

argArray - an array containing the command name and arguments, per CommandResponder.respond(argv,session).

Returns:

any soft exception, per CommandResponder.respond(argv,session); or null if none occured.

See Also:

CommandResponder.respond(String[],CommandResponder.Session)

dispatch

public final Exception dispatch(String[] argArray,
                 CommandResponder.Session commandSession,
                 CommandResponder responder)

Sends a command to its responder, if one is specified. Or, if none is specified, replies that the command is unrecognized.

Parameters:

argArray - an array containing the command name and arguments, per CommandResponder.respond(argv,session).

responder - the responder for the command, or null if there is none.

Returns:

any soft exception, per CommandResponder.respond(argv,session); or null if none occured.

See Also:

responderForCommand(String[],CommandResponder.Session), CommandResponder.respond(String[],CommandResponder.Session)

help

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

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

isNonPoll

public static boolean isNonPoll(String name)

Answers whether the named service is (or would be) a non-poll service. Currently the names of non-poll services always begin with a lowercase letter, whereas the names of polls never do. This is not guaranteed to hold in future, but you are safe so long as this is your test method.

lock

public final ReentrantLock lock()

Returns the thread access lock for this service. Locking order: first lock the poll, then lock the trustserver.

See Also:

VoteServer.Run.singleServiceLock()

name

@ThreadSafe
public final String name()

The local name of this service. It must be unique among all voter services of the vote-server. It must never change.

See Also:

NAME_MAX_LENGTH, NAME_PATTERN

vsRun

@ThreadSafe
public final VoteServer.Run vsRun()

The vote-server run, in which this service is provided.

responderByClassName

public final CommandResponder responderByClassName(String className)

Returns the responder of a particular class name, or null if there is none.

responderForCommand

public final CommandResponder responderForCommand(String[] argArray,
                                   CommandResponder.Session commandSession)

Returns the responder for the specified command, or null if there is none.

Parameters:

argArray - array of command name and arguments, per CommandResponder.respond(argv,session).

responders

public final CommandResponder[] responders()

An array of all responders.

serviceDirectory

@ThreadSafe
public final File serviceDirectory()

The directory containing this service's configuration files.

startupConfigurationFile

@ThreadSafe
public abstract File startupConfigurationFile()

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

summaryDescription

public abstract String summaryDescription()

A short description that summarizes this service.

See Also:

Pollwiki Property:Short_description

title

public abstract String title()

The title of this service in wiki-style title case. In English, that typically means only the first letter of the leading word is capitalized.

equals

@ThreadSafe
public final boolean equals(Object o)

Returns true iff o is a voter service of the same class with the same name.

Overrides:

equals in class Object

toString

@ThreadSafe
public final String toString()

Returns the service name.

Overrides:

toString in class Object

helpA

protected final void helpA(CommandResponder.Session session)

helpA_1

protected final void helpA_1(CommandResponder.Session session)

helpA_2

protected void helpA_2(CommandResponder.Session session)

helpA_3

protected final void helpA_3(CommandResponder.Session session)

helpB

protected final void helpB(CommandResponder.Session session)

helpC

protected final void helpC(CommandResponder.Session session)