eu.ehri.project.acl

Class PermissionUtils

java.lang.Object

eu.ehri.project.acl.PermissionUtils

public final class PermissionUtils
extends Object

Messy stopgap class to hold a bunch of sort-of view/sort-of acl functions.

Constructor Summary

Constructors

Constructor and Description
PermissionUtils(com.tinkerpop.frames.FramedGraph<?> graph)
PermissionUtils(com.tinkerpop.frames.FramedGraph<?> graph, PermissionScope scope)

Method Summary

Modifier and Type	Method and Description
void	checkContentPermission(Accessor accessor, ContentTypes contentType, PermissionType permissionType) Check permissions for a given type.
void	checkEntityPermission(Accessible entity, Accessor accessor, PermissionType permissionType) Check permissions for a given entity.
void	checkReadAccess(Accessible entity, Accessor accessor) Ensure an item is readable by the given accessor
ContentTypes	getContentTypeEnum(Class<?> cls) Get the content type enum value with the given id.
ContentType	getContentTypeNode(EntityClass entityClass) Get the content type node with the given id.
PermissionUtils	setScope(PermissionScope scope) Set the scope under which ACL and permission operations will take place.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionUtils

public PermissionUtils(com.tinkerpop.frames.FramedGraph<?> graph)

PermissionUtils

public PermissionUtils(com.tinkerpop.frames.FramedGraph<?> graph,
                       PermissionScope scope)

Method Detail

checkContentPermission

public void checkContentPermission(Accessor accessor,
                                   ContentTypes contentType,
                                   PermissionType permissionType)
                            throws PermissionDenied

Check permissions for a given type.

Parameters:

accessor - The user/group

contentType - The content type

permissionType - The permission type

Throws:

PermissionDenied

checkEntityPermission

public void checkEntityPermission(Accessible entity,
                                  Accessor accessor,
                                  PermissionType permissionType)
                           throws PermissionDenied

Check permissions for a given entity.

Parameters:

entity - The item

accessor - The user/group

permissionType - The permission type

Throws:

PermissionDenied

checkReadAccess

public void checkReadAccess(Accessible entity,
                            Accessor accessor)
                     throws AccessDenied

Ensure an item is readable by the given accessor

Parameters:

entity - The item

accessor - The accessor/group

Throws:

AccessDenied

getContentTypeNode

public ContentType getContentTypeNode(EntityClass entityClass)

Get the content type node with the given id.

Parameters:

entityClass - The entity class

Returns:

A vertex framed as a content entityClass

getContentTypeEnum

public ContentTypes getContentTypeEnum(Class<?> cls)

Get the content type enum value with the given id.

Parameters:

cls - The frame class

Returns:

A vertex framed as a content type

setScope

public PermissionUtils setScope(PermissionScope scope)

Set the scope under which ACL and permission operations will take place. This is, for example, an Repository instance, where the objects being manipulated are DocumentaryUnits. The given scope is used to compare against the scope relation on PermissionGrants.

Parameters:

scope - The new scope

Returns:

A new view helper