Module org.bzdev.ejws

Package org.bzdev.ejws

Class EjwsUserTable<A extends EjwsAuthenticator,E extends EjwsAuthenticator.Entry>

java.lang.Object

org.bzdev.ejws.EjwsUserTable<A,E>

Direct Known Subclasses:

GPGSecureBasicUT

public class EjwsUserTable<A extends EjwsAuthenticator,E extends EjwsAuthenticator.Entry>
extends Object

Default user-table implementation. This class is used by subclasses of EjwsAuthenticator to manage a map that associates user names with entries used by an authenticator. It provides the operations needed by EjwsBasicAuthenticator and EjwsSecureBasicAuth, which require a simpler API than instances of Map provides.

Subclasses of this class can be written so that user data is stored in a database, or whatever type of persistent storage is desired. A sublcass should override hasDB() so that it will always return true. A subclass should also override the following protected methods:

• loadEntriesFromDB(Map). This method will load the current map with entries from persistent storage.
• getEntryFromDB(E, java.lang.String). This method will fetch an entry from persistent storage.
• createEntryFromDB(String). This method creates a new entry based on data in persistent storage.
• copyEntryToDB(String,EjwsAuthenticator.Entry,boolean). This method will add an entry to persistent storage.
• removeEntryFromDB(java.lang.String). This method will remove an entry from persistent storage.

In all three cases, the first argument is a string providing a user name, often an email address.

Constructor Summary

Constructors

Constructor	Description
EjwsUserTable()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	copyEntryToDB(String user, E entry, boolean newEntry)	Add an entry to persistent storage.
protected void	createEntryFromDB(String user)	Create an entry corresponding to the data in persistent storage.
protected A	getAuthenticator()	Get the authenticator that uses this EjwsUserTable.
final E	getEntry(String user)	Get an entry.
protected E	getEntryFromDB(E oldEntry, String user)	Get an entry corresponding to the data in persistent storage.
Set<String>	getRoles(String user)	Get the roles for a user.
protected boolean	hasDB()	Determine if persistent storage exists.
protected void	loadEntriesFromDB(Map<String,E> map)	Set up the map based on information in persistent storage.
final boolean	makeActive(String user)
protected void	makeActiveInDB(String user)
final boolean	putEntry(String user, E entry)	Add or replace an entry.
final boolean	removeEntry(String user)	Remove an entry.
protected void	removeEntryFromDB(String user)	Remove an entry from persistent storage.
void	setAuth(A auth)	Set the authenticator that uses this EjwsUserTable.
void	setMap(Map<String,E> map)	Set the user-table's map.
final boolean	updateEntry(String user)	Update an entry in the map.

Methods inherited from class java.lang.Object

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

Constructor Details

EjwsUserTable

public EjwsUserTable()

Constructor.

Method Details

setMap

public void setMap(Map<String,E> map)

Set the user-table's map. This method is called by EjwsBasicAuthenticator.setUserTable(org.bzdev.ejws.EjwsUserTable<org.bzdev.ejws.EjwsBasicAuthenticator, org.bzdev.ejws.EjwsBasicAuthenticator.Entry>) and EjwsSecureBasicAuth.setUserTable(org.bzdev.ejws.EjwsUserTable<org.bzdev.ejws.EjwsSecureBasicAuth, org.bzdev.ejws.EjwsSecureBasicAuth.Entry>).

Parameters:

map - the map

setAuth

public void setAuth(A auth)

Set the authenticator that uses this EjwsUserTable. This method is called by EjwsBasicAuthenticator.setUserTable(org.bzdev.ejws.EjwsUserTable<org.bzdev.ejws.EjwsBasicAuthenticator, org.bzdev.ejws.EjwsBasicAuthenticator.Entry>) and EjwsSecureBasicAuth.setUserTable(org.bzdev.ejws.EjwsUserTable<org.bzdev.ejws.EjwsSecureBasicAuth, org.bzdev.ejws.EjwsSecureBasicAuth.Entry>).

Parameters:

auth - the authenticator;

getAuthenticator

protected A getAuthenticator()

Get the authenticator that uses this EjwsUserTable.

Returns:

the authenticator.

getRoles

public Set<String> getRoles(String user)

Get the roles for a user.

Returns:

the roles; null or an empty set if there are no roles

getEntry

public final E getEntry(String user)

Get an entry. The value returned will be the entry in the map passed to the constructor. Instead of using this method, one can look up the entry directly from the map.

Parameters:

user - the user name

Returns:

the entry

putEntry

public final boolean putEntry(String user,
 E entry)

Add or replace an entry. Typically, one will call getEntry(java.lang.String), modify the entry this method returns, and then call putEntry(String,Entry) to update the value. If the operation fails this authenticator's map will be restored to its previous value.

Parameters:

user - the user name

entry - the new entry

Returns:

true if successful; false if the operation failed.

makeActive

public final boolean makeActive(String user)

updateEntry

public final boolean updateEntry(String user)

Update an entry in the map. This method should be called when data in persistent storage for the given user has changed—otherwise the persistent storage and the corresponding authentication will be inconsistent.

If a new user is created by modifying persistent storage, this method will make that new user available to an authenticator. The protected method getEntryFromDB(EjwsAuthenticator.Entry,String) is used to obtain the entry, and if that value is null, the user is removed from the map; otherwise the map is updated, either replacing an existing entry or creating a new one.

Parameters:

user - the user name

removeEntry

public final boolean removeEntry(String user)

Remove an entry.

Parameters:

user - the user name

Returns:

true on success; false on failure

loadEntriesFromDB

protected void loadEntriesFromDB(Map<String,E> map)
                          throws Exception

Set up the map based on information in persistent storage. This method is called by setMap(java.util.Map<java.lang.String, E>).

Parameters:

map - the map

Throws:

Exception

createEntryFromDB

protected void createEntryFromDB(String user)
                          throws Exception

Create an entry corresponding to the data in persistent storage.

Subclasses for which hasDB() returns true must override this method.

Parameters:

user - the user name

Throws:

Exception

getEntryFromDB

protected E getEntryFromDB(E oldEntry,
 String user)
                    throws Exception

Get an entry corresponding to the data in persistent storage.

Subclasses for which hasDB() returns true must override this method.

Parameters:

user - the user name

Returns:

the entry; null if there is none in persistent storage

Throws:

Exception

makeActiveInDB

protected void makeActiveInDB(String user)
                       throws Exception

Throws:

Exception

copyEntryToDB

protected void copyEntryToDB(String user,
 E entry,
 boolean newEntry)
                      throws Exception

Add an entry to persistent storage. This method will be used to create a new entry and to modify an existing one.

Subclasses for which hasDB() returns true must override this method.

Parameters:

user - the user name

entry - the entry

newEntry - true if the local map did not have an existing entry; false if it had an existing entry

Throws:

Exception - if an error occurred, in which case the previous value in persistent storage should not be changed.

removeEntryFromDB

protected void removeEntryFromDB(String user)
                          throws Exception

Remove an entry from persistent storage.

Subclasses for which hasDB() returns true must override this method.

Parameters:

user - the user name

Throws:

Exception

hasDB

protected boolean hasDB()

Determine if persistent storage exists. For a given instance of EjwsUserTable, this method should always return the same value.

Returns:

true if persistent storage exists; false otherwise.