uk.ac.ed.epcc.webapp.session

Class AppUserNameFinder<AU extends AppUser,X extends AppUserNameFinder>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.Composite<AU,X>

uk.ac.ed.epcc.webapp.session.AppUserComposite<AU,X>

uk.ac.ed.epcc.webapp.session.AppUserNameFinder<AU,X>

Type Parameters:

AU - type of AppUser

X - registration type

All Implemented Interfaces:

Contexed, TableStructureContributer<AU>, ParseFactory<AU>

Direct Known Subclasses:

EmailNameFinder, FieldNameFinder, MultiNameFinder

public abstract class AppUserNameFinder<AU extends AppUser,X extends AppUserNameFinder>
extends AppUserComposite<AU,X>
implements ParseFactory<AU>

An Composite that implements the NameFinder logic for an AppUserFactory. These are included by composition in the AppUserFactory allowing multiple name schemes to be supported at the same time. AppUserNameFinders where userVisible() return false have to be explicitly requested and are not included in the AppUserFactory NameFinder implementation.

Though the normal operation of a AppUserNameFinder is to locate existing database records it is also possible to to have it query an external directory and lazily create database records.

Though a AppUserNameFinder normally only supports a single name per realm it can support many-to-one mappings for example Openid names where a user uses multiple identities.

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.Composite

fac

Constructor Summary

Constructors

Constructor and Description
AppUserNameFinder(AppUserFactory<AU> factory, java.lang.String realm)

Method Summary

Modifier and Type	Method and Description
abstract boolean	active() Checks if sufficient database fields exist to use this AppUserNameFinder An inactive finder still modifies the table specification but won't be retreivable as a realm.
AU	findFromString(java.lang.String name) Find an existing entry by name.
java.util.Set<java.lang.String>	getAllNames(AU user) Get all of the defined names for this realm.
DataCache<java.lang.String,AU>	getDataCache()
abstract java.lang.String	getNameLabel() Get a user presented label asking for the login name of the supported type.
java.lang.String	getRealm() Get the realm this finder applies to.
abstract SQLFilter<AU>	getStringFinderFilter(java.lang.Class<? super AU> target, java.lang.String name) get a filter than locates the target object from a String.
protected java.lang.Class<? super X>	getType() Returns the type the composite should be registered under.
abstract void	setName(AU user, java.lang.String name) Set the name of an object for this realm (If supported)
java.lang.String	toString() used to list composites on table structure page.
boolean	userVisible() Is this a name we might expect the user to know or an internal generated id.
void	validateName(java.lang.String name) Extension point to validate the format of the name before construction
void	verified(AU user) Extension point to record the time when this name was last verified Verification could be that the name has sucessfully been generated by an authentication system or in the case of an Email that the user has clicked on an opaque link sent to the email address.

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.Composite

addDefaults, addFieldHelp, addOptional, addSelectors, addSuppress, addTranslations, customiseForm, customiseUpdateForm, getContext, getFactory, getLogger, getRecord, getRepository, modifyDefaultTableSpecification, postUpdate, preRegister, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.model.ParseFactory

getCanonicalName

Methods inherited from interface uk.ac.ed.epcc.webapp.model.data.TableStructureContributer

addFieldConstraints, addFormFields

Constructor Detail

AppUserNameFinder

public AppUserNameFinder(AppUserFactory<AU> factory,
                         java.lang.String realm)

Parameters:

factory - AppUserFactory we are adding finder to.

realm - The realm to implement (can be prefixed by Namefinder.)

Method Detail

toString

public java.lang.String toString()

Description copied from class: Composite

used to list composites on table structure page.

Overrides:

toString in class Composite<AU extends AppUser,X extends AppUserNameFinder>

getNameLabel

public abstract java.lang.String getNameLabel()

Get a user presented label asking for the login name of the supported type. If this method returns null or an empty string then the finder may still be included in a user supplied lookup but will not be acknowledged in the form label.

Returns:

getRealm

public final java.lang.String getRealm()

Get the realm this finder applies to.

Returns:

getStringFinderFilter

public abstract SQLFilter<AU> getStringFinderFilter(java.lang.Class<? super AU> target,
                                                    java.lang.String name)

get a filter than locates the target object from a String. This should use the same logic as findFromString(String)

Parameters:

name -

Returns:

active

public abstract boolean active()

Checks if sufficient database fields exist to use this AppUserNameFinder An inactive finder still modifies the table specification but won't be retreivable as a realm.

Returns:

setName

public abstract void setName(AU user,
                             java.lang.String name)

Set the name of an object for this realm (If supported)

Parameters:

user -

name -

validateName

public void validateName(java.lang.String name)
                  throws ParseException

Extension point to validate the format of the name before construction

Parameters:

name -

Throws:

ParseException

userVisible

public boolean userVisible()

Is this a name we might expect the user to know or an internal generated id.

Returns:

verified

public void verified(AU user)

Extension point to record the time when this name was last verified Verification could be that the name has sucessfully been generated by an authentication system or in the case of an Email that the user has clicked on an opaque link sent to the email address.

Parameters:

user -

findFromString

public AU findFromString(java.lang.String name)

Description copied from interface: ParseFactory

Find an existing entry by name.

Specified by:

findFromString in interface ParseFactory<AU extends AppUser>

Returns:

Matching T or null

getAllNames

public java.util.Set<java.lang.String> getAllNames(AU user)

Get all of the defined names for this realm. Defaults to just the canonical name.

Parameters:

user -

Returns:

Set

getType

protected java.lang.Class<? super X> getType()

Description copied from class: Composite

Returns the type the composite should be registered under.

Specified by:

getType in class Composite<AU extends AppUser,X extends AppUserNameFinder>

Returns:

registration type

getDataCache

public DataCache<java.lang.String,AU> getDataCache()