| Package | Description | 
|---|---|
| eu.ehri.extension.base | |
| eu.ehri.project.acl | 
 Classes pertaining directly to the
 access-control and permission system. 
 | 
| eu.ehri.project.acl.wrapper | |
| eu.ehri.project.api | 
 Classes that provide data access data on the graph in a
 manner that incorporate the permission and access-control
 systems. 
 | 
| eu.ehri.project.api.impl | |
| eu.ehri.project.commands | 
 Classes that represent actions that can
 be run via the  
CmdEntryPoint
 to manage the graph, e.g. | 
| eu.ehri.project.importers.links | |
| eu.ehri.project.models | 
 The interfaces in this package specify the classes of entities that map to graph
 frame classes. 
 | 
| eu.ehri.project.models.base | 
 The interfaces in this package specify the required and allowable properties of 
 classes of entities, so that entities can be validated. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Accessor | 
AbstractResource.getRequesterUserProfile()
Retrieve the account of the current user, who may be
 anonymous. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Set<Accessor> | 
AbstractAccessibleResource.getAccessors(List<String> accessorIds,
            Accessor current)
Get a set of accessor frames given a list of names. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Set<Accessor> | 
AbstractAccessibleResource.getAccessors(List<String> accessorIds,
            Accessor current)
Get a set of accessor frames given a list of names. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AnonymousAccessor
Implementation of an anonymous user singleton. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Accessor | 
AnonymousAccessor.getInstance()
Obtain the shared instance of the Anonymous Accessor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Iterable<Accessor> | 
AnonymousAccessor.getAllParents()  | 
Iterable<Accessor> | 
AnonymousAccessor.getParents()  | 
| Modifier and Type | Method and Description | 
|---|---|
static boolean | 
AclManager.belongsToAdmin(Accessor accessor)
Check if an accessor is admin or a member of Admin. 
 | 
boolean | 
AclManager.canAccess(Accessible entity,
         Accessor accessor)
Determine if a user can access an entity. 
 | 
void | 
PermissionUtils.checkContentPermission(Accessor accessor,
                      ContentTypes contentType,
                      PermissionType permissionType)
Check permissions for a given type. 
 | 
void | 
PermissionUtils.checkEntityPermission(Accessible entity,
                     Accessor accessor,
                     PermissionType permissionType)
Check permissions for a given entity. 
 | 
void | 
PermissionUtils.checkReadAccess(Accessible entity,
               Accessor accessor)
Ensure an item is readable by the given accessor 
 | 
static com.tinkerpop.pipes.PipeFunction<com.tinkerpop.blueprints.Vertex,Boolean> | 
AclManager.getAclFilterFunction(Accessor accessor)
Build a gremlin filter function that passes through items readable by a
 given accessor. 
 | 
GlobalPermissionSet | 
AclManager.getGlobalPermissions(Accessor accessor)
Recursive helper function to ascend an accessor's groups and populate
 their global permissions. 
 | 
InheritedGlobalPermissionSet | 
AclManager.getInheritedGlobalPermissions(Accessor accessor)
Return a permission list for the given accessor and her inherited groups. 
 | 
InheritedItemPermissionSet | 
AclManager.getInheritedItemPermissions(Accessible entity,
                           Accessor accessor)
Get a list of permissions for a given accessor on a given entity, including
 inherited permissions. 
 | 
PermissionGrant | 
AclManager.grantPermission(PermissionGrantTarget target,
               PermissionType permType,
               Accessor accessor)
Grant a user permissions to a content type. 
 | 
boolean | 
AclManager.hasPermission(Accessible entity,
             PermissionType permissionType,
             Accessor accessor)
Check if a user has permission to perform an action on the given item. 
 | 
boolean | 
AclManager.hasPermission(ContentTypes contentType,
             PermissionType permissionType,
             Accessor accessor)
Check if a user has permission to perform an action on the given content type. 
 | 
static boolean | 
AclManager.isAnonymous(Accessor accessor)
Check if an accessor is admin or a member of Admin. 
 | 
void | 
AclManager.removeAccessControl(Accessible entity,
                   Accessor accessor)
Revoke an accessor's access to an entity. 
 | 
void | 
AclManager.revokePermission(Accessible entity,
                PermissionType permType,
                Accessor accessor)
Revoke a particular permission on the given entity. 
 | 
void | 
AclManager.setItemPermissions(Accessible item,
                  Accessor accessor,
                  Set<PermissionType> permissionSet)
Set the permissions for a particular user on the given item. 
 | 
void | 
AclManager.setPermissionMatrix(Accessor accessor,
                   GlobalPermissionSet globals)
Set a matrix of global permissions for a given accessor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
AclManager.setAccessors(Accessible entity,
            Collection<Accessor> accessors)
Set access control on an entity to several accessors. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Accessor | 
AclGraph.getAccessor()  | 
| Constructor and Description | 
|---|
AclGraph(T graph,
        Accessor accessor)  | 
| Modifier and Type | Method and Description | 
|---|---|
Accessor | 
Api.accessor()  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
Api.Acl.addAccessorToGroup(Group group,
                  Accessor userOrGroup)
Add a user to a group. 
 | 
static Api | 
ApiFactory.noLogging(com.tinkerpop.frames.FramedGraph<?> graph,
         Accessor accessor)  | 
void | 
Api.Acl.removeAccessorFromGroup(Group group,
                       Accessor userOrGroup)
Remove a user from a group. 
 | 
InheritedGlobalPermissionSet | 
Api.Acl.setGlobalPermissionMatrix(Accessor userOrGroup,
                         GlobalPermissionSet permissionSet)
Set the global permission matrix for a user. 
 | 
InheritedItemPermissionSet | 
Api.Acl.setItemPermissions(Accessible item,
                  Accessor accessor,
                  Set<PermissionType> permissionList)
Set permissions for the given user on the given item. 
 | 
Api | 
Api.withAccessor(Accessor accessor)  | 
static Api | 
ApiFactory.withLogging(com.tinkerpop.frames.FramedGraph<?> graph,
           Accessor accessor)  | 
| Modifier and Type | Method and Description | 
|---|---|
Link | 
Api.createAccessPointLink(String targetId1,
                     String targetId2,
                     String descriptionId,
                     String bodyName,
                     AccessPointType bodyType,
                     Bundle bundle,
                     Collection<Accessor> accessibleTo,
                     Optional<String> logMessage)
Create a link between two items, along with an access point on the given description. 
 | 
Annotation | 
Api.createAnnotation(String id,
                String did,
                Bundle bundle,
                Collection<Accessor> accessibleTo,
                Optional<String> logMessage)
Create an annotation for a dependent node of an item. 
 | 
Link | 
Api.createLink(String targetId1,
          String targetId2,
          List<String> bodies,
          Bundle bundle,
          Collection<Accessor> accessibleTo,
          Optional<String> logMessage)
Create a link between two items. 
 | 
void | 
Api.Acl.setAccessors(Accessible entity,
            Set<Accessor> accessors)  | 
| Modifier and Type | Method and Description | 
|---|---|
Accessor | 
ApiImpl.accessor()  | 
| Modifier and Type | Method and Description | 
|---|---|
Api | 
ApiImpl.withAccessor(Accessor accessor)  | 
| Modifier and Type | Method and Description | 
|---|---|
Link | 
ApiImpl.createAccessPointLink(String targetId1,
                     String targetId2,
                     String descriptionId,
                     String bodyName,
                     AccessPointType bodyType,
                     Bundle bundle,
                     Collection<Accessor> accessibleTo,
                     Optional<String> logMessage)  | 
Annotation | 
ApiImpl.createAnnotation(String id,
                String did,
                Bundle bundle,
                Collection<Accessor> accessibleTo,
                Optional<String> logMessage)  | 
Link | 
ApiImpl.createLink(String targetId1,
          String targetId2,
          List<String> bodies,
          Bundle bundle,
          Collection<Accessor> accessibleTo,
          Optional<String> logMessage)  | 
| Constructor and Description | 
|---|
ApiImpl(com.tinkerpop.frames.FramedGraph<?> graph,
       Accessor accessor,
       PermissionScope scope,
       boolean logging)  | 
Builder(com.tinkerpop.frames.FramedGraph<?> graph,
       Accessor accessor)  | 
Builder(com.tinkerpop.frames.FramedGraph<?> graph,
       Accessor accessor)  | 
EventsApiImpl(com.tinkerpop.frames.FramedGraph<?> graph,
             Accessor accessor)  | 
QueryApiImpl(com.tinkerpop.frames.FramedGraph<?> graph,
            Accessor accessor)
Simple constructor. 
 | 
QueryApiImpl(com.tinkerpop.frames.FramedGraph<?> graph,
            Accessor accessor,
            int offset,
            int limit,
            SortedMap<String,QueryApi.Sort> sort,
            com.tinkerpop.pipes.util.structures.Pair<String,QueryApi.Sort> defSort,
            SortedMap<String,com.tinkerpop.pipes.util.structures.Pair<QueryApi.FilterPredicate,Object>> filters,
            boolean stream)
Full Constructor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Api | 
BaseCommand.api(com.tinkerpop.frames.FramedGraph<?> graph,
   Accessor accessor)  | 
| Constructor and Description | 
|---|
LinkResolver(com.tinkerpop.frames.FramedGraph<?> graph,
            Accessor accessor)  | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
Group
Frame class representing a group of users or other groups
 that can be assigned permissions. 
 | 
interface  | 
UserProfile
A frame class representing a user within the database. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
static class  | 
Group.Impl
Implementation of complex methods. 
 | 
static class  | 
UserProfile.Impl  | 
| Modifier and Type | Method and Description | 
|---|---|
Accessor | 
VirtualUnit.getAuthor()
Fetch the author of this virtual unit. 
 | 
Accessor | 
PermissionGrant.getGrantee()  | 
Accessor | 
PermissionGrant.getSubject()  | 
| Modifier and Type | Method and Description | 
|---|---|
Iterable<Accessor> | 
Group.getMembers()
Get members of this group. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
Group.addMember(Accessor accessor)
Adds a Accessor as a member to this Group, so it has the permissions of the Group. 
 | 
void | 
Group.Impl.addMember(Accessor accessor)  | 
void | 
Group.removeMember(Accessor accessor)
Removes a member from this group. 
 | 
void | 
Group.Impl.removeMember(Accessor accessor)  | 
void | 
VirtualUnit.setAuthor(Accessor accessor)
Set the author of this virtual unit. 
 | 
void | 
VirtualUnit.Impl.setAuthor(Accessor accessor)  | 
void | 
Link.setLinker(Accessor accessor)  | 
| Modifier and Type | Class and Description | 
|---|---|
static class  | 
Accessor.Impl  | 
| Modifier and Type | Method and Description | 
|---|---|
Iterable<Accessor> | 
Accessible.getAccessors()
Fetch accessors to which this item is restricted. 
 | 
Iterable<Accessor> | 
Accessor.getAllParents()  | 
Iterable<Accessor> | 
Accessor.Impl.getAllParents()  | 
Iterable<Accessor> | 
Accessor.getParents()  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
Accessible.addAccessor(Accessor accessor)
only Accessor accessor can access this Accessible item. 
 | 
void | 
Accessible.Impl.addAccessor(Accessor accessor)  | 
void | 
Accessible.removeAccessor(Accessor accessor)
Remove an accessor from having access to this item. 
 | 
Copyright © 2018 The European Holocaust Research Infrastructure (EHRI). All rights reserved.