uk.ac.ed.epcc.webapp.session

Class AppUser

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObject

uk.ac.ed.epcc.webapp.session.AppUser

All Implemented Interfaces:

java.security.Principal, Contexed, ContextIndexed, Identified, Indexed, Owned, Releasable

public class AppUser
extends DataObject
implements java.security.Principal, Owned

AppUser Generic Object representing a user of the Web application potentially sub-classed by actual Webapps. An AppUser can support names defined in various realms (defined using AppUserNameFinder objects.

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	PERSON_HISTORY_FEATURE
static java.lang.String	UPDATED_TIME

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

DEBUG, record

Fields inherited from interface uk.ac.ed.epcc.webapp.forms.Identified

MAX_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
AppUser(AppUserFactory factory, Repository.Record res)

Method Summary

Modifier and Type	Method and Description
void	addIndexTable(Table tab) Add this AppUser to an index table with rows keyed by AppUser.
boolean	allowEmail()
boolean	canLogin() Is this user allowed to login applications should override this method to implement the necessary logic for this.
boolean	canReregister() Return true if the account is not permitted to login but a forgotten password request will re-register the user.
boolean	checkStateRole(java.lang.String role)
java.lang.String	getEmail() get the Email address for this AppUser if known.
AppUserFactory	getFactory()
java.lang.String	getIdentifier(int max_length) Generate Identifier with advisory max length.
java.util.Date	getLastTimeDetailsUpdated()
java.lang.String	getLogName() return name and SU identity if it exists.
java.lang.String	getName() get the presentation name of the user By default this looks for a Composite that implements NameComposite then falls back to the default realm name.
java.lang.String	getRealmName(java.lang.String realm)
java.lang.String	getSortName() Version of getName where the String sort order matches the presentation order.
void	historyTerminate()
void	historyUpdate()
void	markDetailsUpdated()
java.util.Date	nextRequiredUpdate() Get the next date that personal details are required to be updated
<X> void	notifyChange(java.lang.String field, java.lang.String extra, X prev, X curr) Extension point for when updates to person state may need to be notified to external parties.
protected void	post_commit(boolean changed) Extension point called at end of commit
protected void	pre_commit(boolean dirty) Extension point called at start of commit.
void	reRegister() Re-register a retired account
void	setEmail(java.lang.String email) change email address and commit change.
void	setEmailsAllowed(boolean value)
void	setRealmName(java.lang.String realm, java.lang.String name)
boolean	warnRequiredUpdate()

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

addToMap, addToMap, addToMap, commit, delete, empty, equals, formUpdate, getContext, getDatabaseService, getFactoryTag, getID, getIdentifier, getLogger, getMap, getMap, getOwningFactory, getRecord, getRecord, getRecord, getSQLContext, getUniqueIdName, hashCode, isLocked, lock, postCreate, release, setContents, setDirty, setMap, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Field Detail

UPDATED_TIME

public static final java.lang.String UPDATED_TIME

See Also:

Constant Field Values

PERSON_HISTORY_FEATURE

public static final Feature PERSON_HISTORY_FEATURE

Constructor Detail

AppUser

public AppUser(AppUserFactory factory,
               Repository.Record res)

Method Detail

getFactory

public AppUserFactory getFactory()

Specified by:

getFactory in interface Owned

canLogin

public boolean canLogin()

Is this user allowed to login applications should override this method to implement the necessary logic for this. This will also disable forgotten password requests.

Returns:

boolean true for permitted.

See Also:

AppUserFactory.getCanLoginFilter(), canReregister()

canReregister

public boolean canReregister()

Return true if the account is not permitted to login but a forgotten password request will re-register the user.

Returns:

reRegister

public void reRegister()

Re-register a retired account

getRealmName

public java.lang.String getRealmName(java.lang.String realm)

getEmail

public java.lang.String getEmail()

get the Email address for this AppUser if known.

Returns:

String

allowEmail

public boolean allowEmail()

setEmailsAllowed

public void setEmailsAllowed(boolean value)

getIdentifier

public java.lang.String getIdentifier(int max_length)

Description copied from interface: Identified

Generate Identifier with advisory max length.

Specified by:

getIdentifier in interface Identified

Overrides:

getIdentifier in class DataObject

Parameters:

max_length - advisory max length

Returns:

String identifier

getName

public java.lang.String getName()

get the presentation name of the user By default this looks for a Composite that implements NameComposite then falls back to the default realm name. This method can also be overridden to directly generate a more friendly presentation name

Specified by:

getName in interface java.security.Principal

Returns:

String

getSortName

public final java.lang.String getSortName()

Version of getName where the String sort order matches the presentation order. If we change this we need to keep getIdentifier roughly consistent.

Returns:

String

setRealmName

public void setRealmName(java.lang.String realm,
                         java.lang.String name)

setEmail

public void setEmail(java.lang.String email)
              throws DataFault

change email address and commit change.

Parameters:

email -

Throws:

DataFault

getLastTimeDetailsUpdated

public java.util.Date getLastTimeDetailsUpdated()

nextRequiredUpdate

public java.util.Date nextRequiredUpdate()

Get the next date that personal details are required to be updated

Returns:

Date or null

warnRequiredUpdate

public boolean warnRequiredUpdate()

markDetailsUpdated

public void markDetailsUpdated()

pre_commit

protected void pre_commit(boolean dirty)
                   throws DataFault

Description copied from class: DataObject

Extension point called at start of commit. It is legal to change the record in this call

Overrides:

pre_commit in class DataObject

Parameters:

dirty - is record known to be modified.

Throws:

DataFault

post_commit

protected void post_commit(boolean changed)
                    throws DataFault

Description copied from class: DataObject

Extension point called at end of commit

Overrides:

post_commit in class DataObject

Parameters:

changed - record was changed by commit.

Throws:

DataFault

getLogName

public java.lang.String getLogName()

return name and SU identity if it exists. We need to query the session to do this. This is used when logging resource allocations so we can tell the difference between something done by a user or and admin SU'd as that user.

Parameters:

req - Request object

Returns:

String

checkStateRole

public boolean checkStateRole(java.lang.String role)

Parameters:

role -

Returns:

notifyChange

public <X> void notifyChange(java.lang.String field,
                             java.lang.String extra,
                             X prev,
                             X curr)

Extension point for when updates to person state may need to be notified to external parties. The field string is a tag to identify the type of update being notified. This allows some degree of additional filtering in the sub-class. Use the db field triggering the update where this makes sense and pass the old/new values

Type Parameters:

X - value type

Parameters:

field - type of update

extra - text of update

prev - previous value

curr - relacement value

historyUpdate

public void historyUpdate()

historyTerminate

public void historyTerminate()

addIndexTable

public void addIndexTable(Table tab)

Add this AppUser to an index table with rows keyed by AppUser.

Parameters:

tab -

See Also:

AppUserFactory.getPersonTable(SessionService, uk.ac.ed.epcc.webapp.jdbc.filter.BaseFilter)