com.communote.server.persistence.user

Class ExternalUserVO

java.lang.Object

com.communote.server.api.core.user.UserVO

com.communote.server.persistence.user.ExternalUserVO

All Implemented Interfaces:

Serializable

public class ExternalUserVO
extends UserVO
implements Serializable

A value object representing a User retrieved from an external repository like LDAP.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExternalUserVO() Empty constructor.

Method Summary

Modifier and Type	Method and Description
String	getAdditionalProperty() An optional member holding some additional data for the user.
Locale	getDefaultLanguage() The default language is used if the external user is not yet created.
String	getExternalUserName() Login name of the user in the external repository.
String	getPermanentId() Optional attribute that represents a unique identifier of the user in the external repository whose value never changes.
Set<StringPropertyTO>	getProperties()
UserStatus	getStatus() Status of the user to be set.
String	getSystemId()
boolean	isClearPassword() Whether to clear the password of the local user.
boolean	isUpdateEmail() Whether to update the email address of the user if it is provided.
boolean	isUpdateFirstName() Whether to update the first name if it is provided.
boolean	isUpdateLanguage() Whether to update the language if it is provided.
boolean	isUpdateLastName() Whether to update the last name if it is provided.
void	setAdditionalProperty(String additionalProperty) Set the additional property.
void	setClearPassword(boolean clearPassword) Set whether a password stored for the local user belonging to this external user should be cleared.
void	setDefaultLanguage(Locale defaultLanguage) The default language is used if the external user is not yet created.
void	setExternalUserName(String externalUserName) Set the external user name.
void	setPermanentId(String permanentId) Set the permanent id.
void	setProperties(Set<StringPropertyTO> properties) Set additional user properties.
void	setStatus(UserStatus status) Set the user status.
void	setSystemId(String systemId) Set the system id.
void	setUpdateEmail(boolean updateEmail) Set the email address.
void	setUpdateFirstName(boolean updateFirstName) Set first name.
void	setUpdateLanguage(boolean updateLanguage) Set the language.
void	setUpdateLastName(boolean updateLastName) Set the last name.

Methods inherited from class com.communote.server.api.core.user.UserVO

getAlias, getEmail, getFirstName, getLanguage, getLastName, getPassword, getRoles, getTimeZoneId, setAlias, setEmail, setFirstName, setLanguage, setLastName, setPassword, setRoles, setTimeZoneId

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalUserVO

public ExternalUserVO()

Empty constructor.

Method Detail

getAdditionalProperty

public String getAdditionalProperty()

An optional member holding some additional data for the user. The interpretation depends on the external system. For LDAP it would hold the DN for example.

Returns:

the additional property

getDefaultLanguage

public Locale getDefaultLanguage()

The default language is used if the external user is not yet created.

Returns:

the default language for this user

getExternalUserName

public String getExternalUserName()

Login name of the user in the external repository. This user name will be used to create a Communote alias, if the external user does not yet exist within Communote and the external repository does not provide another property whose value is to be used as Communote user alias. If the user name is not a legal Communote alias the local part of the email address is used as alias.

Returns:

the external user name

getPermanentId

public String getPermanentId()

Optional attribute that represents a unique identifier of the user in the external repository whose value never changes.

Returns:

the permanent id

getProperties

public Set<StringPropertyTO> getProperties()

Returns:

the properties

getStatus

public UserStatus getStatus()

Status of the user to be set. This allows deactivating a user who was disabled or removed from the external repository.

Returns:

the status

getSystemId

public String getSystemId()

Returns:

the system id

isClearPassword

public boolean isClearPassword()

Whether to clear the password of the local user.

Returns:

true if the password should be cleared

Since:

3.5

isUpdateEmail

public boolean isUpdateEmail()

Whether to update the email address of the user if it is provided. Setting this to false will prevent synchronization of an existing local user entry with data retrieved from the external repository.

Returns:

the email

isUpdateFirstName

public boolean isUpdateFirstName()

Whether to update the first name if it is provided. Setting this to false will prevent synchronization of an existing local user entry with data retrieved from the external repository.

Returns:

the first name

isUpdateLanguage

public boolean isUpdateLanguage()

Whether to update the language if it is provided. Setting this to false will prevent synchronization of an existing local user entry with data retrieved from the external repository.

Returns:

the language

isUpdateLastName

public boolean isUpdateLastName()

Whether to update the last name if it is provided. Setting this to false will prevent synchronization of an existing local user entry with data retrieved from the external repository.

Returns:

the last name

setAdditionalProperty

public void setAdditionalProperty(String additionalProperty)

Set the additional property.

Parameters:

additionalProperty - the additional property

setClearPassword

public void setClearPassword(boolean clearPassword)

Set whether a password stored for the local user belonging to this external user should be cleared. This should be true if this VO was created by the primary authentication provider to avoid logins with an old password after changing it in the external system.

Parameters:

clearPassword - true to clear the password

Since:

3.5

setDefaultLanguage

public void setDefaultLanguage(Locale defaultLanguage)

The default language is used if the external user is not yet created. If you want the language to be it for the user even he may already choosen another language use UserVO.setLanguage(Locale)

Parameters:

defaultLanguage - the default language

setExternalUserName

public void setExternalUserName(String externalUserName)

Set the external user name.

Parameters:

externalUserName - the external user name

setPermanentId

public void setPermanentId(String permanentId)

Set the permanent id.

Parameters:

permanentId - the permanent id

setProperties

public void setProperties(Set<StringPropertyTO> properties)

Set additional user properties.

Parameters:

properties - the additional properties

setStatus

public void setStatus(UserStatus status)

Set the user status.

Parameters:

status - the user status

setSystemId

public void setSystemId(String systemId)

Set the system id.

Parameters:

systemId - the system id

setUpdateEmail

public void setUpdateEmail(boolean updateEmail)

Set the email address.

Parameters:

updateEmail - the email address

setUpdateFirstName

public void setUpdateFirstName(boolean updateFirstName)

Set first name.

Parameters:

updateFirstName - the first name

setUpdateLanguage

public void setUpdateLanguage(boolean updateLanguage)

Set the language.

Parameters:

updateLanguage - the language

setUpdateLastName

public void setUpdateLastName(boolean updateLastName)

Set the last name.

Parameters:

updateLastName - the last name