Package org.molgenis.data.security.permission

Interface PermissionService

All Known Implementing Classes:

PermissionServiceDecorator, PermissionServiceImpl

public interface PermissionService

Method Summary

Modifier and Type	Method	Description
void	addType(String typeId)	Add a Type to the database
void	createAcl(org.springframework.security.acls.model.ObjectIdentity objectIdentity)	Creates an access control list for the given object identity
void	createPermission(Permission permissions)	Creates a permission for a user on an object identity
void	createPermissions(Set<Permission> permissions)	Creates permissions for a user on an object identity
void	deletePermission(org.springframework.security.acls.model.Sid sid, org.springframework.security.acls.model.ObjectIdentity objectIdentity)	Deletes a existing permission for a user on an object identity
void	deleteType(String typeId)	Removes a Type from the database
boolean	exists(org.springframework.security.acls.model.ObjectIdentity objectIdentity, org.springframework.security.acls.model.Sid sid)	Checks if a there is a permission in the system for the combination of a sid and an objectIdentity
Set<LabelledType>	getLabelledTypes()	Retrieves the types that are available in the system
Set<LabelledObject>	getObjects(String typeId, int page, int pageSize)	Retrieves the objects of a type in the system
Set<LabelledPermission>	getPermissions(Set<org.springframework.security.acls.model.Sid> sids, boolean includeInheritance)	Retrieves all permissions for one or more users
Set<LabelledPermission>	getPermissionsForObject(org.springframework.security.acls.model.ObjectIdentity objectIdentity, Set<org.springframework.security.acls.model.Sid> sids, boolean includeInheritance)	Retrieves the permissions for a object for one or more users
Map<String,Set<LabelledPermission>>	getPermissionsForType(String typeId, Set<org.springframework.security.acls.model.Sid> sids, boolean includeInheritance)	Retrieves the permissions for all objects of a type for one or more users
Map<String,Set<LabelledPermission>>	getPermissionsForType(String typeId, Set<org.springframework.security.acls.model.Sid> sids, int page, int pageSize)	Retrieves the permissions for all objects of a type for one or more users
Set<PermissionSet>	getSuitablePermissionsForType(String typeId)	Retrieves the permissions that can be granted of objects of a certain type
void	updatePermission(Permission permissions)	Updates a existing permission for a user on an object identity
void	updatePermissions(Set<Permission> permissions)	Updates existing permissions for a user on an object identity

Method Detail

createAcl

void createAcl(org.springframework.security.acls.model.ObjectIdentity objectIdentity)

Creates an access control list for the given object identity

Throws:

org.springframework.security.acls.model.AlreadyExistsException - if this ACL already exists

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

PermissionNotSuitableException - if the permission is not suitable for the type of object

UnknownEntityException - if the combination of Type and Identifier of the object identity does not corresponds to an entity

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

createPermission

void createPermission(Permission permissions)

Creates a permission for a user on an object identity

Throws:

DuplicatePermissionException - if there is already a permission set for this combination of sid and objectIdentity

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

PermissionNotSuitableException - if the permission is not suitable for the type of object

UnknownEntityException - if the combination of Type and Identifier of the object identity does not corresponds to an entity

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

createPermissions

void createPermissions(Set<Permission> permissions)

Creates permissions for a user on an object identity

Throws:

DuplicatePermissionException - if there is already a permission set for a combination of sid and objectIdentity

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

PermissionNotSuitableException - if the permission is not suitable for the type of object

UnknownEntityException - if the combination of Type and Identifier of the object identity does not corresponds to an entity

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

updatePermission

void updatePermission(Permission permissions)

Updates a existing permission for a user on an object identity

Throws:

UnknownAceException - if there can be no permission found to update

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

PermissionNotSuitableException - if the permission is not suitable for the type of object

UnknownEntityException - if the combination of Type and Identifier of the object identity does not corresponds to an entity

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

updatePermissions

void updatePermissions(Set<Permission> permissions)

Updates existing permissions for a user on an object identity

Throws:

UnknownAceException - if there can be no permission found to update

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

PermissionNotSuitableException - if the permission is not suitable for the type of object

UnknownEntityException - if the combination of Type and Identifier of the object identity does not corresponds to an entity

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

deletePermission

void deletePermission(org.springframework.security.acls.model.Sid sid,
                      org.springframework.security.acls.model.ObjectIdentity objectIdentity)

Deletes a existing permission for a user on an object identity

Throws:

UnknownAceException - if there can be no permission found to delete

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

UnknownEntityException - if the combination of Type and Identifier of the object identity does not corresponds to an entity

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

addType

void addType(String typeId)

Add a Type to the database

Throws:

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

deleteType

void deleteType(String typeId)

Removes a Type from the database

Throws:

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

getPermissionsForType

Map<String,Set<LabelledPermission>> getPermissionsForType(String typeId,
                                                                Set<org.springframework.security.acls.model.Sid> sids,
                                                                boolean includeInheritance)

Retrieves the permissions for all objects of a type for one or more users

Throws:

ReadPermissionDeniedException - if the user misses the permissions required to retrieve permissions for this type

SidPermissionException - if the user misses the permissions required to retrieve permissions for

InsufficientInheritancePermissionsException - if the user misses the permissions required to retrieve inheritance information

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

getPermissionsForType

Map<String,Set<LabelledPermission>> getPermissionsForType(String typeId,
                                                                Set<org.springframework.security.acls.model.Sid> sids,
                                                                int page,
                                                                int pageSize)

Retrieves the permissions for all objects of a type for one or more users

Throws:

ReadPermissionDeniedException - if the user misses the permissions required to retrieve permissions for this type

SidPermissionException - if the user misses the permissions required to retrieve permissions for

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

getPermissionsForObject

Set<LabelledPermission> getPermissionsForObject(org.springframework.security.acls.model.ObjectIdentity objectIdentity,
                                                Set<org.springframework.security.acls.model.Sid> sids,
                                                boolean includeInheritance)

Retrieves the permissions for a object for one or more users

Throws:

ReadPermissionDeniedException - if the user misses the permissions required to retrieve permissions for this object

SidPermissionException - if the user misses the permissions required to retrieve permissions for

InsufficientInheritancePermissionsException - if the user misses the permissions required to retrieve inheritance information

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

UnknownEntityException - if the combination of Type and Identifier of the object identity does not corresponds to an entity

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

getPermissions

Set<LabelledPermission> getPermissions(Set<org.springframework.security.acls.model.Sid> sids,
                                       boolean includeInheritance)

Retrieves all permissions for one or more users

Throws:

InsufficientInheritancePermissionsException - if the user misses the permissions required to retrieve inheritance information

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

getLabelledTypes

Set<LabelledType> getLabelledTypes()

Retrieves the types that are available in the system

getObjects

Set<LabelledObject> getObjects(String typeId,
                               int page,
                               int pageSize)

Retrieves the objects of a type in the system

Throws:

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type

getSuitablePermissionsForType

Set<PermissionSet> getSuitablePermissionsForType(String typeId)

Retrieves the permissions that can be granted of objects of a certain type

exists

boolean exists(org.springframework.security.acls.model.ObjectIdentity objectIdentity,
               org.springframework.security.acls.model.Sid sid)

Checks if a there is a permission in the system for the combination of a sid and an objectIdentity

Throws:

ReadPermissionDeniedException - if the user misses the permissions required to retrieve permissions for this object

SidPermissionException - if the user misses the permissions required to retrieve permissions for

UnknownUserException - if no user could be found for a PrincipalSid

UnknownRoleException - if no role could be found for a GrantedAuthoritySid

UnknownEntityException - if the combination of Type and Identifier of the object identity does not corresponds to an entity

UnknownEntityTypeException - if the Type of the object identity does not corresponds to an existing entity type