BasePermissionManagement (Communote 3.5 API)

java.lang.Object
- com.communote.server.api.core.security.permission.BasePermissionManagement<T,N,E>

Type Parameters:

T - Type of the entity, this service works for.

N - Type of the according creation entity, this service works for.

E - The type of the exception to be thrown when the current user does not have a required permission.

All Implemented Interfaces:

PermissionManagement<T,N,E>

Direct Known Subclasses:

NotePermissionManagementImpl, TopicPermissionManagementImpl
```
public abstract class BasePermissionManagement<T,N,E extends AuthorizationException>
extends Object
implements PermissionManagement<T,N,E>
```
Service for providing permissions for a given entity.

Author:

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

Constructor Summary

Constructors
Constructor and Description

BasePermissionManagement()

Constructors
Constructor and Description
`BasePermissionManagement()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPermissionFilter(PermissionFilter<T,N> filter)` Adds a filter to the internal list of filters.
`protected abstract E`	`createPermissonViolationException(T entity, Permission<T> permission)` Create an exception that should be thrown when the current user does not have a required permission
`protected abstract T`	`getEntity(Long entityId)` Returns the entity for the given id.
`protected List<PermissionFilter<T,N>>`	`getFilters()`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BasePermissionManagement
```
public BasePermissionManagement()
```
- Method Detail
  - addPermissionFilter
```
public void addPermissionFilter(PermissionFilter<T,N> filter)
```
    Description copied from interface: PermissionManagement
    
    Adds a filter to the internal list of filters.
    
    Specified by:
    
    addPermissionFilter in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    Parameters:
    
    filter - The filter to add.
  - createPermissonViolationException
```
protected abstract E createPermissonViolationException(T entity,
                                                       Permission<T> permission)
```
    Create an exception that should be thrown when the current user does not have a required permission
    
    Parameters:
    
    entity - the entity for which a permission was required, never null
    
    permission - the permission the current user does not have
    
    Returns:
    
    the exception
  - getEntity
```
protected abstract T getEntity(Long entityId)
```
    Returns the entity for the given id.
    
    Parameters:
    
    entityId - ID of the entity
    
    Returns:
    
    The entity or null, if the entity does not exist
  - getFilters
```
protected List<PermissionFilter<T,N>> getFilters()
```
    Returns:
    
    The registered filters.
  - getPermissions
```
@Transactional(readOnly=true)
public Set<Permission<T>> getPermissions(Long entityId)
```
    Description copied from interface: PermissionManagement
    
    Returns a collection of permissions for the given entity.
    
    Specified by:
    
    getPermissions in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    Parameters:
    
    entityId - ID of the entity
    
    Returns:
    
    Collection of permissions for the given entity.
  - getPermissions
```
public Set<Permission<T>> getPermissions(T entity)
```
    Description copied from interface: PermissionManagement
    
    Returns a collection of permissions for the given entity.
    
    Specified by:
    
    getPermissions in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    Parameters:
    
    entity - The entity.
    
    Returns:
    
    Collection of permissions for the given entity.
  - getPermissionsForCreation
```
public Set<Permission<T>> getPermissionsForCreation(N entity)
```
    Description copied from interface: PermissionManagement
    
    Returns a collection of permissions for creation for the given entity.
    
    Specified by:
    
    getPermissionsForCreation in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    Parameters:
    
    entity - The entity, can be TO or null to check in general
    
    Returns:
    
    Collection of permissions for the given entity.
  - hasAndGetWithPermission
```
@Transactional(readOnly=true)
public <R> R hasAndGetWithPermission(long entityId,
                                                                   Permission<T> permission,
                                                                   Converter<T,R> converter)
                                                            throws E extends AuthorizationException,
                                                                   NotFoundException
```
    Description copied from interface: PermissionManagement
    
    Checks the permission and returns the given entity converted with the provided converter if the current user has the requested permission.
    
    Specified by:
    
    hasAndGetWithPermission in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    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
```
@Transactional(readOnly=true)
public boolean hasPermission(long entityId,
                                                           Permission<T> permission)
```
    Description copied from interface: PermissionManagement
    
    Checks if the current user has the permission of the given entity.
    
    Specified by:
    
    hasPermission in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    Parameters:
    
    entityId - ID of the entity
    
    permission - The permission to check.
    
    Returns:
    
    True, if the user has the permission on the entity.
  - hasPermission
```
@Transactional(readOnly=true)
public boolean hasPermission(long entityId,
                                                           String permissionIdentifier)
```
    Description copied from interface: PermissionManagement
    
    Checks if the current user has the permission of the given entity.
    
    Specified by:
    
    hasPermission in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    Parameters:
    
    entityId - ID of the entity
    
    permissionIdentifier - The permission to check.
    
    Returns:
    
    True, if the user has the permission on the entity.
  - hasPermissionForCreation
```
public boolean hasPermissionForCreation(Permission<T> permission)
```
    Description copied from interface: PermissionManagement
    
    Checks if the current user has the permission to to create entities of the associated type
    
    Specified by:
    
    hasPermissionForCreation in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    Parameters:
    
    permission - The permission to check.
    
    Returns:
    
    True, if the user has the permission for creating entities
  - removePermissionFilter
```
public void removePermissionFilter(PermissionFilter<T,N> filter)
```
    Description copied from interface: PermissionManagement
    
    Removes a filter from the internal list of filters.
    
    Specified by:
    
    removePermissionFilter in interface PermissionManagement<T,N,E extends AuthorizationException>
    
    Parameters:
    
    filter - The filter to remove.

Class BasePermissionManagement<T,N,E extends AuthorizationException>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasePermissionManagement

Method Detail

addPermissionFilter

createPermissonViolationException

getEntity

getFilters

getPermissions

getPermissions

getPermissionsForCreation

hasAndGetWithPermission

hasPermission

hasPermission

hasPermissionForCreation

removePermissionFilter