org.assistments.domain.core

Class User

java.lang.Object

org.assistments.domain.core.XInfoImpl

org.assistments.domain.core.AssistmentsPrincipal

org.assistments.domain.core.User

All Implemented Interfaces:

java.lang.Comparable<AssistmentsPrincipal>, java.security.Principal, HasExternalReference, XInfo

Direct Known Subclasses:

LegacyUser

public class User
extends AssistmentsPrincipal
implements XInfo, HasExternalReference

The User object defines an ASSISTments Service (AS) user.

The minimal valid AS User requires the following:

• A login name
• The user type: UserType.PRINCIPAL or UserType.PROXY
• For a PRINCIPAL user, a password
• The user's timezone information

NOTE: It is highly recommended that applications construct User objects using the UserBuilder which provides more robust field validation and supports for application specific password validation.

See Also:

UserBuilder

Nested Class Summary

Nested classes/interfaces inherited from class org.assistments.domain.core.XInfoImpl

XInfoImpl.XInfoState

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns whether two XInfos are equal based solely on the object's xref UUID.
java.time.Instant	getBirthdate()
java.time.Instant	getCreated()
java.lang.String	getDisplayName()
java.lang.String	getFirstName()
java.time.Instant	getLastAuthenticated()
java.lang.String	getLastName()
java.lang.String	getLoginName()
java.lang.String	getPassword() Not for public consumption, but needed by the service package
java.lang.String	getSalt()
java.lang.String	getTimeZone()
java.time.Instant	getUpdated()
UserType	getUserType()
ExternalReferenceType	getXrefType()
boolean	isActive()
boolean	isMustBeEmailSyntax()
boolean	isVerifiedEmail() Specifies whether a user's login name has been verified as a valid email address through an exchange of email messages.
void	setActive(boolean isActive)
void	setBirthdate(java.time.Instant birthdate)
void	setCreated(java.time.Instant created)
void	setDisplayName(java.lang.String displayName)
void	setFirstName(java.lang.String firstName)
void	setLastAuthenticated(java.time.Instant lastLogin)
void	setLastName(java.lang.String lastName)
void	setLoginName(java.lang.String loginName)
void	setMustBeEmailSyntax(boolean mustBeEmailSyntax)
void	setPassword(java.lang.String password)
void	setSalt(java.lang.String salt) Ignored if set by an application.
void	setTimeZone(java.lang.String timeZone)
void	setUpdated(java.time.Instant updated)
void	setUserType(UserType userType)
void	setVerifiedEmail(boolean verified) Specifies whether the login name, if an email address, has been verified via the exchange of email messages with the account holder.
java.lang.String	toString()

Methods inherited from class org.assistments.domain.core.AssistmentsPrincipal

asPrincipalString, compareTo, getDbid, getName, getPrincipalType, isPrincipalType, setDbid, setName, toString

Methods inherited from class org.assistments.domain.core.XInfoImpl

asXinfoString, clearXinfo, getState, getType, getXid, getXinfo, getXref, hashCode, setXid, setXidOverride, setXinfo, setXref

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assistments.domain.core.XInfo

asXinfoString, clearXinfo, getPrincipalType, getType, getXid, getXinfo, getXref, hashCode, setXid, setXidOverride, setXinfo, setXref, toString

Methods inherited from interface org.assistments.domain.core.HasExternalReference

getDbid

Methods inherited from interface java.security.Principal

hashCode, implies

Constructor Detail

User

public User()

Method Detail

isActive

public boolean isActive()

setActive

public void setActive(boolean isActive)

getUserType

public UserType getUserType()

setUserType

public void setUserType(UserType userType)

getFirstName

public java.lang.String getFirstName()

setFirstName

public void setFirstName(java.lang.String firstName)

getLastName

public java.lang.String getLastName()

setLastName

public void setLastName(java.lang.String lastName)

getDisplayName

public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(java.lang.String displayName)

getBirthdate

public java.time.Instant getBirthdate()

setBirthdate

public void setBirthdate(java.time.Instant birthdate)

getTimeZone

public java.lang.String getTimeZone()

setTimeZone

public void setTimeZone(java.lang.String timeZone)

getLoginName

public java.lang.String getLoginName()

getPassword

public java.lang.String getPassword()

Not for public consumption, but needed by the service package

setPassword

public void setPassword(java.lang.String password)

setSalt

public void setSalt(java.lang.String salt)

Ignored if set by an application.

Parameters:

salt -

getSalt

public java.lang.String getSalt()

setLoginName

public void setLoginName(java.lang.String loginName)

isMustBeEmailSyntax

public boolean isMustBeEmailSyntax()

setMustBeEmailSyntax

public void setMustBeEmailSyntax(boolean mustBeEmailSyntax)

isVerifiedEmail

public boolean isVerifiedEmail()

Specifies whether a user's login name has been verified as a valid email address through an exchange of email messages.

Returns:

true if CAS was able to exchange email messages with the email address specified as the user's login name; otherwise false.

setVerifiedEmail

public void setVerifiedEmail(boolean verified)

Specifies whether the login name, if an email address, has been verified via the exchange of email messages with the account holder.

Note: This method is intended for internal use by CAS only.

Parameters:

verified -

getCreated

public java.time.Instant getCreated()

setCreated

public void setCreated(java.time.Instant created)

getUpdated

public java.time.Instant getUpdated()

setUpdated

public void setUpdated(java.time.Instant updated)

getLastAuthenticated

public java.time.Instant getLastAuthenticated()

setLastAuthenticated

public void setLastAuthenticated(java.time.Instant lastLogin)

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: XInfo

Returns whether two XInfos are equal based solely on the object's xref UUID.

Specified by:

equals in interface java.security.Principal

Specified by:

equals in interface XInfo

Overrides:

equals in class AssistmentsPrincipal

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Specified by:

toString in interface XInfo

Overrides:

toString in class AssistmentsPrincipal

getXrefType

public ExternalReferenceType getXrefType()

Specified by:

getXrefType in interface HasExternalReference