com.aquenos.cassandra.pvarchiver.server.user

Class ArchiveUserDetailsManager

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.user.ArchiveUserDetailsManager

All Implemented Interfaces:

InitializingBean, UserDetailsService, UserDetailsManager

public class ArchiveUserDetailsManager
extends Object
implements InitializingBean, UserDetailsManager

Manager for archive users. This class acts as a UserDetailsService that can be used as part of the authentication system and allows modifying the user information in the database through the UserDetailsManager interface.

When used with authentication methods that result in the loadUserByUsername(String) method being called frequently (e.g. each request), it is recommended to add a UserCache to the AuthenticationProvider in order to reduce latency.

Internally, this service uses the GenericDataStoreDAO for storing user information.

Author:

Sebastian Marsching

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE_ADMIN String identifying the role associated with administrative privileges.

Constructor Summary

Constructors

Constructor and Description
ArchiveUserDetailsManager()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	changePassword(String oldPlainTextPassword, String newPlainTextPassword)
void	createUser(UserDetails user)
void	deleteUser(String username)
UserDetails	loadUserByUsername(String username)
void	setGenericDataStoreDAO(GenericDataStoreDAO genericDataStoreDAO) Sets the DAO for reading and writing generic pieces of configuration data.
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Sets the object mapper used for converting between the JSON and the Java representation of user objects.
void	setPasswordEncoder(BCryptPasswordEncoder passwordEncoder) Sets the password encoded used for encoding and checking password.
void	updateUser(UserDetails user)
boolean	userExists(String username)

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_ADMIN

public static final String ROLE_ADMIN

String identifying the role associated with administrative privileges.

See Also:

ROLE_ADMIN_AUTHORITY, Constant Field Values

Constructor Detail

ArchiveUserDetailsManager

public ArchiveUserDetailsManager()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

changePassword

public void changePassword(String oldPlainTextPassword,
                           String newPlainTextPassword)

Specified by:

changePassword in interface UserDetailsManager

createUser

public void createUser(UserDetails user)

Specified by:

createUser in interface UserDetailsManager

deleteUser

public void deleteUser(String username)

Specified by:

deleteUser in interface UserDetailsManager

loadUserByUsername

public UserDetails loadUserByUsername(String username)
                               throws UsernameNotFoundException

Specified by:

loadUserByUsername in interface UserDetailsService

Throws:

UsernameNotFoundException

setGenericDataStoreDAO

@Autowired
public void setGenericDataStoreDAO(GenericDataStoreDAO genericDataStoreDAO)

Sets the DAO for reading and writing generic pieces of configuration data. In particular, this class uses the DAO for reading and writing the user objects. Typically, this method is called automatically by the Spring container.

Parameters:

genericDataStoreDAO - generic data-store DAO to be used by this service.

setObjectMapper

public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Sets the object mapper used for converting between the JSON and the Java representation of user objects. If not set explicitly, an object mapper using a default configuration suitable for this purpose is created.

Parameters:

objectMapper - object mapper used for serializing user objects to and deserializing user objects from their JSON representation, which is used when storing them in the database.

setPasswordEncoder

public void setPasswordEncoder(BCryptPasswordEncoder passwordEncoder)

Sets the password encoded used for encoding and checking password. This encoder is used when calling the changePassword(String, String) method. All other methods only deal with password hashes so that they do not need a password encoder. If not set explicitly, a BCrypt password encoder is created using the default constructor.

Parameters:

passwordEncoder - password encoder to be used for checking the old and generating the new password hash in changePassword(String, String).

updateUser

public void updateUser(UserDetails user)

Specified by:

updateUser in interface UserDetailsManager

userExists

public boolean userExists(String username)

Specified by:

userExists in interface UserDetailsManager