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

Class Neo4jUser

java.lang.Object

org.apache.syncope.core.persistence.neo4j.entity.AbstractNode

org.apache.syncope.core.persistence.neo4j.entity.AbstractGeneratedKeyNode

org.apache.syncope.core.persistence.neo4j.entity.AbstractAttributable

org.apache.syncope.core.persistence.neo4j.entity.AbstractAny

org.apache.syncope.core.persistence.neo4j.entity.AbstractRelatable<User,URelationship>

org.apache.syncope.core.persistence.neo4j.entity.AbstractGroupableRelatable<User,UMembership,URelationship>

org.apache.syncope.core.persistence.neo4j.entity.user.Neo4jUser

All Implemented Interfaces:

Serializable, Any, Attributable, Entity, Groupable<User,UMembership,URelationship>, Relatable<User,URelationship>, Account, User

@Node("SyncopeUser")
@AttributableCheck
public class Neo4jUser
extends AbstractGroupableRelatable<User,UMembership,URelationship>
implements User

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Neo4jAnyTypeClass>	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<Neo4jLinkedAccount>	linkedAccounts
protected List<Neo4jUMembership>	memberships
protected Boolean	mustChangePassword
static final String	NODE
protected String	password
protected String	passwordHistory
protected Map<String,PlainAttr>	plainAttrs
protected List<Neo4jURelationship>	relationships
protected List<Neo4jExternalResource>	resources	Provisioning external resources.
static final String	ROLE_MEMBERSHIP_REL
protected List<Neo4jRole>	roles
protected String	securityAnswer
protected Neo4jSecurityQuestion	securityQuestion
protected Boolean	suspended
protected String	token
protected OffsetDateTime	tokenExpireTime
protected static final TypeReference<List<String>>	TYPEREF
static final String	USER_AUX_CLASSES_REL
static final String	USER_GROUP_MEMBERSHIP_REL
static final String	USER_RESOURCE_REL
static final String	USER_SECURITY_QUESTION_REL
protected @NotNull(message="Blank username") String	username	Username/Login.

Fields inherited from class org.apache.syncope.core.persistence.neo4j.entity.AbstractNode

LOG

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

EMAIL_PATTERN, ID_PATTERN, ID_REGEX

Constructor Summary

Constructors

Constructor	Description
Neo4jUser()

Method Summary

Modifier and Type	Method	Description
boolean	add(AnyTypeClass auxClass)
boolean	add(ExternalResource resource)
boolean	add(PlainAttr attr)
boolean	add(Role role)
boolean	add(LinkedAccount account)
boolean	add(UMembership membership)
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)
String	getPassword()
List<String>	getPasswordHistory()
List<? extends URelationship>	getRelationships()
List<? extends ExternalResource>	getResources()
List<? extends Role>	getRoles()
String	getSecurityAnswer()
SecurityQuestion	getSecurityQuestion()
String	getToken()
OffsetDateTime	getTokenExpireTime()
AnyType	getType()
String	getUsername()
boolean	hasTokenExpired()
boolean	isMustChangePassword()
Boolean	isSuspended()
protected List<Neo4jUMembership>	memberships()
protected Map<String,PlainAttr>	plainAttrs()
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	setEncodedSecurityAnswer(String securityAnswer)
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	setSuspended(Boolean suspended)
void	setType(AnyType type)
void	setUsername(String username)

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

completeMembershipPlainAttrs, getMembership, getMemberships, getPlainAttr, getPlainAttrs, getPlainAttrs, remove

Methods inherited from class org.apache.syncope.core.persistence.neo4j.entity.AbstractRelatable

getRelationship, getRelationships, getRelationships

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

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

Methods inherited from class org.apache.syncope.core.persistence.neo4j.entity.AbstractAttributable

completePlainAttrs, doComplete, getPlainAttr, getPlainAttrs

Methods inherited from class org.apache.syncope.core.persistence.neo4j.entity.AbstractGeneratedKeyNode

getKey, setKey

Methods inherited from class org.apache.syncope.core.persistence.neo4j.entity.AbstractNode

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, getStatus, setCreationContext, setCreationDate, setCreator, setLastChangeContext, setLastChangeDate, setLastModifier, setRealm, setStatus

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.Groupable

getMembership, getMemberships, getPlainAttr, getPlainAttrs, getPlainAttrs

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

getRelationship, getRelationships, getRelationships

Field Details

NODE

public static final String NODE

See Also:

• Constant Field Values

USER_AUX_CLASSES_REL

public static final String USER_AUX_CLASSES_REL

See Also:

• Constant Field Values

USER_RESOURCE_REL

public static final String USER_RESOURCE_REL

See Also:

• Constant Field Values

ROLE_MEMBERSHIP_REL

public static final String ROLE_MEMBERSHIP_REL

See Also:

• Constant Field Values

USER_GROUP_MEMBERSHIP_REL

public static final String USER_GROUP_MEMBERSHIP_REL

See Also:

• Constant Field Values

USER_SECURITY_QUESTION_REL

public static final String USER_SECURITY_QUESTION_REL

See Also:

• Constant Field Values

TYPEREF

protected static final TypeReference<List<String>> TYPEREF

password

protected String password

plainAttrs

protected Map<String,PlainAttr> plainAttrs

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

@Relationship(type="USER_RESOURCE",
              direction=OUTGOING)
protected List<Neo4jExternalResource> resources

Provisioning external resources.

auxClasses

@Relationship(type="USER_AUX_CLASSES",
              direction=OUTGOING)
protected List<Neo4jAnyTypeClass> auxClasses

relationships

@Relationship(type="URELATIONSHIP_SOURCE",
              direction=INCOMING)
protected List<Neo4jURelationship> relationships

memberships

@Relationship(type="USER_GROUP_MEMBERSHIP",
              direction=INCOMING)
protected List<Neo4jUMembership> memberships

roles

@Relationship(type="ROLE_MEMBERSHIP",
              direction=OUTGOING)
protected List<Neo4jRole> roles

securityQuestion

@Relationship(type="USER_SECURITY_QUESTION",
              direction=OUTGOING)
protected Neo4jSecurityQuestion securityQuestion

securityAnswer

protected String securityAnswer

linkedAccounts

@Relationship(direction=INCOMING)
@Valid
protected @Valid List<Neo4jLinkedAccount> linkedAccounts

Constructor Details

Neo4jUser

public Neo4jUser()

Method Details

plainAttrs

protected Map<String,PlainAttr> plainAttrs()

Specified by:

plainAttrs in class AbstractAttributable

getType

public AnyType getType()

Specified by:

getType in interface Any

setType

public void setType(AnyType type)

Specified by:

setType in interface Any

add

public boolean add(ExternalResource resource)

Specified by:

add in interface Any

getResources

public List<? extends ExternalResource> getResources()

Specified by:

getResources in interface Any

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(PlainAttr attr)

Specified by:

add in interface Attributable

Overrides:

add in class AbstractAttributable

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

setEncodedSecurityAnswer

public void setEncodedSecurityAnswer(String securityAnswer)

Specified by:

setEncodedSecurityAnswer in interface User

add

public boolean add(AnyTypeClass auxClass)

Specified by:

add in interface Any

getAuxClasses

public List<? extends AnyTypeClass> getAuxClasses()

Specified by:

getAuxClasses in interface Any

add

public boolean add(URelationship relationship)

Specified by:

add in interface Relatable<User,URelationship>

getRelationships

public List<? extends URelationship> getRelationships()

Specified by:

getRelationships in interface Relatable<User,URelationship>

add

public boolean add(UMembership membership)

Specified by:

add in interface Groupable<User,UMembership,URelationship>

remove

public boolean remove(UMembership membership)

Specified by:

remove in interface Groupable<User,UMembership,URelationship>

memberships

protected List<Neo4jUMembership> memberships()

Specified by:

memberships in class AbstractGroupableRelatable<User,UMembership,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