uk.ac.ed.epcc.webapp.session

Class AppUserFactory<AU extends AppUser>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<AU>

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

Type Parameters:

AU - type of AppUser

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<AU>, FilterMatcher<AU>, AnonymisingFactory, TypeConverter<AU,java.lang.Number>, DataObjectSelector<AU>, Selector<DataObjectItemInput<AU>>, Owner<AU>, IndexedProducer<AU>, NameFinder<AU>, ParseFactory<AU>, AccessRoleProvider<AU,AU>, SummaryContributer<AU>, RegisterTrigger<AU>, RequiredPageProvider<AU>, Tagged, Targetted<AU>

public class AppUserFactory<AU extends AppUser>
extends DataObjectFactory<AU>
implements RequiredPageProvider<AU>, NameFinder<AU>, RegisterTrigger<AU>, SummaryContributer<AU>, AccessRoleProvider<AU,AU>, AnonymisingFactory

A Factory for creating AppUser objects that represent users of the system. If the bootstrap.admin Feature is set then the first user in the system will automatically be given the ADMIN role (or the role specified in the bootstrap-role property is this is set). The role is added when the table for this factory is created not when the user is added.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppUserFactory.AppUserNameInput<A extends AppUser>
class	AppUserFactory.RoleFilter A SQLFilter to select AppUsers based on their roles in the role table
static class	AppUserFactory.SignupFormCreator<T extends AppUser> 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.
class	AppUserFactory.UpdatePersonRequiredPage

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

DataObjectFactory.AbstractDataObjectInput, DataObjectFactory.AbstractFinder<X>, DataObjectFactory.DataObjectAcceptFilter, DataObjectFactory.DataObjectInput, DataObjectFactory.DataObjectIntegerInput, DataObjectFactory.DestAcceptFilter<T extends DataObject>, DataObjectFactory.FilterAdapter, DataObjectFactory.FilterCounter, DataObjectFactory.FilterExists, DataObjectFactory.FilterIterator, DataObjectFactory.FilterSelector, DataObjectFactory.FilterSet, DataObjectFactory.Finder, DataObjectFactory.MakeRemoteFilterVisitor<R extends DataObject>, DataObjectFactory.MatchFilter, DataObjectFactory.ReferencedAdapter<I extends Indexed>, DataObjectFactory.ReferenceIterator<I extends Indexed>, DataObjectFactory.SortingDataObjectInput, DataObjectFactory.TimeAcceptFilter<T extends DataObject>, DataObjectFactory.TimeFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOW_EMAIL_FIELD
static Feature	ANONYMISE_DATABASE_FEATURE
static Feature	AUTO_COMPLETE_APPUSER_INPUT
static Feature	BOOTSTRAP_ADMIN_FEATURE
static java.lang.String	BOOTSTRAP_ROLE_PROPERTY
static Feature	REQUIRE_PERSON_UPDATE_FEATURE

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

AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AppUserFactory()
	AppUserFactory(AppContext conn, java.lang.String table)

Method Summary

Modifier and Type	Method and Description
void	addAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes, AU target) Add to the set of attributes.
void	addRelationships(java.util.Set<java.lang.String> roles) Add known roles to a set.
void	addUpdateAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes, AU target)
<CB extends ContentBuilder> CB	addUpdateNotes(CB cb, AU target) add Notes to be included in a signup/update form.
void	anonymise() Anonymise the database.
boolean	autoCreate()
boolean	canErase(AU person)
void	erasePersonalData(AU p) Erase the personal data for the specified user
AU	findByEmail(java.lang.String email)
AU	findByEmail(java.lang.String email, boolean allow_null)
AU	findFromString(java.lang.String name) Find an existing entry by name This should use the same logic as NameFinder.getStringFinderFilter(String).
SQLFilter<AU>	getCanLoginFilter() get a filter equivalent to AppUser.canLogin()
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.
DataCache<java.lang.String,AU>	getDataCache() get a DataCache for fetching the target
java.lang.String	getDefaultRealm() Get the realm to use as a default when generating a name from the factory.
SQLFilter<AU>	getDefaultRelationshipFilter() Get a SQLFilter to use as the default target for relationship filters.
protected TableSpecification	getDefaultTableSpecification(AppContext ctx, java.lang.String table) Get the default table specification if the table is to be created.
BaseFilter<AU>	getEmailFilter() a filter for people that we might ever send emails to.
FormUpdate<AU>	getFormUpdate(AppContext c) produce a FormUpdate for the target type appropriate for the requesting user
DataObjectItemInput<AU>	getInput() get the default Input for this Factory Default behaviour is to use the DataObjectFactory.getSelectFilter() method to generate a DataObjectFactory.DataObjectInput but not to restrict the parse values (default value of DataObjectFactory.restrictDefaultInput() so existing values that don't match the select filter are still valid.
DataObjectItemInput<AU>	getNameInput(BaseFilter<AU> fil, boolean create, boolean restrict)
java.lang.String	getNameLabel() Get the user presented label asking for a login-id.
protected java.util.Set<java.lang.String>	getOptional() generate the set of optional fields to be used to provide class specific defaults in form creation/update.
Table<java.lang.String,AU>	getPersonTable(SessionService<?> sess, BaseFilter<AU> fil)
AppUserNameFinder<AU,?>	getRealmFinder(java.lang.String realm) Get a specified AppUserNameFinder.
java.util.Collection<AppUserNameFinder>	getRealms()
java.util.Set<RequiredPage<AU>>	getRequiredPages() Get the set of required pages.
protected AppUserFactory.RoleFilter	getRoleFilter(java.lang.String... roles)
DataObjectItemInput<AU>	getRoleInput(java.lang.String role)
BaseFilter<AU>	getSelectFilter() Get a filter corresponding to the set of DataObjects that can be used in the default Input for this class.
protected java.util.Map<java.lang.String,Selector>	getSelectors() Get a Map of selectors to use for forms of this type.
FormCreator	getSignupFormCreator(java.lang.String realm, java.lang.String webname) Get a FormCreator to use when users sign-up Optionally a name and a realm can be supplied which will be set as part of signup.
java.lang.String	getSortName(AU user) Get a name where the String sort order matches the presentation order.
SQLFilter<AU>	getStringFinderFilter(java.lang.String name) get a filter than locates the target object from a String.
SQLFilter<AU>	getStringFinderFilter(java.lang.String name, boolean require_user_supplied)
protected java.util.Set<java.lang.String>	getSupress() 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.
java.lang.Class<AU>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
BaseFilter<AU>	getWarnRefreshFilter()
BaseFilter<AU>	hasRelationFilter(java.lang.String role, AU user) Get a BaseFilter corresponding to target objects where the given user has the specified relation.
boolean	isRegisteredUsername(java.lang.String username) Does a String resolve to a known user.
protected AU	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.
AU	makeFromString(java.lang.String name) Same as NameFinder.findFromString(String) but attempts to create a matching entry if one does not exist and this is supported by the implementing class.
AU	makeUser() make an uncommited user suitable for automatic user creation.
boolean	mustRegister(AU user) Should this person register
boolean	needDetailsUpdate(AU user) do the persons details need updating.
void	newSignup(AU user) randomise a persons SAF password and send new password in an Email
BaseFilter<AU>	personInRelationFilter(SessionService<AU> sess, java.lang.String role, AU target) Get a BaseFilter for AppUsers that are in the specified relationship with the target object.
protected void	postAutoTableCreateSetup(AppContext ctx)
protected void	postCreateTableSetup(AppContext c, java.lang.String table)
void	postRegister(AU user) user has registered.
boolean	providesRelationship(java.lang.String role) Does this class provide the named relationship.
int	requireRefreshDays() number of days between required review of personal details
boolean	supportsRealm(java.lang.String realm)
protected boolean	useAutoCompleteForSelect() Are we using an auto-complete input for getInput() If this is true and DataObjectFactory.restrictDefaultInput() also returns true we can afford to be more restritive in the default filter applied
void	validateNameFormat(java.lang.String name) Check formatting constraints on the input string.
int	warnRefreshDays()

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

all, allowPreSelect, canCreate, canUpdate, checkComposite, convertToDestinationFilter, customiseForm, equals, exists, find, find, find, find, find, getAllIterator, getComposite, getComposites, getComposites, getConfigTag, getContext, getCount, getDefaults, getDestFilter, getExcludeFilter, getFieldConstraints, getFieldHelp, getFilter, getFilter, getFilter, getFinalSelectFilter, getFinalTableSpecification, getFindFilter, getFormCreator, getID, getIndex, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOrder, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelector, getSelector, getTableSpecification, getTableStructureContributers, getTag, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeObject, makeRecord, makeReference, makeReference, matches, narrowSelector, narrowSelector, observeComposite, OrderBy, postSetContext, release, restrictDefaultInput, setComposites, setContext, setContext, setContextWithMake, setProperty, toString, updateTable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Field Detail

BOOTSTRAP_ADMIN_FEATURE

public static final Feature BOOTSTRAP_ADMIN_FEATURE

BOOTSTRAP_ROLE_PROPERTY

public static final java.lang.String BOOTSTRAP_ROLE_PROPERTY

See Also:

Constant Field Values

REQUIRE_PERSON_UPDATE_FEATURE

public static final Feature REQUIRE_PERSON_UPDATE_FEATURE

AUTO_COMPLETE_APPUSER_INPUT

public static final Feature AUTO_COMPLETE_APPUSER_INPUT

ALLOW_EMAIL_FIELD

public static final java.lang.String ALLOW_EMAIL_FIELD

See Also:

Constant Field Values

ANONYMISE_DATABASE_FEATURE

public static final Feature ANONYMISE_DATABASE_FEATURE

Constructor Detail

AppUserFactory

protected AppUserFactory()

AppUserFactory

public AppUserFactory(AppContext conn,
                      java.lang.String table)

Method Detail

findByEmail

public final AU findByEmail(java.lang.String email)
                     throws DataException

Throws:

DataException

findByEmail

public final AU findByEmail(java.lang.String email,
                            boolean allow_null)
                     throws DataException

Throws:

DataException

getSelectors

protected java.util.Map<java.lang.String,Selector> getSelectors()

Description copied from class: DataObjectFactory

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.

Overrides:

getSelectors in class DataObjectFactory<AU extends AppUser>

Returns:

Map

See Also:

DataObjectFormFactory

getSupress

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

Description copied from class: DataObjectFactory

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.

Overrides:

getSupress in class DataObjectFactory<AU extends AppUser>

Returns:

Set

See Also:

DataObjectFormFactory

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.

getCanLoginFilter

public SQLFilter<AU> getCanLoginFilter()

get a filter equivalent to AppUser.canLogin()

Returns:

SQLFilter

See Also:

AppUser.canLogin()

isRegisteredUsername

public boolean isRegisteredUsername(java.lang.String username)
                             throws DataException

Does a String resolve to a known user.

Parameters:

username -

Returns:

Throws:

DataException

getRoleInput

public DataObjectItemInput<AU> getRoleInput(java.lang.String role)

getRoleFilter

protected AppUserFactory.RoleFilter getRoleFilter(java.lang.String... roles)

postCreateTableSetup

protected final void postCreateTableSetup(AppContext c,
                                          java.lang.String table)

Overrides:

postCreateTableSetup in class DataObjectFactory<AU extends AppUser>

postAutoTableCreateSetup

protected void postAutoTableCreateSetup(AppContext ctx)

getDefaultTableSpecification

protected TableSpecification getDefaultTableSpecification(AppContext ctx,
                                                          java.lang.String table)

Description copied from class: DataObjectFactory

Get the default table specification if the table is to be created. A null result means that a default specification is not available and the table will not be created.

Overrides:

getDefaultTableSpecification in class DataObjectFactory<AU extends AppUser>

Parameters:

ctx - AppContext

table - String table name.

Returns:

null or TableSpecification

getTarget

public java.lang.Class<AU> getTarget()

Description copied from class: DataObjectFactory

Get a bound on the type of object produced by this factory for run-time checking. This implements IndexedProducer.getTarget(). Normally this method should be overridden each time we make a sub-class that narrows the produced type. However checks should still pass if the super-type method is retained.

Specified by:

getTarget in interface IndexedProducer<AU extends AppUser>

Specified by:

getTarget in interface Targetted<AU extends AppUser>

Overrides:

getTarget in class DataObjectFactory<AU extends AppUser>

Returns:

Class object for return type

needDetailsUpdate

public boolean needDetailsUpdate(AU user)

do the persons details need updating. This is only used by AppUserFactory.UpdatePersonRequiredPage and the jsp pages that update the personal details so if the corresponding feature is disabled it always return false.

Returns:

boolean

requireRefreshDays

public int requireRefreshDays()

number of days between required review of personal details

Returns:

warnRefreshDays

public int warnRefreshDays()

getWarnRefreshFilter

public BaseFilter<AU> getWarnRefreshFilter()

getEmailFilter

public BaseFilter<AU> getEmailFilter()

a filter for people that we might ever send emails to.

Returns:

addUpdateNotes

public <CB extends ContentBuilder> CB addUpdateNotes(CB cb,
                                                     AU target)

add Notes to be included in a signup/update form. This is included within the block element above the form.

Parameters:

cb -

Returns:

getRealmFinder

public final AppUserNameFinder<AU,?> getRealmFinder(java.lang.String realm)

Get a specified AppUserNameFinder. A null or empty string returns the first AppUserNameFinder.

Parameters:

realm -

Returns:

getRealms

public java.util.Collection<AppUserNameFinder> getRealms()

Returns:

supportsRealm

public boolean supportsRealm(java.lang.String realm)

findFromString

public final AU findFromString(java.lang.String name)

Description copied from interface: NameFinder

Find an existing entry by name This should use the same logic as NameFinder.getStringFinderFilter(String).

Specified by:

findFromString in interface NameFinder<AU extends AppUser>

Specified by:

findFromString in interface ParseFactory<AU extends AppUser>

Returns:

Matching T or null

getNameLabel

public java.lang.String getNameLabel()

Get the user presented label asking for a login-id.

Returns:

getInput

public DataObjectItemInput<AU> getInput()

Description copied from class: DataObjectFactory

get the default Input for this Factory Default behaviour is to use the DataObjectFactory.getSelectFilter() method to generate a DataObjectFactory.DataObjectInput but not to restrict the parse values (default value of DataObjectFactory.restrictDefaultInput() so existing values that don't match the select filter are still valid.

Specified by:

getInput in interface Selector<DataObjectItemInput<AU extends AppUser>>

Overrides:

getInput in class DataObjectFactory<AU extends AppUser>

Returns:

Input

useAutoCompleteForSelect

protected boolean useAutoCompleteForSelect()

Are we using an auto-complete input for getInput() If this is true and DataObjectFactory.restrictDefaultInput() also returns true we can afford to be more restritive in the default filter applied

Returns:

getNameInput

public final DataObjectItemInput<AU> getNameInput(BaseFilter<AU> fil,
                                                  boolean create,
                                                  boolean restrict)

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.

getDefaultRealm

public java.lang.String getDefaultRealm()

Get the realm to use as a default when generating a name from the factory.

Returns:

getStringFinderFilter

public SQLFilter<AU> getStringFinderFilter(java.lang.String name)

Description copied from interface: NameFinder

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

Specified by:

getStringFinderFilter in interface NameFinder<AU extends AppUser>

Returns:

getStringFinderFilter

public SQLFilter<AU> getStringFinderFilter(java.lang.String name,
                                           boolean require_user_supplied)

getSortName

public java.lang.String getSortName(AU user)

Get a name where the String sort order matches the presentation order. If we change this we need to keep getIdentifier roughly consistent. Returns null or an empty string for the default sort order.

Parameters:

user -

Returns:

String

makeFromString

public final AU makeFromString(java.lang.String name)
                        throws DataFault,
                               ParseException

Description copied from interface: NameFinder

Same as NameFinder.findFromString(String) but attempts to create a matching entry if one does not exist and this is supported by the implementing class.

Specified by:

makeFromString in interface NameFinder<AU extends AppUser>

Returns:

T or null

Throws:

DataFault

ParseException

makeUser

public AU makeUser()
            throws DataFault

make an uncommited user suitable for automatic user creation. return null if automatic creation is not supported.

Returns:

Throws:

DataFault

getDataCache

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

Description copied from interface: NameFinder

get a DataCache for fetching the target

Specified by:

getDataCache in interface NameFinder<AU extends AppUser>

Returns:

DataCache

makeBDO

protected AU makeBDO(Repository.Record res)
              throws DataFault

Description copied from class: DataObjectFactory

Construct a new Blank DataObject of the correct Class This method takes a Record as an argument. This allows the factory to either create different sub-classes depending on a value in the record or to produce objects from different Repositories/tables. We keep the return type as DataObject instead of making it generic as this helps with legacy compatibility a little bit (problem is if we have another generic sub-type between us and a legacy sub-class

Specified by:

makeBDO in class DataObjectFactory<AU extends AppUser>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

newSignup

public void newSignup(AU user)
               throws java.lang.Exception

randomise a persons SAF password and send new password in an Email

Throws:

java.lang.Exception

getSignupFormCreator

public final FormCreator getSignupFormCreator(java.lang.String realm,
                                              java.lang.String webname)

Get a FormCreator to use when users sign-up Optionally a name and a realm can be supplied which will be set as part of signup. This is needed for external auth when the name is known but other details need to be gathered via the form.

Parameters:

realm - String realm to set webname in (may be null)

webname - String name to set

Returns:

mustRegister

public boolean mustRegister(AU user)

Description copied from interface: RegisterTrigger

Should this person register

Specified by:

mustRegister in interface RegisterTrigger<AU extends AppUser>

Returns:

postRegister

public void postRegister(AU user)

Description copied from interface: RegisterTrigger

user has registered. This should record a state change so the RegisterTrigger.mustRegister(AppUser) method returns false in the future.

Specified by:

postRegister in interface RegisterTrigger<AU extends AppUser>

autoCreate

public boolean autoCreate()

Returns:

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>

addUpdateAttributes

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

validateNameFormat

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

Description copied from interface: NameFinder

Check formatting constraints on the input string.

Specified by:

validateNameFormat in interface NameFinder<AU extends AppUser>

Throws:

ParseException

hasRelationFilter

public BaseFilter<AU> hasRelationFilter(java.lang.String role,
                                        AU user)

Description copied from interface: AccessRoleProvider

Get a BaseFilter corresponding to target objects where the given user has the specified relation. If the method returns null then the role is not recognised by the provider. A non-null result means the role is recognised but does not imply that any target will match. The relation with a specific target object can be tested using DataObjectFactory.matches(BaseFilter, DataObject) This method should not be called directly only via a call to SessionService.getRelationshipRoleFilter(DataObjectFactory, String) to allow the SessionService to combine and customise access rules.

Specified by:

hasRelationFilter in interface AccessRoleProvider<AU extends AppUser,AU extends AppUser>

Returns:

BaseFilter or null

personInRelationFilter

public BaseFilter<AU> personInRelationFilter(SessionService<AU> sess,
                                             java.lang.String role,
                                             AU target)

Description copied from interface: AccessRoleProvider

Get a BaseFilter for AppUsers that are in the specified relationship with the target object. This is the inverse of #hasRelationFilter(SessionService, String) used to generate a list of AppUser with the relation. It can always be implemented (inefficiently) by creating an AcceptFilter that uses AccessRoleProvider.hasRelationFilter(String, AppUser) to check each person in turn but though it is usually possible to find some SQLFilter to narrow the selection first even if a full SQL implementation is not possible. If the target is null it should generate a filter for any user in relation with targets selected by DataObjectFactory.getDefaultRelationshipFilter(). If this is not possible it should return null;

Specified by:

personInRelationFilter in interface AccessRoleProvider<AU extends AppUser,AU extends AppUser>

Returns:

BaseFilter or null

providesRelationship

public boolean providesRelationship(java.lang.String role)

Description copied from interface: AccessRoleProvider

Does this class provide the named relationship.

Specified by:

providesRelationship in interface AccessRoleProvider<AU extends AppUser,AU extends AppUser>

Returns:

true if relationship provided by this class.

getOptional

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

Description copied from class: DataObjectFactory

generate the set of optional fields to be used to provide class specific defaults in form creation/update. If null is returned the default behaviour is to take fields that can be null in the database but classes can override with an explicit list of optional fields. In which case it may be a good idea to start with DataObjectFactory.getNullable() and remove any fields that should be forced to be mandatory. Alternatively you can start with an empty set (defaulting to all fields mandatory) and add exceptions Note that for legacy reasons a non-nullable String field CAN be made optional (the Repository will map null values to the empty string)

Overrides:

getOptional in class DataObjectFactory<AU extends AppUser>

Returns:

Vector

See Also:

DataObjectFactory.getNullable()

getSelectFilter

public BaseFilter<AU> getSelectFilter()

Description copied from class: DataObjectFactory

Get a filter corresponding to the set of DataObjects that can be used in the default Input for this class. Note that if getInput is overridden then this filter condition may not be applied. This filter is responsible for providing any ORDER BY clause in the filter. The default implementation in DataObjectFactory will generate an OrderFilter based on the factory OrderBy method. Note that DataObjectFactory.getInput() only uses this to control the presented options not which options are valid unless the value of DataObjectFactory.restrictDefaultInput() is also changed.

Overrides:

getSelectFilter in class DataObjectFactory<AU extends AppUser>

Returns:

getFormUpdate

public FormUpdate<AU> getFormUpdate(AppContext c)

Description copied from interface: FormUpdateProducer

produce a FormUpdate for the target type appropriate for the requesting user

Specified by:

getFormUpdate in interface FormUpdateProducer<AU extends AppUser>

Overrides:

getFormUpdate in class DataObjectFactory<AU extends AppUser>

Parameters:

c - AppContext

Returns:

FormUpdate or null

anonymise

public void anonymise()
               throws DataFault

Anonymise the database. All passwords are made invalid except for the person anonymising the database where the password is reset to Password

Specified by:

anonymise in interface AnonymisingFactory

Throws:

DataFault

canErase

public boolean canErase(AU person)

erasePersonalData

public void erasePersonalData(AU p)
                       throws DataFault

Erase the personal data for the specified user

Parameters:

p -

Throws:

DataFault

getDefaultRelationshipFilter

public SQLFilter<AU> getDefaultRelationshipFilter()

Description copied from class: DataObjectFactory

Get a SQLFilter to use as the default target for relationship filters. This should exclude targets that should not be used as relationship targets such as retired objects.

Overrides:

getDefaultRelationshipFilter in class DataObjectFactory<AU extends AppUser>

Returns:

getPersonTable

public Table<java.lang.String,AU> getPersonTable(SessionService<?> sess,
                                                 BaseFilter<AU> fil)
                                          throws DataFault

Throws:

DataFault

addRelationships

public void addRelationships(java.util.Set<java.lang.String> roles)

Description copied from interface: AccessRoleProvider

Add known roles to a set. This can be roles provided or consumed by the class. This is only used as auto-complete suggestions so should be a useful subset rather than an exhaustive list

Specified by:

addRelationships in interface AccessRoleProvider<AU extends AppUser,AU extends AppUser>