uk.ac.ed.epcc.webapp.session

Interface RequiredPage<U extends AppUser>

Type Parameters:

U - type of AppUser

All Known Implementing Classes:

AppUserFactory.UpdatePersonRequiredPage, EmailNameFinder.VerifyEmailRequiredPage, PasswordAuthComposite.PasswordResetRequiredPage

public interface RequiredPage<U extends AppUser>

Object representing a page that a user is redirected to if certain conditions are met. e.g. a password reset page. You must ensure that any JSP referenced in this way does not include the redirect checks itself to avoid looping. Some FormResults are added as request attributes by ServletFormResultVisitor andare checked to prevent loops. Composites in the AppUserFactory can add these if they implement RequiredPageProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AM_REQUIRED_PAGE_ATTR
static java.lang.String	REQUIRED_PAGE_RETURN_ATTR
static java.lang.String	REQUIRED_PAGES_ATTR

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getNotifyText(U person) If a notification email is being sent (possibly triggered by a different required page).
FormResult	getPage(SessionService<U> user) What page should be shown
default BaseFilter<U>	notifiable(SessionService<U> sess) Filter for people who should be notified by email of a message (e.g.
boolean	required(SessionService<U> user) Does this required page need to be shown now

Field Detail

AM_REQUIRED_PAGE_ATTR

static final java.lang.String AM_REQUIRED_PAGE_ATTR

See Also:

Constant Field Values

REQUIRED_PAGES_ATTR

static final java.lang.String REQUIRED_PAGES_ATTR

See Also:

Constant Field Values

REQUIRED_PAGE_RETURN_ATTR

static final java.lang.String REQUIRED_PAGE_RETURN_ATTR

See Also:

Constant Field Values

Method Detail

required

boolean required(SessionService<U> user)

Does this required page need to be shown now

Parameters:

user -

Returns:

getPage

FormResult getPage(SessionService<U> user)

What page should be shown

Parameters:

user -

Returns:

notifiable

default BaseFilter<U> notifiable(SessionService<U> sess)

Filter for people who should be notified by email of a message (e.g. update required).

Parameters:

sess -

Returns:

getNotifyText

default java.lang.String getNotifyText(U person)

If a notification email is being sent (possibly triggered by a different required page). Is there any message we want to add.

Parameters:

person -

Returns: