Package com.gigaspaces.security.fs

Class FileRoleManager

java.lang.Object

com.gigaspaces.security.fs.FileRoleManager

All Implemented Interfaces:

RoleManager

public class FileRoleManager
extends Object
implements RoleManager

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

Since:

7.0.1

Author:

Moran Avigdor

Constructor Summary

Constructors

Constructor	Description
FileRoleManager(FileServiceAccessor fileServiceAccessor, boolean isReadOnly)

Method Summary

Modifier and Type	Method	Description
void	createRole(RoleDetails roleDetails)	Create a new role with the specified roleDetails.
void	deleteRole(String role)	Delete an existing role represented by the specified role.
RoleDetails	getRole(String role)	Retrieve the role details by role.
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,RoleDetails>	mapRoles()	Returns a map containing mapping between role and role-details.
boolean	roleExists(String role)	Queries for presence of a role by role.
void	updateRole(RoleDetails roleDetails)	Updates the role details, excluding the role which must remain the same.

Methods inherited from class java.lang.Object

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

Constructor Details

FileRoleManager

public FileRoleManager(FileServiceAccessor fileServiceAccessor,
 boolean isReadOnly)

Method Details

isReadOnly

public boolean isReadOnly()

Description copied from interface: RoleManager

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 RoleManager

Returns:

true if read-only access is allowed.

createRole

public void createRole(RoleDetails roleDetails)
                throws RoleAlreadyExistsException,
RoleDataAccessException,
AccessDeniedException

Description copied from interface: RoleManager

Create a new role with the specified roleDetails.

Specified by:

createRole in interface RoleManager

Parameters:

roleDetails - new role details to store.

Throws:

RoleAlreadyExistsException - if the role details represent a non-unique role

RoleDataAccessException - if could not store the specified role details.

AccessDeniedException - if read-only access is allowed.

deleteRole

public void deleteRole(String role)
                throws RoleNotFoundException,
RoleDataAccessException,
AccessDeniedException

Description copied from interface: RoleManager

Delete an existing role represented by the specified role.

Specified by:

deleteRole in interface RoleManager

Parameters:

role - an existing role name.

Throws:

RoleNotFoundException - if the role was not found.

RoleDataAccessException - if could not delete the specified role details.

AccessDeniedException - if read-only access is allowed.

getRole

public RoleDetails getRole(String role)
                    throws RoleNotFoundException,
RoleDataAccessException

Description copied from interface: RoleManager

Retrieve the role details by role.

Specified by:

getRole in interface RoleManager

Parameters:

role - an existing role to retrieve.

Returns:

the role details of the specified role.

Throws:

RoleNotFoundException - if the role was not found.

RoleDataAccessException - if could not retrieve the specified role details.

mapRoles

public Map<String,RoleDetails> mapRoles()
                                 throws RoleDataAccessException

Description copied from interface: RoleManager

Returns a map containing mapping between role and role-details.

Specified by:

mapRoles in interface RoleManager

Returns:

a mapping between role name and role-details.

Throws:

RoleDataAccessException - if could not retrieve role-details to map.

roleExists

public boolean roleExists(String role)
                   throws RoleDataAccessException

Description copied from interface: RoleManager

Queries for presence of a role by role.

Specified by:

roleExists in interface RoleManager

Parameters:

role - the role to check existence for.

Returns:

true if the role exists; false otherwise.

Throws:

RoleDataAccessException - if could not query for the specified role.

updateRole

public void updateRole(RoleDetails roleDetails)
                throws RoleNotFoundException,
RoleDataAccessException,
AccessDeniedException

Description copied from interface: RoleManager

Updates the role details, excluding the role which must remain the same. In order to update a role, a role must be removed and re-created.

Specified by:

updateRole in interface RoleManager

Parameters:

roleDetails - the role details to update.

Throws:

RoleNotFoundException - if the role was not found.

RoleDataAccessException - if could not update the role details.

AccessDeniedException - if read-only access is allowed.