Package com.gigaspaces.security.fs

Class FileServiceAccessor

java.lang.Object

com.gigaspaces.security.fs.FileServiceAccessor

public class FileServiceAccessor
extends Object

An internal accessor on top of a FileService, holding a file-content cache, and the encoding manager. Is used to load a user, and populate it with roles.

Since:

7.0.1

Author:

Moran Avigdor

Constructor Summary

Constructors

Constructor	Description
FileServiceAccessor(FileService fileService, FileEncodingManager fileEncodingManager)

Method Summary

Modifier and Type	Method	Description
void	close()
FileContent	getFileContent()
FileEncodingManager	getFileEncodingManager()
UserDetails	loadUserByUsername(String username)	Locates the user by username, returning a fully populated user record (including authorities normalized from their role representation).

Methods inherited from class java.lang.Object

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

Constructor Details

FileServiceAccessor

public FileServiceAccessor(FileService fileService,
 FileEncodingManager fileEncodingManager)
                    throws IOException

Throws:

IOException

Method Details

loadUserByUsername

public UserDetails loadUserByUsername(String username)
                               throws UserNotFoundException,
UserDataAccessException,
RoleNotFoundException,
RoleDataAccessException,
IOException

Locates the user by username, returning a fully populated user record (including authorities normalized from their role representation).

A role is represented by RoleAuthority. Commonly, a roles' authorities need to be extracted from a 'roles-table'. To fully populate the user record, the authorities represented by this role need to be added to the authorities returned by UserDetails.getAuthorities(). Thus, the returned user record is normalized to include all authorities regardless of the implementation details.

Of course, when normalizing we immediately loose the notion of a role. For presentation purposes, we might want to keep this distinction. A PopulatedRoleAuthority may be used to aggregate all the authorities represented by this role. It can be added as an Authority to the authorities returned by UserDetails.getAuthorities().

Parameters:

username - the user name represented as part of the authentication request.

Returns:

a fully populated user record (never null).

Throws:

UserNotFoundException - if the user can not be found.

UserDataAccessException - if an exception was thrown accessing a user record.

RoleNotFoundException - if the role associated to this user can not be found.

RoleDataAccessException - if an exception was thrown accessing a role record.

IOException

close

public void close()
           throws IOException

Throws:

IOException

getFileEncodingManager

public FileEncodingManager getFileEncodingManager()

Returns:

the fileEncodingManager

getFileContent

public FileContent getFileContent()

Returns:

the fileContent