uk.ac.ed.epcc.webapp.session

Class AppUserFactory.SignupFormCreator<T extends AppUser>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFormFactory<BDO>

uk.ac.ed.epcc.webapp.model.data.forms.Creator<T>

uk.ac.ed.epcc.webapp.session.AppUserFactory.SignupFormCreator<T>

Type Parameters:

T -

All Implemented Interfaces:

FormCreator, FormFactory, TypeConverter<T,java.lang.Number>, CreateCustomizer<T>, CreateTemplate<T>, UpdateTemplate<T>, IndexedProducer<T>, Targetted<T>

Enclosing class:

AppUserFactory<AU extends AppUser>

public static class AppUserFactory.SignupFormCreator<T extends AppUser>
extends Creator<T>
implements UpdateTemplate<T>

Form for first time visitors to self register optionally this can also provide a name for the default realm if the servlet uses external authentication.

Field Summary

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

DEFAULT_FORBID_HTML, factory

Constructor Summary

Constructors

Constructor and Description
SignupFormCreator(AppUserFactory<T> fac, java.lang.String realm, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	customiseCreationForm(Form f) Perform target specific customisation of a creation Form.
protected AppUserFactory<T>	getAppUserFactory()
java.util.Map<java.lang.String,java.lang.Object>	getDefaults() Get a set of default values for the form fields
FormResult	getResult(java.lang.String type_name, T dat, Form f) select the FormResult after an update.
protected java.util.Set<java.lang.String>	getSupress() generate the set of suppressed fields to be used in form creation/update
void	postCreate(T dat, Form f) Take any action after object commit.
void	postUpdate(T o, Form f, java.util.Map<java.lang.String,java.lang.Object> orig, boolean changed) perform side-effects after a form update
void	preCommit(T dat, Form f) Populate target from creation form.
void	preCommit(T dat, Form f, java.util.Map<java.lang.String,java.lang.Object> orig) extension point for update side effects that should be applied before the commit.
void	setAction(java.lang.String type_name, Form f)

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

buildCreationForm, getActionText, getConfirm

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

addOptionalFromComposites, addSelectors, addTranslations, buildForm, buildForm, buildForm, buildForm, buildForm, customiseForm, find, find, getContext, getFactory, getFieldConstraints, getFieldHelp, getFields, getID, getIndex, getInputFromName, getInputFromType, getLogger, getOptional, getSelectors, getTarget, getTranslations, isMyReference, makeReference, makeReference

Methods inherited from class java.lang.Object

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

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

getContext

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.factory.FormFactory

getContext

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

getFactory

Constructor Detail

SignupFormCreator

public SignupFormCreator(AppUserFactory<T> fac,
                         java.lang.String realm,
                         java.lang.String name)

Parameters:

fac - AppUserFactory

realm - String realm to set webname in

name - String webname from external authentication.

Method Detail

customiseCreationForm

public void customiseCreationForm(Form f)
                           throws java.lang.Exception

Description copied from class: Creator

Perform target specific customisation of a creation Form. For example adding a special validator. Note that this is called in addition to the basic DataObjectFormFactory.customiseForm(Form) call

Specified by:

customiseCreationForm in interface CreateCustomizer<T extends AppUser>

Overrides:

customiseCreationForm in class Creator<T extends AppUser>

Parameters:

f - Form to be modified

Throws:

java.lang.Exception

preCommit

public void preCommit(T dat,
                      Form f)
               throws DataException,
                      ActionException

Description copied from interface: CreateCustomizer

Populate target from creation form. This can be sub-classes to add additional information such as the requesting Person or other information derived other than from the form parameters. Normally the form contents have already been set in the Object but the form is passed to this method in case any form parameters are used to control the way the object is created.

Specified by:

preCommit in interface CreateCustomizer<T extends AppUser>

Overrides:

preCommit in class Creator<T extends AppUser>

Parameters:

dat - Object being created

f - Form providing parameters

Throws:

DataException

ActionException

postCreate

public void postCreate(T dat,
                       Form f)
                throws java.lang.Exception

Description copied from interface: CreateCustomizer

Take any action after object commit.

Specified by:

postCreate in interface CreateCustomizer<T extends AppUser>

Overrides:

postCreate in class Creator<T extends AppUser>

Throws:

java.lang.Exception

getAppUserFactory

protected AppUserFactory<T> getAppUserFactory()

Returns:

setAction

public void setAction(java.lang.String type_name,
                      Form f)

Overrides:

setAction in class Creator<T extends AppUser>

getResult

public FormResult getResult(java.lang.String type_name,
                            T dat,
                            Form f)

Description copied from interface: UpdateTemplate

select the FormResult after an update.

Specified by:

getResult in interface CreateTemplate<T extends AppUser>

Specified by:

getResult in interface UpdateTemplate<T extends AppUser>

Overrides:

getResult in class Creator<T extends AppUser>

getSupress

protected java.util.Set<java.lang.String> getSupress()

Description copied from class: DataObjectFormFactory

generate the set of suppressed fields to be used in form creation/update

Overrides:

getSupress in class DataObjectFormFactory<T extends AppUser>

Returns:

Vector

getDefaults

public java.util.Map<java.lang.String,java.lang.Object> getDefaults()

Description copied from class: DataObjectFormFactory

Get a set of default values for the form fields

Specified by:

getDefaults in interface CreateTemplate<T extends AppUser>

Overrides:

getDefaults in class DataObjectFormFactory<T extends AppUser>

Returns:

Map of defaults

postUpdate

public void postUpdate(T o,
                       Form f,
                       java.util.Map<java.lang.String,java.lang.Object> orig,
                       boolean changed)
                throws java.lang.Exception

Description copied from interface: UpdateTemplate

perform side-effects after a form update

Specified by:

postUpdate in interface UpdateTemplate<T extends AppUser>

Parameters:

o - object being updated

f - Form used for update

orig - Map of object state before update.

changed - Did the update commit change the database object

Throws:

java.lang.Exception

preCommit

public final void preCommit(T dat,
                            Form f,
                            java.util.Map<java.lang.String,java.lang.Object> orig)
                     throws DataException

Description copied from interface: UpdateTemplate

extension point for update side effects that should be applied before the commit.

Specified by:

preCommit in interface UpdateTemplate<T extends AppUser>

Throws:

DataException