Package com.gigaspaces.security.fs

Class FileUserManager

java.lang.Object

com.gigaspaces.security.fs.FileUserManager

All Implemented Interfaces:

UserManager

public class FileUserManager
extends Object
implements UserManager

A file based UserManager responsible for managing users stored in a file. The file is read on construction and written to on the call to #close().

A UserDetails password is encrypted using the defined PasswordEncoder. The encoded password is set, assuming that UserDetails has a setPassword(String) method. If one isn't declared an exception is thrown.

Since:

7.0.1

Author:

Moran Avigdor

Constructor Summary

Constructors

Constructor	Description
FileUserManager(FileServiceAccessor fileServiceAccessor, boolean isReadOnly)

Method Summary

Modifier and Type	Method	Description
void	createUser(UserDetails userDetails)	Create a new user with the specified userDetails.
void	deleteUser(String username)	Delete an existing user represented by the specified username.
UserDetails	getUser(String username)	Retrieve the user details by username.
boolean	isReadOnly()	Indicates that this manager is for read-only purposes, and that any invocation of a destructive operation will throw an AccessDeniedException.
Map<String,UserDetails>	mapUsers()	Returns a map containing mapping between username and user-details.
void	updateUser(UserDetails userDetails)	Updates the user details, excluding the username which must remain the same.
boolean	userExists(String username)	Queries for presence of a user by username.

Methods inherited from class java.lang.Object

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

Constructor Details

FileUserManager

public FileUserManager(FileServiceAccessor fileServiceAccessor,
 boolean isReadOnly)

Method Details

isReadOnly

public boolean isReadOnly()

Description copied from interface: UserManager

Indicates that this manager is for read-only purposes, and that any invocation of a destructive operation will throw an AccessDeniedException.

Specified by:

isReadOnly in interface UserManager

Returns:

true if read-only access is allowed.

createUser

public void createUser(UserDetails userDetails)
                throws UserAlreadyExistsException,
UserDataAccessException,
AccessDeniedException

Description copied from interface: UserManager

Create a new user with the specified userDetails.

Specified by:

createUser in interface UserManager

Parameters:

userDetails - new user details to store.

Throws:

UserAlreadyExistsException - if the user details represent a non-unique user

UserDataAccessException - if could not store the specified user details.

AccessDeniedException - if read-only access is allowed.

deleteUser

public void deleteUser(String username)
                throws UserNotFoundException,
UserDataAccessException,
AccessDeniedException

Description copied from interface: UserManager

Delete an existing user represented by the specified username.

Specified by:

deleteUser in interface UserManager

Parameters:

username - an existing user name.

Throws:

UserNotFoundException - if the user was not found.

UserDataAccessException - if could not delete the specified user details.

AccessDeniedException - if read-only access is allowed.

getUser

public UserDetails getUser(String username)
                    throws UserNotFoundException,
UserDataAccessException

Description copied from interface: UserManager

Retrieve the user details by username.

Specified by:

getUser in interface UserManager

Parameters:

username - an existing user to retrieve.

Returns:

the user details of the specified user.

Throws:

UserNotFoundException - if the user was not found.

UserDataAccessException - if could not retrieve the specified user details.

mapUsers

public Map<String,UserDetails> mapUsers()
                                 throws UserDataAccessException

Description copied from interface: UserManager

Returns a map containing mapping between username and user-details.

Specified by:

mapUsers in interface UserManager

Returns:

a mapping between username and user-details.

Throws:

UserDataAccessException - if could not retrieve user-details to map.

updateUser

public void updateUser(UserDetails userDetails)
                throws UserNotFoundException,
UserDataAccessException

Description copied from interface: UserManager

Updates the user details, excluding the username which must remain the same. In order to update a username, a user must be removed and re-created. A password on the other hand, may require encryption, only if it was modified.

Specified by:

updateUser in interface UserManager

Parameters:

userDetails - the user details to update.

Throws:

UserNotFoundException - if the user was not found.

UserDataAccessException - if could not update the user details.

userExists

public boolean userExists(String username)
                   throws UserDataAccessException

Description copied from interface: UserManager

Queries for presence of a user by username.

Specified by:

userExists in interface UserManager

Parameters:

username - the user to check existence for.

Returns:

true if the user exists; false otherwise.

Throws:

UserDataAccessException - if could not query for the specified user.