Package org.apache.syncope.core.persistence.jpa.entity.user

Class JPAUser

java.lang.Object

org.apache.syncope.core.persistence.jpa.entity.AbstractEntity

org.apache.syncope.core.persistence.jpa.entity.AbstractGeneratedKeyEntity

org.apache.syncope.core.persistence.jpa.entity.AbstractAny<P>

org.apache.syncope.core.persistence.jpa.entity.AbstractGroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>

org.apache.syncope.core.persistence.jpa.entity.user.JPAUser

All Implemented Interfaces:

Serializable, Any<UPlainAttr>, Attributable<UPlainAttr>, Entity, GroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>, Account, User

Direct Known Subclasses:

JPAJSONUser

@Entity
public class JPAUser
extends AbstractGroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>
implements User

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<JPAAnyTypeClass>	auxClasses
protected OffsetDateTime	changePwdDate	Change password date.
protected CipherAlgorithm	cipherAlgorithm
protected Integer	failedLogins	Subsequent failed logins.
protected OffsetDateTime	lastLoginDate	Last successful login date.
protected @Valid List<JPALinkedAccount>	linkedAccounts
protected @Valid List<JPAUMembership>	memberships
protected Boolean	mustChangePassword
protected String	password
protected String	passwordHistory
protected @Valid List<JPAUPlainAttr>	plainAttrs
protected @Valid List<JPAURelationship>	relationships
protected List<JPAExternalResource>	resources	Provisioning external resources.
protected List<JPARole>	roles
protected String	securityAnswer
protected JPASecurityQuestion	securityQuestion
protected String	status
protected Boolean	suspended
static String	TABLE
protected String	token
protected OffsetDateTime	tokenExpireTime
protected static TypeReference<List<String>>	TYPEREF
protected @NotNull(message="Blank username") String	username	Username/Login.

Fields inherited from class org.apache.syncope.core.persistence.jpa.entity.AbstractEntity

LOG

Fields inherited from interface org.apache.syncope.core.persistence.api.entity.Entity

EMAIL_PATTERN, ID_PATTERN, ID_REGEX

Constructor Summary

Constructors

Constructor	Description
JPAUser()

Method Summary

Modifier and Type	Method	Description
boolean	add(AnyTypeClass auxClass)
boolean	add(ExternalResource resource)
boolean	add(Role role)
boolean	add(LinkedAccount account)
boolean	add(UMembership membership)
boolean	add(UPlainAttr attr)
boolean	add(URelationship relationship)
void	addToPasswordHistory(String password)
boolean	canDecodeSecrets()
boolean	checkToken(String token)
protected String	encode(String value)
void	generateToken(int tokenLength, int tokenExpireTime)
List<? extends AnyTypeClass>	getAuxClasses()
OffsetDateTime	getChangePwdDate()
CipherAlgorithm	getCipherAlgorithm()
Integer	getFailedLogins()
OffsetDateTime	getLastLoginDate()
Optional<? extends LinkedAccount>	getLinkedAccount(String resource, String connObjectKeyValue)
List<? extends LinkedAccount>	getLinkedAccounts()
List<? extends LinkedAccount>	getLinkedAccounts(String resource)
List<? extends UMembership>	getMemberships()
String	getPassword()
List<String>	getPasswordHistory()
Optional<? extends URelationship>	getRelationship(RelationshipType relationshipType, String otherEndKey)
List<? extends URelationship>	getRelationships()
List<? extends ExternalResource>	getResources()
List<? extends Role>	getRoles()
String	getSecurityAnswer()
SecurityQuestion	getSecurityQuestion()
String	getStatus()
String	getToken()
OffsetDateTime	getTokenExpireTime()
AnyType	getType()
String	getUsername()
boolean	hasTokenExpired()
protected List<? extends UPlainAttr>	internalGetPlainAttrs()
boolean	isMustChangePassword()
Boolean	isSuspended()
boolean	remove(UMembership membership)
void	removeOldestEntriesFromPasswordHistory(int n)
void	removeToken()
void	setChangePwdDate(OffsetDateTime changePwdDate)
void	setCipherAlgorithm(CipherAlgorithm cipherAlgorithm)
void	setEncodedPassword(String password, CipherAlgorithm cipherAlgorithm)
void	setFailedLogins(Integer failedLogins)
void	setLastLoginDate(OffsetDateTime lastLoginDate)
void	setMustChangePassword(boolean mustChangePassword)
void	setPassword(String password)
void	setSecurityAnswer(String securityAnswer)
void	setSecurityQuestion(SecurityQuestion securityQuestion)
void	setStatus(String status)
void	setSuspended(Boolean suspended)
void	setType(AnyType type)
void	setUsername(String username)

Methods inherited from class org.apache.syncope.core.persistence.jpa.entity.AbstractGroupableRelatable

getMembership, getPlainAttr, getPlainAttr, getPlainAttrs, getPlainAttrs, getPlainAttrs, getRelationships, getRelationships, remove

Methods inherited from class org.apache.syncope.core.persistence.jpa.entity.AbstractAny

getCreationContext, getCreationDate, getCreator, getLastChangeContext, getLastChangeDate, getLastModifier, getRealm, setCreationContext, setCreationDate, setCreator, setLastChangeContext, setLastChangeDate, setLastModifier, setRealm

Methods inherited from class org.apache.syncope.core.persistence.jpa.entity.AbstractGeneratedKeyEntity

getKey, setKey

Methods inherited from class org.apache.syncope.core.persistence.jpa.entity.AbstractEntity

checkImplementationType, checkType, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.syncope.core.persistence.api.entity.Any

getCreationContext, getCreationDate, getCreator, getLastChangeContext, getLastChangeDate, getLastModifier, getRealm, setCreationContext, setCreationDate, setCreator, setLastChangeContext, setLastChangeDate, setLastModifier, setRealm

Methods inherited from interface org.apache.syncope.core.persistence.api.entity.Attributable

getPlainAttr, getPlainAttrs, remove

Methods inherited from interface org.apache.syncope.core.persistence.api.entity.Entity

getKey

Methods inherited from interface org.apache.syncope.core.persistence.api.entity.GroupableRelatable

getMembership, getPlainAttr, getPlainAttrs, getPlainAttrs, getRelationships, getRelationships

Field Detail

TABLE

public static final String TABLE

See Also:

Constant Field Values

TYPEREF

protected static final TypeReference<List<String>> TYPEREF

password

protected String password

roles

protected List<JPARole> roles

plainAttrs

@Valid
protected @Valid List<JPAUPlainAttr> plainAttrs

status

protected String status

token

protected String token

tokenExpireTime

protected OffsetDateTime tokenExpireTime

cipherAlgorithm

protected CipherAlgorithm cipherAlgorithm

passwordHistory

protected String passwordHistory

failedLogins

protected Integer failedLogins

Subsequent failed logins.

username

@NotNull(message="Blank username")
protected @NotNull(message="Blank username") String username

Username/Login.

lastLoginDate

protected OffsetDateTime lastLoginDate

Last successful login date.

changePwdDate

protected OffsetDateTime changePwdDate

Change password date.

suspended

protected Boolean suspended

mustChangePassword

protected Boolean mustChangePassword

resources

protected List<JPAExternalResource> resources

Provisioning external resources.

auxClasses

protected List<JPAAnyTypeClass> auxClasses

relationships

@Valid
protected @Valid List<JPAURelationship> relationships

memberships

@Valid
protected @Valid List<JPAUMembership> memberships

securityQuestion

protected JPASecurityQuestion securityQuestion

securityAnswer

protected String securityAnswer

linkedAccounts

@Valid
protected @Valid List<JPALinkedAccount> linkedAccounts

Constructor Detail

JPAUser

public JPAUser()

Method Detail

getType

public AnyType getType()

Specified by:

getType in interface Any<UPlainAttr>

setType

public void setType(AnyType type)

Specified by:

setType in interface Any<UPlainAttr>

add

public boolean add(ExternalResource resource)

Specified by:

add in interface Any<UPlainAttr>

getResources

public List<? extends ExternalResource> getResources()

Specified by:

getResources in interface Any<UPlainAttr>

add

public boolean add(Role role)

Specified by:

add in interface User

getRoles

public List<? extends Role> getRoles()

Specified by:

getRoles in interface User

getPassword

public String getPassword()

Specified by:

getPassword in interface Account

setEncodedPassword

public void setEncodedPassword(String password,
                               CipherAlgorithm cipherAlgorithm)

Specified by:

setEncodedPassword in interface Account

encode

protected String encode(String value)
                 throws Exception

Throws:

Exception

setPassword

public void setPassword(String password)

Specified by:

setPassword in interface Account

getCipherAlgorithm

public CipherAlgorithm getCipherAlgorithm()

Specified by:

getCipherAlgorithm in interface Account

setCipherAlgorithm

public void setCipherAlgorithm(CipherAlgorithm cipherAlgorithm)

Specified by:

setCipherAlgorithm in interface Account

canDecodeSecrets

public boolean canDecodeSecrets()

Specified by:

canDecodeSecrets in interface Account

add

public boolean add(UPlainAttr attr)

Specified by:

add in interface Attributable<UPlainAttr>

internalGetPlainAttrs

protected List<? extends UPlainAttr> internalGetPlainAttrs()

Specified by:

internalGetPlainAttrs in class AbstractGroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>

getStatus

public String getStatus()

Specified by:

getStatus in interface Any<UPlainAttr>

Overrides:

getStatus in class AbstractAny<UPlainAttr>

setStatus

public void setStatus(String status)

Specified by:

setStatus in interface Any<UPlainAttr>

Overrides:

setStatus in class AbstractAny<UPlainAttr>

generateToken

public void generateToken(int tokenLength,
                          int tokenExpireTime)

Specified by:

generateToken in interface User

removeToken

public void removeToken()

Specified by:

removeToken in interface User

getToken

public String getToken()

Specified by:

getToken in interface User

getTokenExpireTime

public OffsetDateTime getTokenExpireTime()

Specified by:

getTokenExpireTime in interface User

checkToken

public boolean checkToken(String token)

Specified by:

checkToken in interface User

hasTokenExpired

public boolean hasTokenExpired()

Specified by:

hasTokenExpired in interface User

addToPasswordHistory

public void addToPasswordHistory(String password)

Specified by:

addToPasswordHistory in interface User

removeOldestEntriesFromPasswordHistory

public void removeOldestEntriesFromPasswordHistory(int n)

Specified by:

removeOldestEntriesFromPasswordHistory in interface User

getPasswordHistory

public List<String> getPasswordHistory()

Specified by:

getPasswordHistory in interface User

getChangePwdDate

public OffsetDateTime getChangePwdDate()

Specified by:

getChangePwdDate in interface User

setChangePwdDate

public void setChangePwdDate(OffsetDateTime changePwdDate)

Specified by:

setChangePwdDate in interface User

getFailedLogins

public Integer getFailedLogins()

Specified by:

getFailedLogins in interface User

setFailedLogins

public void setFailedLogins(Integer failedLogins)

Specified by:

setFailedLogins in interface User

getLastLoginDate

public OffsetDateTime getLastLoginDate()

Specified by:

getLastLoginDate in interface User

setLastLoginDate

public void setLastLoginDate(OffsetDateTime lastLoginDate)

Specified by:

setLastLoginDate in interface User

getUsername

public String getUsername()

Specified by:

getUsername in interface Account

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface Account

setSuspended

public void setSuspended(Boolean suspended)

Specified by:

setSuspended in interface Account

isSuspended

public Boolean isSuspended()

Specified by:

isSuspended in interface Account

setMustChangePassword

public void setMustChangePassword(boolean mustChangePassword)

Specified by:

setMustChangePassword in interface User

isMustChangePassword

public boolean isMustChangePassword()

Specified by:

isMustChangePassword in interface User

getSecurityQuestion

public SecurityQuestion getSecurityQuestion()

Specified by:

getSecurityQuestion in interface User

setSecurityQuestion

public void setSecurityQuestion(SecurityQuestion securityQuestion)

Specified by:

setSecurityQuestion in interface User

getSecurityAnswer

public String getSecurityAnswer()

Specified by:

getSecurityAnswer in interface User

setSecurityAnswer

public void setSecurityAnswer(String securityAnswer)

Specified by:

setSecurityAnswer in interface User

add

public boolean add(AnyTypeClass auxClass)

Specified by:

add in interface Any<UPlainAttr>

getAuxClasses

public List<? extends AnyTypeClass> getAuxClasses()

Specified by:

getAuxClasses in interface Any<UPlainAttr>

add

public boolean add(URelationship relationship)

Specified by:

add in interface GroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>

getRelationship

public Optional<? extends URelationship> getRelationship(RelationshipType relationshipType,
                                                         String otherEndKey)

Specified by:

getRelationship in interface GroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>

getRelationships

public List<? extends URelationship> getRelationships()

Specified by:

getRelationships in interface GroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>

add

public boolean add(UMembership membership)

Specified by:

add in interface GroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>

remove

public boolean remove(UMembership membership)

Specified by:

remove in interface GroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>

getMemberships

public List<? extends UMembership> getMemberships()

Specified by:

getMemberships in interface GroupableRelatable<User,UMembership,UPlainAttr,AnyObject,URelationship>

add

public boolean add(LinkedAccount account)

Specified by:

add in interface User

getLinkedAccount

public Optional<? extends LinkedAccount> getLinkedAccount(String resource,
                                                          String connObjectKeyValue)

Specified by:

getLinkedAccount in interface User

getLinkedAccounts

public List<? extends LinkedAccount> getLinkedAccounts(String resource)

Specified by:

getLinkedAccounts in interface User

getLinkedAccounts

public List<? extends LinkedAccount> getLinkedAccounts()

Specified by:

getLinkedAccounts in interface User