votorola.a

Class VoterInputTable<S extends VoterService>

java.lang.Object

VoterInputTable<S>

Direct Known Subclasses:

InputTable

@ThreadSafe
public abstract class VoterInputTable<S extends VoterService>
extends Object

The input table of a voter service, storing its voter input in a relational form. Multiple services may share a single physical table. The columnar structure is fixed by the use of a single 'xml' column.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VoterInputTable.BadInputException Thrown when voter input is unacceptable for storage.
static class	VoterInputTable.XMLColumnAppender An XML column appender for a voter input table.
static class	VoterInputTable.XMLColumnBuilder An XML column appender for a voter input table that sinks to a string builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected Database	database
static int	MAX_INPUT_LENGTH Maximum length of a single input string, in characters.
protected String	statementKeyBase
protected String	tableName
protected S	voterService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VoterInputTable(S _voterService, String _tableName) Partially constructs a VoterInputTable.

Method Summary

Methods

Modifier and Type	Method and Description
Database	database() The database in which this table is stored.
void	delete(String voterEmail) Removes a voter's data from the table if any is stored there.
String	get(String voterEmail) Retrieves a voter's data from the 'xml' column.
void	init() Finishes constructing a VoterInputTable, physically creating it if it does not already exist.
static String	lengthConstrained(String inputString) Throws a BadInputException if the input string is longer than MAX_INPUT_LENGTH; otherwise returns the same input string.
VotorolaRuntimeException	newUnparseableInputException(String voterEmail, String xml, XMLStreamException nestedException) Constructs an exception that complains about "unparseable data from input table...".
void	put(String voterEmail, String xml, ServiceSession userSession) Stores a voter's data to the 'xml' column.
String	tableName() The name of this table (relation).
static void	testAccessAllowed(String voterEmail, ServiceSession userSession) Throws a VotorolaSecurityException if voterEmail is unequal to userSession.userEmail().
S	voterService() Returns the service whose voter input this table stores.

Methods inherited from class java.lang.Object

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

Field Detail

database

protected final Database database

MAX_INPUT_LENGTH

public static final int MAX_INPUT_LENGTH

Maximum length of a single input string, in characters. This limit is imposed in order to guard against attacks centered on the input of large strings.

See Also:

Constant Field Values

tableName

protected final String tableName

voterService

protected final S extends VoterService voterService

statementKeyBase

protected final String statementKeyBase

Constructor Detail

VoterInputTable

protected VoterInputTable(S _voterService,
               String _tableName)

Partially constructs a VoterInputTable.

See Also:

tableName(), voterService(), init()

Method Detail

init

public void init()
          throws SQLException

Finishes constructing a VoterInputTable, physically creating it if it does not already exist.

Throws:

SQLException

database

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

The database in which this table is stored.

See Also:

VoteServer.Run.database()

delete

public void delete(String voterEmail)
            throws SQLException

Removes a voter's data from the table if any is stored there.

Throws:

SQLException

get

public String get(String voterEmail)
           throws SQLException

Retrieves a voter's data from the 'xml' column.

Returns:

the data, or null if the table has no such voter.

Throws:

SQLException

lengthConstrained

public static String lengthConstrained(String inputString)
                                throws VoterInputTable.BadInputException

Throws a BadInputException if the input string is longer than MAX_INPUT_LENGTH; otherwise returns the same input string.

Throws:

VoterInputTable.BadInputException

newUnparseableInputException

public final VotorolaRuntimeException newUnparseableInputException(String voterEmail,
                                                    String xml,
                                                    XMLStreamException nestedException)

Constructs an exception that complains about "unparseable data from input table...".

put

public void put(String voterEmail,
       String xml,
       ServiceSession userSession)
         throws VoterInputTable.BadInputException,
                SQLException

Stores a voter's data to the 'xml' column.

Parameters:

xml - the data to store.

userSession - the session of the user requesting the change, or null if the change is not user requested.

Throws:

VotorolaSecurityException - if userSession is specified, and voterEmail is unequal to userSession.userEmail(). This is a failsafe bug trap.

VoterInputTable.BadInputException

SQLException

tableName

public final String tableName()

The name of this table (relation). It conventionally begins with the prefix "in_", as for example "in_vote".

testAccessAllowed

public static void testAccessAllowed(String voterEmail,
                     ServiceSession userSession)
                              throws VotorolaSecurityException

Throws a VotorolaSecurityException if voterEmail is unequal to userSession.userEmail().

Throws:

VotorolaSecurityException

voterService

public S voterService()

Returns the service whose voter input this table stores.