com.communote.server.api.core.security.permission

Interface PermissionManagement<T,N,E extends AuthorizationException>

All Known Subinterfaces:

NotePermissionManagement, TopicPermissionManagement

All Known Implementing Classes:

BasePermissionManagement, NotePermissionManagementImpl, TopicPermissionManagementImpl

public interface PermissionManagement<T,N,E extends AuthorizationException>

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
void	addPermissionFilter(PermissionFilter<T,N> filter) Adds a filter to the internal list of filters.
Set<Permission<T>>	getPermissions(Long entityId) Returns a collection of permissions for the given entity.
Set<Permission<T>>	getPermissions(T entity) Returns a collection of permissions for the given entity.
Set<Permission<T>>	getPermissionsForCreation(N entity) Returns a collection of permissions for creation for the given entity.
<R> R	hasAndGetWithPermission(long entityId, Permission<T> permission, Converter<T,R> converter) Checks the permission and returns the given entity converted with the provided converter if the current user has the requested permission.
boolean	hasPermission(long entityId, Permission<T> permission) Checks if the current user has the permission of the given entity.
boolean	hasPermission(long entityId, String permissionIdentifier) Checks if the current user has the permission of the given entity.
boolean	hasPermissionForCreation(Permission<T> permission) Checks if the current user has the permission to to create entities of the associated type
void	removePermissionFilter(PermissionFilter<T,N> filter) Removes a filter from the internal list of filters.

Method Detail

addPermissionFilter

void addPermissionFilter(PermissionFilter<T,N> filter)

Adds a filter to the internal list of filters.

Parameters:

filter - The filter to add.

getPermissions

Set<Permission<T>> getPermissions(Long entityId)

Returns a collection of permissions for the given entity.

Parameters:

entityId - ID of the entity

Returns:

Collection of permissions for the given entity.

getPermissions

Set<Permission<T>> getPermissions(T entity)

Returns a collection of permissions for the given entity.

Parameters:

entity - The entity.

Returns:

Collection of permissions for the given entity.

getPermissionsForCreation

Set<Permission<T>> getPermissionsForCreation(N entity)

Returns a collection of permissions for creation for the given entity.

Parameters:

entity - The entity, can be TO or null to check in general

Returns:

Collection of permissions for the given entity.

hasAndGetWithPermission

<R> R hasAndGetWithPermission(long entityId,
                              Permission<T> permission,
                              Converter<T,R> converter)
                       throws E extends AuthorizationException,
                              NotFoundException

Checks the permission and returns the given entity converted with the provided converter if the current user has the requested permission.

Type Parameters:

R - the target type of the conversion

Parameters:

entityId - ID of the entity

permission - The permission the user must have.

converter - the converter to convert the result

Returns:

The entity.

Throws:

E - in case the current user doesn't have the given permission.

NotFoundException - in case the entity does not exist

E extends AuthorizationException

hasPermission

boolean hasPermission(long entityId,
                      Permission<T> permission)

Checks if the current user has the permission of the given entity.

Parameters:

entityId - ID of the entity

permission - The permission to check.

Returns:

True, if the user has the permission on the entity.

hasPermission

boolean hasPermission(long entityId,
                      String permissionIdentifier)

Checks if the current user has the permission of the given entity.

Parameters:

entityId - ID of the entity

permissionIdentifier - The permission to check.

Returns:

True, if the user has the permission on the entity.

hasPermissionForCreation

boolean hasPermissionForCreation(Permission<T> permission)

Checks if the current user has the permission to to create entities of the associated type

Parameters:

permission - The permission to check.

Returns:

True, if the user has the permission for creating entities

removePermissionFilter

void removePermissionFilter(PermissionFilter<T,N> filter)

Removes a filter from the internal list of filters.

Parameters:

filter - The filter to remove.