Records a request to verify a profile's email address before a sign-up or group membership application can proceed. A row is created with a unique, single-use token that is emailed to the address being verified; the profile confirms ownership by presenting the token, which is stored against the request's used date once consumed. A request may be linked to a specific group membership application, and login is blocked while an active, unverified request exists for the profile.
Implements: Relational
Properties
| Property | Returns | Description |
|---|---|---|
| adminOrg | Organisation | Organisation that the sign-up or membership application this verification belongs to is being created within. |
| createdDate | Date | Date and time the verification request was created, i.e. when the verification email was generated. |
String | Email address that this request is verifying. Never null. | |
| groupMembershipApplication | GroupMembershipApplication | Group membership application this verification request was raised for, if any. |
| id | long | Database primary key of this validation request. |
| profile | Profile | Profile whose email address is being verified by this request. |
| token | String | Single-use token included in the verification email link. Generated as a random, base64-encoded UUID and guaranteed unique across all requests. |
| usedDate | Date | Date and time the token was consumed, marking this request as used. Null while the request is still active and awaiting verification, or while it has been superseded by a later request for the same email or profile. |
| website | Website | Website that this verification request was raised on. |
Methods
getId() · getAdminOrg() · setAdminOrg(Organisation adminOrg) · getEmail() · setEmail(String email) · getGroupMembershipApplication() · setGroupMembershipApplication(GroupMembershipApplication groupMembershipApplication) · getWebsite() · setWebsite(Website website) · getProfile() · setProfile(Profile profile) · getCreatedDate() · setCreatedDate(Date createdDate) · getUsedDate() · setUsedDate(Date usedDate) · getToken() · setToken(String token)
getId()
Returns: long
Database primary key of this validation request.
getAdminOrg()
Returns: Organisation
Organisation that the sign-up or membership application this verification belongs to is being created within.
setAdminOrg(Organisation adminOrg)
Returns: void
Sets the organisation that owns this request.
| Parameter | Description |
|---|---|
adminOrg | the owning organisation |
getEmail()
Returns: String
Email address that this request is verifying. Never null.
setEmail(String email)
Returns: void
Sets the email address being verified.
| Parameter | Description |
|---|---|
email | the email address to verify |
getGroupMembershipApplication()
Returns: GroupMembershipApplication
Group membership application this verification request was raised for, if any.
setGroupMembershipApplication(GroupMembershipApplication groupMembershipApplication)
Returns: void
Links this request to a group membership application.
| Parameter | Description |
|---|---|
groupMembershipApplication | the membership application this request verifies an email for |
getWebsite()
Returns: Website
Website that this verification request was raised on.
setWebsite(Website website)
Returns: void
Sets the website this request originated from.
| Parameter | Description |
|---|---|
website | the originating website |
getProfile()
Returns: Profile
Profile whose email address is being verified by this request.
setProfile(Profile profile)
Returns: void
Sets the profile whose email address this request verifies.
| Parameter | Description |
|---|---|
profile | the profile under verification |
getCreatedDate()
Returns: Date
Date and time the verification request was created, i.e. when the verification email was generated.
setCreatedDate(Date createdDate)
Returns: void
Sets the date and time the request was created.
| Parameter | Description |
|---|---|
createdDate | the creation timestamp |
getUsedDate()
Returns: Date
Date and time the token was consumed, marking this request as used. Null while the request is still active and awaiting verification, or while it has been superseded by a later request for the same email or profile.
setUsedDate(Date usedDate)
Returns: void
Marks this request as used (or supersedes it) by setting the used date.
| Parameter | Description |
|---|---|
usedDate | the timestamp the request was consumed or superseded |
getToken()
Returns: String
Single-use token included in the verification email link. Generated as a random, base64-encoded UUID and guaranteed unique across all requests.
setToken(String token)
Returns: void
Sets the request's verification token.
| Parameter | Description |
|---|---|
token | the token to associate with this request |