com.communote.server.model.user

Class User

java.lang.Object

com.communote.server.model.user.CommunoteEntity

com.communote.server.model.user.User

All Implemented Interfaces:

Followable, GlobalIdentifiable, Propertyable, Taggable, Serializable

public class User
extends CommunoteEntity

A user.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.Factory Constructs new instances of User.

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
String	attributesToString() Builds a string showing the current attribute values
boolean	equals(Object object) This entity does not have any identifiers but since it extends the com.communote.server.persistence.user.KenmeiEntityImpl class it will simply delegate the call up there.
String	getAlias() Return the alias either of group or of user
String	getAuthenticationToken() A token, which can be used for authentication processes.
String	getEmail() The email of the user
Set<ExternalUserAuthentication>	getExternalAuthentications()
Set<AuthenticationFailedStatus>	getFailedAuthentication()
Set<GlobalId>	getFollowedItems()
GlobalId	getFollowId()
String	getLanguageCode()
Locale	getLanguageLocale()
Timestamp	getLastLogin()
String	getPassword()
UserProfile	getProfile()
Set<UserProperty>	getProperties() Properties
UserRole[]	getRoles()
UserStatus	getStatus()
Timestamp	getStatusChanged()
Set<UserAuthority>	getUserAuthorities()
boolean	hasExternalAuthentication(String externalSystemId) Test whether the user has an external authentication with the given ID.
int	hashCode() This entity does not have any identifiers but since it extends the com.communote.server.persistence.user.KenmeiEntityImpl class it will simply delegate the call up there.
boolean	hasRole(UserRole role) Test whether the user has the given role.
boolean	hasStatus(UserStatus status)
boolean	isActivated()
boolean	isReminderMailSent()
boolean	isTermsAccepted()
void	setAlias(String alias)
void	setAuthenticationToken(String authenticationToken)
void	setEmail(String email)
void	setExternalAuthentications(Set<ExternalUserAuthentication> externalAuthentications)
void	setFailedAuthentication(Set<AuthenticationFailedStatus> failedAuthentication)
void	setFollowedItems(Set<GlobalId> followedItems)
void	setLanguageCode(String languageCode)
void	setLanguageLocale(Locale languageLocale)
void	setLastLogin(Timestamp lastLogin)
void	setPassword(String password)
void	setProfile(UserProfile profile)
void	setProperties(Set<UserProperty> properties)
void	setReminderMailSent(boolean reminderMailSent)
void	setStatus(UserStatus status)
void	setStatusChanged(Timestamp statusChanged)
void	setTermsAccepted(boolean termsAccepted)
void	setUserAuthorities(Set<UserAuthority> userAuthorities)

Methods inherited from class com.communote.server.model.user.CommunoteEntity

getGlobalId, getGroups, getId, getMemberships, getTags, setGlobalId, setGroups, setId, setMemberships, setTags

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User()

Method Detail

attributesToString

public String attributesToString()

Builds a string showing the current attribute values

Overrides:

attributesToString in class CommunoteEntity

equals

public boolean equals(Object object)

This entity does not have any identifiers but since it extends the com.communote.server.persistence.user.KenmeiEntityImpl class it will simply delegate the call up there.

Overrides:

equals in class CommunoteEntity

See Also:

CommunoteEntity.equals(Object)

getAlias

public String getAlias()

Description copied from class: CommunoteEntity

Return the alias either of group or of user

Specified by:

getAlias in class CommunoteEntity

getAuthenticationToken

public String getAuthenticationToken()

A token, which can be used for authentication processes. The format is CREATION_TIME:TOKEN, where CREATION_TIME is the timestamp in millis. This token should not be used directly, instead the AuthorizationTokenManagement should be used.

getEmail

public String getEmail()

The email of the user

getExternalAuthentications

public Set<ExternalUserAuthentication> getExternalAuthentications()

Returns:

the authentications of a user which were provided by an external system. Never null.

getFailedAuthentication

public Set<AuthenticationFailedStatus> getFailedAuthentication()

getFollowedItems

public Set<GlobalId> getFollowedItems()

getFollowId

public GlobalId getFollowId()

Specified by:

getFollowId in interface Followable

Specified by:

getFollowId in class CommunoteEntity

getLanguageCode

public String getLanguageCode()

Returns:

The language code or the language of Locale.ENGLISH as default.

getLanguageLocale

public Locale getLanguageLocale()

getLastLogin

public Timestamp getLastLogin()

getPassword

public String getPassword()

Returns:

the password hash of the user. Can be null if the user is an external user of the primary external repository.

getProfile

public UserProfile getProfile()

getProperties

public Set<UserProperty> getProperties()

Description copied from class: CommunoteEntity

Properties

Specified by:

getProperties in interface Propertyable

Specified by:

getProperties in class CommunoteEntity

getRoles

public UserRole[] getRoles()

getStatus

public UserStatus getStatus()

getStatusChanged

public Timestamp getStatusChanged()

getUserAuthorities

public Set<UserAuthority> getUserAuthorities()

hasExternalAuthentication

public boolean hasExternalAuthentication(String externalSystemId)

Test whether the user has an external authentication with the given ID.

Parameters:

externalSystemId - the ID of the external system

Returns:

true if the user has an external authentication with the given ID

Since:

3.5

hashCode

public int hashCode()

This entity does not have any identifiers but since it extends the com.communote.server.persistence.user.KenmeiEntityImpl class it will simply delegate the call up there.

Overrides:

hashCode in class CommunoteEntity

See Also:

CommunoteEntity.hashCode()

hasRole

public boolean hasRole(UserRole role)

Test whether the user has the given role.

Parameters:

role - the role to test

Returns:

true if the user has the role, false otherwise

hasStatus

public boolean hasStatus(UserStatus status)

Returns:

true if the user has the given status

isActivated

public boolean isActivated()

Returns:

true if the user has the status ACTIVE

isReminderMailSent

public boolean isReminderMailSent()

isTermsAccepted

public boolean isTermsAccepted()

setAlias

public void setAlias(String alias)

setAuthenticationToken

public void setAuthenticationToken(String authenticationToken)

setEmail

public void setEmail(String email)

setExternalAuthentications

public void setExternalAuthentications(Set<ExternalUserAuthentication> externalAuthentications)

setFailedAuthentication

public void setFailedAuthentication(Set<AuthenticationFailedStatus> failedAuthentication)

setFollowedItems

public void setFollowedItems(Set<GlobalId> followedItems)

setLanguageCode

public void setLanguageCode(String languageCode)

setLanguageLocale

public void setLanguageLocale(Locale languageLocale)

setLastLogin

public void setLastLogin(Timestamp lastLogin)

setPassword

public void setPassword(String password)

setProfile

public void setProfile(UserProfile profile)

setProperties

public void setProperties(Set<UserProperty> properties)

setReminderMailSent

public void setReminderMailSent(boolean reminderMailSent)

setStatus

public void setStatus(UserStatus status)

setStatusChanged

public void setStatusChanged(Timestamp statusChanged)

setTermsAccepted

public void setTermsAccepted(boolean termsAccepted)

setUserAuthorities

public void setUserAuthorities(Set<UserAuthority> userAuthorities)