Package de.hybris.platform.servicelayer.user.impl

Class DefaultUserService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.servicelayer.user.impl.DefaultUserService

All Implemented Interfaces:

UserService, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

BackofficeUserService, SecureUserService

public class DefaultUserService
extends AbstractBusinessService
implements UserService

Default implementation of the user service interface.

Since:

4.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultUserService()

Method Summary

Modifier and Type	Method	Description
protected void	assurePasswordCompliance(UserModel user, String plainPassword, String encoding)
EmployeeModel	getAdminUser()	Returns always the admin user.
UserGroupModel	getAdminUserGroup()	Returns always the admin user group.
Collection<TitleModel>	getAllTitles()	Returns all TitleModels in the system.
Set<UserGroupModel>	getAllUserGroupsForUser(UserModel user)	Gets all user groups for the given user.
<T extends UserGroupModel> Set<T>	getAllUserGroupsForUser(UserModel user, Class<T> clazz)	Gets all user groups for the given user and specified (result) class.
<T extends UserGroupModel> Set<T>	getAllUserGroupsForUserGroup(UserGroupModel userGroup, Class<T> clazz)	Gets all user groups for the given user group and specified (result) class.
CustomerModel	getAnonymousUser()	Returns always the anonymous user.
UserModel	getCurrentUser()	Returns the current user from the Session.
String	getDefaultPasswordEncoding()
String	getPassword(UserModel user)	Returns for the given user the decoded password if this is possible.
String	getPassword(String userId)	If possible returns the decoded password from the given user.
protected String	getRealEncoding(String optionalEncoding)
TitleModel	getTitleForCode(String code)	Returns the TitleModel for the specified code.
UserModel	getUser(String uid)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.1.0
List<AbstractUserAuditModel>	getUserAudits(UserModel user)	Gets audit information about user previous password hashes.
UserModel	getUserForUID(String userId)	Returns the UserModel for the specified userId
<T extends UserModel> T	getUserForUID(String userId, Class<T> clazz)	Returns for the specified userId and the specified (result) class the found user in the specified class.
UserGroupModel	getUserGroup(String groupId)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.1.0
UserGroupModel	getUserGroupForUID(String uid)	Returns the UserGroupModel for the specified uid.
<T extends UserGroupModel> T	getUserGroupForUID(String uid, Class<T> clazz)	Returns the UserGroupModel for the specified uid and the specified (result) class.
boolean	isAdmin(UserModel user)	Checks if the given user has the admin role.
boolean	isAdminEmployee(UserModel user)	Checks if the given user has the is the admin employee.
boolean	isAdminGroup(UserGroupModel userGroup)	Checks if the given user group or it's super groups have the admin role.
boolean	isAnonymousUser(UserModel user)	Checks if the given user is the anonymous customer.
boolean	isMemberOfGroup(UserGroupModel member, UserGroupModel groupToCheckFor)	Checks if the given user group is a member of the specified groupToCheckFor or its super groups.
boolean	isMemberOfGroup(UserGroupModel member, UserGroupModel groupToCheckFor, boolean includeSuperGroups)	Checks if the given user group is a member of the specified groupToCheckFor or its super groups if includeSubGroups is set to true.
boolean	isMemberOfGroup(UserModel member, UserGroupModel groupToCheckFor)	Checks if the given user is a member of the specified groupToCheckFor or its super groups.
boolean	isMemberOfGroup(UserModel member, UserGroupModel groupToCheckFor, boolean includeSuperGroups)	Checks if the given user is a member of the specified groupToCheckFor or its super groups if includeSubGroups is set to true.
boolean	isPasswordIdenticalToAudited(UserModel user, String plainPassword, UserPasswordChangeAuditModel audit)	Checks if password is the same as the previous password.
boolean	isUserExisting(String uid)	Checks if for the specified uid a user exists in the system.
void	setCurrentUser(UserModel user)	Sets the given user as current user on the Session.
void	setDefaultPasswordEncoding(String defaultPasswordEncoding)
void	setEncodedPassword(UserModel user, String encodedPassword)	Sets the encoded password to the given user.
void	setEncodedPassword(UserModel user, String encodedPassword, String encoding)	Sets the encoded password to the given user.
void	setEventService(EventService eventService)
void	setPassword(UserModel user, String plainPassword)	Encodes the given plain text password with the user's password encoding (using the default encoding if the user doesn't have one) and set the encoded password to the given user.
void	setPassword(UserModel user, String plainPassword, String encoding)	Encodes the given plain text password with the given password encoding and set the encoded password to the given user.
void	setPassword(String userId, String password)	Encodes the given plain text password with the default password encoding and set the encoded password to the given user.
void	setPassword(String userId, String password, String encoding)	Sets the password according to the given encoding for the given user id.
void	setPasswordEncoderService(PasswordEncoderService passwordEncoderService)
void	setPasswordPolicyService(PasswordPolicyService passwordPolicyService)
void	setPasswordWithDefaultEncoding(UserModel user, String plainPassword)	Encodes the given plain text password with the default password encoding and set the encoded password to the given user.
void	setSearchRestrictionService(SearchRestrictionService searchRestrictionService)
void	setTitleDao(TitleDao titleDao)
void	setUserAuditDao(UserAuditDao userAuditDao)
void	setUserDao(UserDao userDao)
void	setUserGroupDao(UserGroupDao userGroupDao)

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultUserService

public DefaultUserService()

Method Details

getUser

@Deprecated(since="6.1.0",
            forRemoval=true)
public UserModel getUser(String uid)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.1.0

Description copied from interface: UserService

Returns the UserModel by the specified userId

Specified by:

getUser in interface UserService

Parameters:

uid - the specified userId

Returns:

the UserModel

getUserForUID

public UserModel getUserForUID(String userId)

Description copied from interface: UserService

Returns the UserModel for the specified userId

Specified by:

getUserForUID in interface UserService

Parameters:

userId - the unique userId of the user

Returns:

the UserModel or a subtype of it.

getUserForUID

public <T extends UserModel> T getUserForUID(String userId,
 Class<T> clazz)

Description copied from interface: UserService

Returns for the specified userId and the specified (result) class the found user in the specified class. Throws exception otherwise.

Specified by:

getUserForUID in interface UserService

Parameters:

userId - The unique userId of the user to be searched for.

clazz - The user must match the given class (employee, customer, ...). Can be a UserModel or any subtype of it.

isUserExisting

public boolean isUserExisting(String uid)

Description copied from interface: UserService

Checks if for the specified uid a user exists in the system.

Specified by:

isUserExisting in interface UserService

Parameters:

uid - of the user

Returns:

true if a user exists, otherwise false

getUserGroup

@Deprecated(since="6.1.0",
            forRemoval=true)
public UserGroupModel getUserGroup(String groupId)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.1.0

Description copied from interface: UserService

Returns the UserGroupModel by the specified userGroupId

Specified by:

getUserGroup in interface UserService

Parameters:

groupId - the specified userGroupId

Returns:

the UserGroupModel

getCurrentUser

public UserModel getCurrentUser()

Description copied from interface: UserService

Returns the current user from the Session.

Specified by:

getCurrentUser in interface UserService

Returns:

the current UserModel

setCurrentUser

public void setCurrentUser(UserModel user)

Description copied from interface: UserService

Sets the given user as current user on the Session.

After changing the user current user a AfterSessionUserChangeEvent is fired.

Please note: With hybris 4.3 this method doesn't trigger a call of JaloSessionListener.afterSessionUserChange(de.hybris.platform.jalo.JaloSession, de.hybris.platform.jalo.user.User) in the jalo-layer!

Specified by:

setCurrentUser in interface UserService

Parameters:

user - the user to set as current

getPassword

public String getPassword(UserModel user)
                   throws CannotDecodePasswordException,
PasswordEncoderNotFoundException

Description copied from interface: UserService

Returns for the given user the decoded password if this is possible.

Specified by:

getPassword in interface UserService

Parameters:

user - the user where the password should be decoded

Returns:

the decoded password if possible

Throws:

CannotDecodePasswordException - if the encoded password UserModel.getEncodedPassword() cannot be decoded.

PasswordEncoderNotFoundException - is thrown if given encoding does not match any password encoder in the system

setPassword

public void setPassword(UserModel user,
 String plainPassword,
 String encoding)

Description copied from interface: UserService

Encodes the given plain text password with the given password encoding and set the encoded password to the given user.

Specified by:

setPassword in interface UserService

Parameters:

user - the encoded password is set to UserModel.setEncodedPassword(String)

plainPassword - the plain text password for the user

encoding - the password encidung, must exist

assurePasswordCompliance

protected void assurePasswordCompliance(UserModel user,
 String plainPassword,
 String encoding)

getRealEncoding

protected String getRealEncoding(String optionalEncoding)

setPasswordWithDefaultEncoding

public void setPasswordWithDefaultEncoding(UserModel user,
 String plainPassword)
                                    throws PasswordEncoderNotFoundException

Description copied from interface: UserService

Encodes the given plain text password with the default password encoding and set the encoded password to the given user.

Specified by:

setPasswordWithDefaultEncoding in interface UserService

Parameters:

user - the encoded password is set to UserModel.setEncodedPassword(String)

plainPassword - the plain text password for the user

Throws:

PasswordEncoderNotFoundException

getPassword

public String getPassword(String userId)
                   throws CannotDecodePasswordException,
PasswordEncoderNotFoundException

Description copied from interface: UserService

If possible returns the decoded password from the given user. Throws exception if decoding is not possible.

Specified by:

getPassword in interface UserService

Parameters:

userId - the user ID from the user

Returns:

password text in plain text

Throws:

CannotDecodePasswordException - if decode of the password is not possible (example: MD5)

PasswordEncoderNotFoundException - if for the given password encoding (see UserModel.getPasswordEncoding() no password encoder was found

setPassword

public void setPassword(String userId,
 String password)
                 throws PasswordEncoderNotFoundException

Description copied from interface: UserService

Encodes the given plain text password with the default password encoding and set the encoded password to the given user.

Specified by:

setPassword in interface UserService

Parameters:

userId - the user ID of the user

password - the plain text password

Throws:

PasswordEncoderNotFoundException - if for the given password encoding (see UserModel.getPasswordEncoding() no password encoder was found

setPassword

public void setPassword(String userId,
 String password,
 String encoding)
                 throws PasswordEncoderNotFoundException

Description copied from interface: UserService

Sets the password according to the given encoding for the given user id.

Specified by:

setPassword in interface UserService

Parameters:

userId - the user ID

password - the plain password

encoding - the encoding to encode the given password

Throws:

PasswordEncoderNotFoundException - is thrown if given encoding does not match any password encoder in the system

getUserGroupForUID

public UserGroupModel getUserGroupForUID(String uid)

Description copied from interface: UserService

Returns the UserGroupModel for the specified uid.

Specified by:

getUserGroupForUID in interface UserService

Parameters:

uid - the unique uid of the group

Returns:

the found UserGroupModel (or a subtype of it).

getUserGroupForUID

public <T extends UserGroupModel> T getUserGroupForUID(String uid,
 Class<T> clazz)

Description copied from interface: UserService

Returns the UserGroupModel for the specified uid and the specified (result) class.

The found user group must be an instance of the given class, otherwise an exception is thrown.

Specified by:

getUserGroupForUID in interface UserService

Parameters:

uid - The unique uid of the user group to be searched for.

clazz - The user group must match the given class. Can be a UserGroupModel or any subtype of it.

Returns:

the found UserGroupModel

getAllUserGroupsForUser

public Set<UserGroupModel> getAllUserGroupsForUser(UserModel user)

Description copied from interface: UserService

Gets all user groups for the given user.

The Set of user groups is collected recursively.

Specified by:

getAllUserGroupsForUser in interface UserService

Parameters:

user - the given user

Returns:

Set of user groups

getAllUserGroupsForUser

public <T extends UserGroupModel> Set<T> getAllUserGroupsForUser(UserModel user,
 Class<T> clazz)

Description copied from interface: UserService

Gets all user groups for the given user and specified (result) class. If the user is in a user group which is not assignable from the given clazz then this group is not in the result set. Use UserService.getUserGroupForUID(String) if all groups are needed.

The Set of user groups is collected recursively.

Specified by:

getAllUserGroupsForUser in interface UserService

Parameters:

user - the given user

clazz - the user group must match the given class. Can be a UserGroupModel or any subtype of it.

Returns:

Set of user groups which must be instances of the specified result class

getAllUserGroupsForUserGroup

public <T extends UserGroupModel> Set<T> getAllUserGroupsForUserGroup(UserGroupModel userGroup,
 Class<T> clazz)

Description copied from interface: UserService

Gets all user groups for the given user group and specified (result) class. If the user is in a user group which is not assignable from the given clazz then this group is not in the result set. Use UserService.getUserGroupForUID(String) if all groups are needed.

The Set of user groups is collected recursively.

Specified by:

getAllUserGroupsForUserGroup in interface UserService

Parameters:

userGroup - the given user group

clazz - the user group must match the given class. Can be a UserGroupModel or any subtype of it.

Returns:

Set of user groups which must be instances of the specified result class

getUserAudits

public List<AbstractUserAuditModel> getUserAudits(UserModel user)

Description copied from interface: UserService

Gets audit information about user previous password hashes. Can be used to implement password policy that does not allow to reuse previous passwords.

Specified by:

getUserAudits in interface UserService

Returns:

isPasswordIdenticalToAudited

public boolean isPasswordIdenticalToAudited(UserModel user,
 String plainPassword,
 UserPasswordChangeAuditModel audit)

Description copied from interface: UserService

Checks if password is the same as the previous password. Password stored in audit information is hashed so this method hashes plain password and compares them.

Specified by:

isPasswordIdenticalToAudited in interface UserService

Returns:

true if password is the same as audit, otherwise false

isMemberOfGroup

public boolean isMemberOfGroup(UserModel member,
 UserGroupModel groupToCheckFor)

Description copied from interface: UserService

Checks if the given user is a member of the specified groupToCheckFor or its super groups.

The super groups are collected recursively.

Specified by:

isMemberOfGroup in interface UserService

Parameters:

member - the user to check

groupToCheckFor - the group(s) to be checked for

Returns:

true if the user is a member of this group, otherwise false

isMemberOfGroup

public boolean isMemberOfGroup(UserModel member,
 UserGroupModel groupToCheckFor,
 boolean includeSuperGroups)

Description copied from interface: UserService

Checks if the given user is a member of the specified groupToCheckFor or its super groups if includeSubGroups is set to true.

The super groups are collected recursively.

Specified by:

isMemberOfGroup in interface UserService

Parameters:

member - the user to check

groupToCheckFor - the group(s) to be checked for

includeSuperGroups - should include super groups in search

Returns:

true if the user is a member of this group, otherwise false

isMemberOfGroup

public boolean isMemberOfGroup(UserGroupModel member,
 UserGroupModel groupToCheckFor)

Description copied from interface: UserService

Checks if the given user group is a member of the specified groupToCheckFor or its super groups.

The super groups are collected recursively.

Specified by:

isMemberOfGroup in interface UserService

Parameters:

member - the user group to check

groupToCheckFor - the group(s) to be checked for

Returns:

true if the user group is a member of this group, otherwise false

isMemberOfGroup

public boolean isMemberOfGroup(UserGroupModel member,
 UserGroupModel groupToCheckFor,
 boolean includeSuperGroups)

Description copied from interface: UserService

Checks if the given user group is a member of the specified groupToCheckFor or its super groups if includeSubGroups is set to true.

The super groups are collected recursively.

Specified by:

isMemberOfGroup in interface UserService

Parameters:

member - the user group to check

groupToCheckFor - the group(s) to be checked for

includeSuperGroups - should include super groups in search

Returns:

true if the user group is a member of this group, otherwise false

getAllTitles

public Collection<TitleModel> getAllTitles()

Description copied from interface: UserService

Returns all TitleModels in the system.

Specified by:

getAllTitles in interface UserService

Returns:

an empty collection if no TitleModel was found.

getTitleForCode

public TitleModel getTitleForCode(String code)

Description copied from interface: UserService

Returns the TitleModel for the specified code.

Specified by:

getTitleForCode in interface UserService

Parameters:

code - the unique code of the title

getAdminUser

public EmployeeModel getAdminUser()

Description copied from interface: UserService

Returns always the admin user. Search restrictions are disabled for this call.

Specified by:

getAdminUser in interface UserService

Returns:

the system admin user as EmployeeModel

getAdminUserGroup

public UserGroupModel getAdminUserGroup()

Description copied from interface: UserService

Returns always the admin user group. Search restrictions are disabled for this call.

Specified by:

getAdminUserGroup in interface UserService

Returns:

the admin user group as UserGroupModel

isAdmin

public boolean isAdmin(UserModel user)

Description copied from interface: UserService

Checks if the given user has the admin role.

The user is an admin if either the user is the admin employee or the user is a member of the admin user group (see UserService.getAdminUserGroup()).

Specified by:

isAdmin in interface UserService

Parameters:

user - user to check

Returns:

true if the user is an admin, otherwise false

isAdminGroup

public boolean isAdminGroup(UserGroupModel userGroup)

Description copied from interface: UserService

Checks if the given user group or it's super groups have the admin role.

Specified by:

isAdminGroup in interface UserService

Parameters:

userGroup - user to check

Returns:

true if the user is an admin, otherwise false

isAdminEmployee

public boolean isAdminEmployee(UserModel user)

Description copied from interface: UserService

Checks if the given user has the is the admin employee.

see UserService.getAdminUser()).

Specified by:

isAdminEmployee in interface UserService

Parameters:

user - user to check

Returns:

true if the user is an admin employee, otherwise false

getAnonymousUser

public CustomerModel getAnonymousUser()

Description copied from interface: UserService

Returns always the anonymous user. Search restrictions are disabled for this call.

Specified by:

getAnonymousUser in interface UserService

Returns:

the anonymous user as CustomerModel

isAnonymousUser

public boolean isAnonymousUser(UserModel user)

Description copied from interface: UserService

Checks if the given user is the anonymous customer.

Specified by:

isAnonymousUser in interface UserService

Parameters:

user - the user to check

Returns:

true if the user is the anonymous customer, otherwise false

setEncodedPassword

public void setEncodedPassword(UserModel user,
 String encodedPassword)

Description copied from interface: UserService

Sets the encoded password to the given user.

The encoding is taken form user or if null the system default encoding is used.

Specified by:

setEncodedPassword in interface UserService

Parameters:

user - the encoded password is set to UserModel.setEncodedPassword(String)

encodedPassword - encoded password for the user

setEncodedPassword

public void setEncodedPassword(UserModel user,
 String encodedPassword,
 String encoding)

Description copied from interface: UserService

Sets the encoded password to the given user.

Specified by:

setEncodedPassword in interface UserService

Parameters:

user - the encoded password is set to UserModel.setEncodedPassword(String)

encodedPassword - encoded password for the user

encoding - the password encoding

setUserDao

public void setUserDao(UserDao userDao)

setUserGroupDao

public void setUserGroupDao(UserGroupDao userGroupDao)

setTitleDao

public void setTitleDao(TitleDao titleDao)

setSearchRestrictionService

public void setSearchRestrictionService(SearchRestrictionService searchRestrictionService)

setEventService

public void setEventService(EventService eventService)

setPasswordEncoderService

public void setPasswordEncoderService(PasswordEncoderService passwordEncoderService)

getDefaultPasswordEncoding

public String getDefaultPasswordEncoding()

setDefaultPasswordEncoding

public void setDefaultPasswordEncoding(String defaultPasswordEncoding)

setPassword

public void setPassword(UserModel user,
 String plainPassword)
                 throws PasswordEncoderNotFoundException

Description copied from interface: UserService

Encodes the given plain text password with the user's password encoding (using the default encoding if the user doesn't have one) and set the encoded password to the given user.

Specified by:

setPassword in interface UserService

Parameters:

user - the encoded password is set to UserModel.setEncodedPassword(String)

plainPassword - the plain text password for the user

Throws:

PasswordEncoderNotFoundException - if for the given password encoding (see UserModel.getPasswordEncoding() no password encoder was found

setPasswordPolicyService

public void setPasswordPolicyService(PasswordPolicyService passwordPolicyService)

setUserAuditDao

public void setUserAuditDao(UserAuditDao userAuditDao)