votorola.a.voter

Class UserSettings

java.lang.Object

UserSettings

All Implemented Interfaces:

Serializable

@ThreadRestricted(value="touch")
public final class UserSettings
extends Object
implements Serializable

A user's service preferences and other settings backed by a row of the vote-server's user-settings table. Unlike the voter input of voter services which may be shared among multiple sites, the user settings are specific to a single vote-server. They may also contain private data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserSettings.Table The user-settings table of a vote-server, storing the settings in relational form.

Constructor Summary

Constructors

Constructor and Description
UserSettings(String voterEmail, UserSettings.Table table) Constructs a UserSettings, reading its initial state from the user table.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearOpenID() Clears the OpenID by setting it to null.
static UserSettings	forOpenID(String openID, UserSettings.Table table) Retrieves a user's settings from the table, doing the lookup by OpenID.
String	getLoginPersistKey() The secure hash of the user's persisted login.
String	getOpenID() An authenticated OpenID identifier for the user.
void	setLoginPersistKey(String newLoginPersistKey) Sets the secure hash of the user's persisted login.
void	setOpenID(Identifier verifiedID) Changes the OpenID, setting it to an authenticated value.
String	voterEmail() Identifies the user for voting purposes.
void	write(UserSettings.Table table, ServiceSession userSession) Writes these user settings to the table if they have unwritten changes, or deletes them if they are at default.
void	write(UserSettings.Table table, ServiceSession userSession, boolean toForce) Writes these user settings to the table, or deletes them if they are all at default.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSettings

public UserSettings(String voterEmail,
            UserSettings.Table table)
             throws SQLException

Constructs a UserSettings, reading its initial state from the user table.

Throws:

SQLException

See Also:

voterEmail()

Method Detail

forOpenID

public static UserSettings forOpenID(String openID,
                     UserSettings.Table table)
                              throws SQLException

Retrieves a user's settings from the table, doing the lookup by OpenID.

Returns:

user's settings, or null if the table has none.

Throws:

SQLException

See Also:

getOpenID()

getLoginPersistKey

public String getLoginPersistKey()

The secure hash of the user's persisted login.

Returns:

key, or null if the user's login is not persisted.

See Also:

setLoginPersistKey(String), OpenIDAuthenticator.newPersistKey(String,String)

setLoginPersistKey

public void setLoginPersistKey(String newLoginPersistKey)

Sets the secure hash of the user's persisted login.

See Also:

getLoginPersistKey()

getOpenID

public String getOpenID()

An authenticated OpenID identifier for the user.

Returns:

OpenID in canonical form, or null if none is set.

See Also:

clearOpenID(), setOpenID(Identifier)

clearOpenID

public void clearOpenID()

Clears the OpenID by setting it to null.

See Also:

getOpenID()

setOpenID

public void setOpenID(Identifier verifiedID)

Changes the OpenID, setting it to an authenticated value.

Parameters:

verifiedID - the verified identifier from the positive authentication result.

See Also:

getOpenID()

voterEmail

public String voterEmail()

Identifies the user for voting purposes. A user may have other identifiers for other purposes (such as OpenID for web login), but this email address is the primary identifier for voting purposes.

Returns:

canonical email address.

See Also:

InternetAddressX.canonicalAddress(String)

write

public void write(UserSettings.Table table,
         ServiceSession userSession)
           throws SQLException,
                  VoterInputTable.BadInputException

Writes these user settings to the table if they have unwritten changes, or deletes them if they are at default.

Throws:

SQLException

VoterInputTable.BadInputException

write

public void write(UserSettings.Table table,
         ServiceSession userSession,
         boolean toForce)
           throws SQLException,
                  VoterInputTable.BadInputException

Writes these user settings to the table, or deletes them if they are all at default.

Parameters:

toForce - false to write only if changes were made; true to force the write regardless.

Throws:

SQLException

VoterInputTable.BadInputException