Package ch.tocco.nice2.userbase.impl.auth

Class PrincipalManagerImpl

java.lang.Object

ch.tocco.nice2.userbase.impl.auth.PrincipalManagerImpl

All Implemented Interfaces:

PrincipalManager, PrincipalDetailService, PrincipalManagerService, PrincipalService

@Component
public class PrincipalManagerImpl
extends Object
implements PrincipalManagerService

Constructor Summary

Constructors

Constructor	Description
PrincipalManagerImpl(org.slf4j.Logger log, CommandExecutor executor, PersistenceService persistenceService, ImpliedRolesProvider impliedRolesProvider, BusinessUnitManager businessUnitManager, SecurityManager securityManager, QueryBuilderFactory queryBuilderFactory)

Method Summary

Modifier and Type	Method	Description
Map<Entity,String>	createUniqueUsernames(List<Entity> users)	Creates a unique username.
Set<Role>	getAllRoles()
Principal	getAnonymousPrincipal()
Optional<Entity>	getCurrentPrincipal()
Optional<Entity>	getCurrentUser()
Principal	getPrincipal(String name, boolean withRoles)	Returns the principal from the underlying store.
@Nullable PrincipalDetails	getPrincipalDetails(String username, Object credentials)	Return details of the user specified by username.
Optional<Entity>	getPrincipalEntity(String username)
Role	getRole(String name)
Set<Role>	getRolesFor(String principal)	Creates a query to retrieve all roles for a principal according to the business unit currently on the thread.
Optional<Entity>	getUserEntity(String username)
void	loginNewlyCreatedUser(Entity userEntity)	Logs in a (newly created) user.
void	loginUser(String username)	Logs in a user by username.
void	resetPrincipalFields(Entity principal, PrincipalFields... fields)
void	resetPrincipalFields(String username, PrincipalFields... fields)
void	resetTemporaryPassword(String username)	Invalidates the state of the temporary password request mechanism, resetting temporary_password to null and setting the flag requiring a new password after login to false.
void	setNewPassword(String username, String newPassword, boolean resetRequired)	Sets new password and required-flag.
void	setTemporaryPassword(String username, String newPassword)	Sets the temporary_password for the given principal, which will be valid for login as well until it expires based on the last_password_dispatch.
void	updatePrincipalFields(Entity principal, PrincipalFields... fields)
void	updatePrincipalFields(String username, PrincipalFields... fields)
void	updateTwoFactorData(String username, String secret)

Methods inherited from class java.lang.Object

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

Constructor Details

PrincipalManagerImpl

public PrincipalManagerImpl(org.slf4j.Logger log,
 CommandExecutor executor,
 PersistenceService persistenceService,
 ImpliedRolesProvider impliedRolesProvider,
 BusinessUnitManager businessUnitManager,
 SecurityManager securityManager,
 QueryBuilderFactory queryBuilderFactory)

Method Details

getAnonymousPrincipal

public Principal getAnonymousPrincipal()

Specified by:

getAnonymousPrincipal in interface PrincipalManager

getPrincipal

public Principal getPrincipal(String name,
 boolean withRoles)

Description copied from interface: PrincipalManager

Returns the principal from the underlying store. The withRoles argument specifies whether the principal's roles should also be loaded.

Specified by:

getPrincipal in interface PrincipalManager

getRole

public Role getRole(String name)

Specified by:

getRole in interface PrincipalManager

getAllRoles

public Set<Role> getAllRoles()

Specified by:

getAllRoles in interface PrincipalManager

getRolesFor

public Set<Role> getRolesFor(String principal)

Creates a query to retrieve all roles for a principal according to the business unit currently on the thread. Roles assigned to a principal with a login role having no related business unit are loaded regardless of the current business unit.

Specified by:

getRolesFor in interface PrincipalManager

setNewPassword

public void setNewPassword(String username,
 String newPassword,
 boolean resetRequired)

Description copied from interface: PrincipalService

Sets new password and required-flag.

Specified by:

setNewPassword in interface PrincipalService

Parameters:

username - the name of the principal to set new password to

newPassword - the new password to set

resetRequired - value of require-new-password flag

setTemporaryPassword

public void setTemporaryPassword(String username,
 String newPassword)

Description copied from interface: PrincipalService

Sets the temporary_password for the given principal, which will be valid for login as well until it expires based on the last_password_dispatch.

Specified by:

setTemporaryPassword in interface PrincipalService

Parameters:

username - the name of the principal

newPassword - the temporary_password

resetTemporaryPassword

public void resetTemporaryPassword(String username)

Description copied from interface: PrincipalService

Invalidates the state of the temporary password request mechanism, resetting temporary_password to null and setting the flag requiring a new password after login to false.

Specified by:

resetTemporaryPassword in interface PrincipalService

Parameters:

username - the name of the principal to modify

updatePrincipalFields

public void updatePrincipalFields(String username,
 PrincipalFields... fields)

Specified by:

updatePrincipalFields in interface PrincipalService

resetPrincipalFields

public void resetPrincipalFields(String username,
 PrincipalFields... fields)

Specified by:

resetPrincipalFields in interface PrincipalService

updatePrincipalFields

public void updatePrincipalFields(Entity principal,
 PrincipalFields... fields)

Specified by:

updatePrincipalFields in interface PrincipalService

resetPrincipalFields

public void resetPrincipalFields(Entity principal,
 PrincipalFields... fields)

Specified by:

resetPrincipalFields in interface PrincipalService

getPrincipalDetails

@Nullable
public @Nullable PrincipalDetails getPrincipalDetails(String username,
 Object credentials)

Description copied from interface: PrincipalDetailService

Return details of the user specified by username.

Specified by:

getPrincipalDetails in interface PrincipalDetailService

getCurrentPrincipal

public Optional<Entity> getCurrentPrincipal()

Specified by:

getCurrentPrincipal in interface PrincipalService

getCurrentUser

public Optional<Entity> getCurrentUser()

Specified by:

getCurrentUser in interface PrincipalService

getPrincipalEntity

public Optional<Entity> getPrincipalEntity(String username)

Specified by:

getPrincipalEntity in interface PrincipalService

getUserEntity

public Optional<Entity> getUserEntity(String username)

Specified by:

getUserEntity in interface PrincipalService

loginNewlyCreatedUser

public void loginNewlyCreatedUser(Entity userEntity)

Description copied from interface: PrincipalService

Logs in a (newly created) user. Takes the related principal (only supported with one principal!). For example used in flows where new users (and thus logins) are created. Use with care!

Specified by:

loginNewlyCreatedUser in interface PrincipalService

loginUser

public void loginUser(String username)

Description copied from interface: PrincipalService

Logs in a user by username. Use with care!

Specified by:

loginUser in interface PrincipalService

createUniqueUsernames

public Map<Entity,String> createUniqueUsernames(List<Entity> users)

Description copied from interface: PrincipalService

Creates a unique username. Based on the User's email or firstname and lastname.

Specified by:

createUniqueUsernames in interface PrincipalService

updateTwoFactorData

public void updateTwoFactorData(String username,
 String secret)

Specified by:

updateTwoFactorData in interface PrincipalManager