uk.ac.ed.epcc.webapp.session

Class EmailNameFinder<AU extends AppUser>

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,EmailNameFinder<AU>>

uk.ac.ed.epcc.webapp.session.EmailNameFinder<AU>

Type Parameters:

AU - type of AppUser

All Implemented Interfaces:

Contexed, AnonymisingComposite<AU>, TableStructureContributer<AU>, HistoryFieldContributor, ParseFactory<AU>, SummaryContributer<AU>, AppUserTransitionContributor, RequiredPageProvider<AU>

@Scopes(scopes={"email","impersonate"})
public class EmailNameFinder<AU extends AppUser>
extends AppUserNameFinder<AU,EmailNameFinder<AU>>
implements HistoryFieldContributor, SummaryContributer<AU>, AppUserTransitionContributor, AnonymisingComposite<AU>, RequiredPageProvider<AU>

A AppUserNameFinder to handle users canonical Email The email address is required not to resolve to an existing name on the factory unless it corresponds to the current object. (we query the full factory in case we have a NameFinder for known aliases as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EmailNameFinder.ChangeEmailTransition
class	EmailNameFinder.VerifyEmailRequiredPage

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	ANON_TO_DUMMY_FEATURE
static CurrentUserKey	CHANGE_EMAIL
static Feature	CHANGE_EMAIL_FEATURE
static java.lang.String	EMAIL
static java.lang.String	EMAIL_MAXWIDTH_PROP property to set the email input box width
static java.lang.String	EMAIL_VERIFIED_FIELD

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

fac

Constructor Summary

Constructors

Constructor and Description
EmailNameFinder(AppUserFactory<AU> factory)

Method Summary

Modifier and Type	Method and Description
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.
void	addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes, AU target) Add to the set of attributes.
void	addEraseFields(java.util.Set<java.lang.String> fields) Add to the set of fields that contain PII data This can be used to generate an anonymising rule for history tables
java.util.Map<java.lang.String,Selector>	addSelectors(java.util.Map<java.lang.String,Selector> selectors) Get a Map of selectors to use for forms of this type.
java.util.Set<java.lang.String>	addSuppress(java.util.Set<java.lang.String> suppress) generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.
void	addToHistorySpecification(TableSpecification spec) add fields to the history table default specification.
void	anonymise(AU target)
void	customiseForm(Form f) Extension hook to allow additional Form customisation generic to all types of Form (create and update) For example adding a FormValidator .
void	customiseUpdateForm(Form f, AU target, SessionService operator) Extension hook to allow additional Form customisation specific to the update of an existing object.
java.lang.String	getCanonicalName(AU object) Get a canonical name of an object in a format that can be parsed by the ParseFactory.findFromString(String) method.
static FieldValidator<java.lang.String>	getEmailValidator(AppContext conn)
java.lang.String	getNameLabel() Get a user presented label asking for the login name of the supported type.
java.util.Set<RequiredPage<AU>>	getRequiredPages() Get the set of required pages.
SQLFilter<AU>	getStringFinderFilter(java.lang.Class<? super AU> target, java.lang.String name) get a filter than locates the target object from a String.
java.util.Map<AppUserKey,Transition<AppUser>>	getTransitions(AppUserTransitionProvider provider)
protected java.lang.Class<? super EmailNameFinder<AU>>	getType() Returns the type the composite should be registered under.
java.util.Date	getVerificationDate(AU user)
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
java.util.Date	needVerifyBy(AU user) If email needs to be regularly verified when does this next need to be done by
BaseFilter<AU>	needVerifyFilter()
void	setName(AU user, java.lang.String name) Set the name of an object for this realm (If supported)
boolean	useEmailVerificationDate()
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.
boolean	warnVerify(AU user)

Methods inherited from class uk.ac.ed.epcc.webapp.session.AppUserNameFinder

findFromString, getAllNames, getDataCache, getRealm, toString, userVisible

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

addDefaults, addFieldHelp, addOptional, addTranslations, getContext, getFactory, getLogger, getRecord, getRepository, 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.data.TableStructureContributer

addFieldConstraints, addFormFields

Field Detail

EMAIL_MAXWIDTH_PROP

public static final java.lang.String EMAIL_MAXWIDTH_PROP

property to set the email input box width

See Also:

Constant Field Values

EMAIL

public static final java.lang.String EMAIL

See Also:

Constant Field Values

EMAIL_VERIFIED_FIELD

public static final java.lang.String EMAIL_VERIFIED_FIELD

See Also:

Constant Field Values

CHANGE_EMAIL_FEATURE

public static final Feature CHANGE_EMAIL_FEATURE

ANON_TO_DUMMY_FEATURE

public static final Feature ANON_TO_DUMMY_FEATURE

CHANGE_EMAIL

public static CurrentUserKey CHANGE_EMAIL

Constructor Detail

EmailNameFinder

public EmailNameFinder(AppUserFactory<AU> factory)

Parameters:

factory -

Method Detail

modifyDefaultTableSpecification

public TableSpecification modifyDefaultTableSpecification(TableSpecification spec,
                                                          java.lang.String table)

Description copied from interface: TableStructureContributer

Modify the TableSpecification of the target factory.

Specified by:

modifyDefaultTableSpecification in interface TableStructureContributer<AU extends AppUser>

Overrides:

modifyDefaultTableSpecification in class Composite<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Returns:

addToHistorySpecification

public void addToHistorySpecification(TableSpecification spec)

Description copied from interface: HistoryFieldContributor

add fields to the history table default specification.

Specified by:

addToHistorySpecification in interface HistoryFieldContributor

addSelectors

public java.util.Map<java.lang.String,Selector> addSelectors(java.util.Map<java.lang.String,Selector> selectors)

Description copied from interface: TableStructureContributer

Get a Map of selectors to use for forms of this type. This method provides a class specific set of defaults but the specific form classes can override this.

Specified by:

addSelectors in interface TableStructureContributer<AU extends AppUser>

Overrides:

addSelectors in class Composite<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Returns:

Map of modified selectors/inputs

getCanonicalName

public java.lang.String getCanonicalName(AU object)

Description copied from interface: ParseFactory

Get a canonical name of an object in a format that can be parsed by the ParseFactory.findFromString(String) method.

Specified by:

getCanonicalName in interface ParseFactory<AU extends AppUser>

Returns:

The canonical name.

getNameLabel

public java.lang.String getNameLabel()

Description copied from class: AppUserNameFinder

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.

Specified by:

getNameLabel in class AppUserNameFinder<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Returns:

getStringFinderFilter

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

Description copied from class: AppUserNameFinder

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

Specified by:

getStringFinderFilter in class AppUserNameFinder<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Returns:

getEmailValidator

public static FieldValidator<java.lang.String> getEmailValidator(AppContext conn)

customiseForm

public void customiseForm(Form f)

Description copied from interface: TableStructureContributer

Extension hook to allow additional Form customisation generic to all types of Form (create and update) For example adding a FormValidator . Logic that requires an existing object can be added to TableStructureContributer.customiseUpdateForm(Form, DataObject, SessionService)

Specified by:

customiseForm in interface TableStructureContributer<AU extends AppUser>

Overrides:

customiseForm in class Composite<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Parameters:

f - Form to modify

customiseUpdateForm

public void customiseUpdateForm(Form f,
                                AU target,
                                SessionService operator)

Description copied from interface: TableStructureContributer

Extension hook to allow additional Form customisation specific to the update of an existing object. This can also add constraints based on the relationship of the operator to the object being updated. Logic that does not require an existing object can be added to TableStructureContributer.customiseForm(Form)

Specified by:

customiseUpdateForm in interface TableStructureContributer<AU extends AppUser>

Overrides:

customiseUpdateForm in class Composite<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

setName

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

Description copied from class: AppUserNameFinder

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

Specified by:

setName in class AppUserNameFinder<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

active

public boolean active()

Description copied from class: AppUserNameFinder

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.

Specified by:

active in class AppUserNameFinder<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Returns:

validateName

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

Description copied from class: AppUserNameFinder

Extension point to validate the format of the name before construction

Overrides:

validateName in class AppUserNameFinder<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Throws:

ParseException

addAttributes

public void addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes,
                          AU target)

Description copied from interface: SummaryContributer

Add to the set of attributes. These will usually be added to a Table so the data should be of a type that can be displayed by Tables The keys should be display text.

Specified by:

addAttributes in interface SummaryContributer<AU extends AppUser>

anonymise

public void anonymise(AU target)

Specified by:

anonymise in interface AnonymisingComposite<AU extends AppUser>

getTransitions

public java.util.Map<AppUserKey,Transition<AppUser>> getTransitions(AppUserTransitionProvider provider)

Specified by:

getTransitions in interface AppUserTransitionContributor

addEraseFields

public void addEraseFields(java.util.Set<java.lang.String> fields)

Description copied from interface: AnonymisingComposite

Add to the set of fields that contain PII data This can be used to generate an anonymising rule for history tables

Specified by:

addEraseFields in interface AnonymisingComposite<AU extends AppUser>

verified

public void verified(AU user)

Description copied from class: AppUserNameFinder

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.

Overrides:

verified in class AppUserNameFinder<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

useEmailVerificationDate

public boolean useEmailVerificationDate()

getVerificationDate

public java.util.Date getVerificationDate(AU user)

addSuppress

public java.util.Set<java.lang.String> addSuppress(java.util.Set<java.lang.String> suppress)

Description copied from interface: TableStructureContributer

generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.

Specified by:

addSuppress in interface TableStructureContributer<AU extends AppUser>

Overrides:

addSuppress in class Composite<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Returns:

Set of fields to suppress in forms.

getRequiredPages

public java.util.Set<RequiredPage<AU>> getRequiredPages()

Description copied from interface: RequiredPageProvider

Get the set of required pages.

Specified by:

getRequiredPages in interface RequiredPageProvider<AU extends AppUser>

Returns:

Set of RequiredPage objects.

needVerifyFilter

public BaseFilter<AU> needVerifyFilter()

warnVerify

public boolean warnVerify(AU user)

needVerifyBy

public java.util.Date needVerifyBy(AU user)

If email needs to be regularly verified when does this next need to be done by

Parameters:

user -

Returns:

Date or null

getType

protected final java.lang.Class<? super EmailNameFinder<AU>> getType()

Description copied from class: Composite

Returns the type the composite should be registered under.

Overrides:

getType in class AppUserNameFinder<AU extends AppUser,EmailNameFinder<AU extends AppUser>>

Returns:

registration type