Package | Description |
---|---|
eu.ehri.extension.base | |
eu.ehri.project.acl |
Classes pertaining directly to the
access-control and permission system.
|
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.importers |
Handlers and Importers and supporting classes to import files into
the database.
|
eu.ehri.project.importers.base | |
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.
|
eu.ehri.project.models.cvoc | |
eu.ehri.project.models.events | |
eu.ehri.project.persistence |
Classes dealing with persistence of
relational item data in sub-tree format.
|
eu.ehri.project.tools |
Modifier and Type | Class and Description |
---|---|
class |
AbstractAccessibleResource<E extends Accessible>
Handle CRUD operations on Accessible's by using the
eu.ehri.project.views.Views class generic code.
|
static interface |
AbstractAccessibleResource.Handler<E extends Accessible>
Functor used to post-process items.
|
static class |
AbstractAccessibleResource.NoOpHandler<E extends Accessible>
Implementation of a Handler that does nothing.
|
Modifier and Type | Method and Description |
---|---|
<T extends Accessible> |
AbstractAccessibleResource.createItem(Bundle entityBundle,
List<String> accessorIds,
AbstractAccessibleResource.Handler<T> handler,
Api scopedApi,
Class<T> otherCls)
Create an instance of the 'entity' in the database
|
Modifier and Type | Method and Description |
---|---|
Iterable<Accessible> |
SystemScope.getAllContainedItems() |
Iterable<Accessible> |
SystemScope.getContainedItems() |
Modifier and Type | Method and Description |
---|---|
boolean |
AclManager.canAccess(Accessible entity,
Accessor accessor)
Determine if a user can access an entity.
|
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
|
InheritedItemPermissionSet |
AclManager.getInheritedItemPermissions(Accessible entity,
Accessor accessor)
Get a list of permissions for a given accessor on a given entity, including
inherited permissions.
|
boolean |
AclManager.hasPermission(Accessible entity,
PermissionType permissionType,
Accessor accessor)
Check if a user has permission to perform an action on the given item.
|
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.setAccessors(Accessible entity,
Collection<Accessor> accessors)
Set access control on an entity to several accessors.
|
void |
AclManager.setItemPermissions(Accessible item,
Accessor accessor,
Set<PermissionType> permissionSet)
Set the permissions for a particular user on the given item.
|
Modifier and Type | Method and Description |
---|---|
<E extends Accessible> |
Api.create(Bundle bundle,
Class<E> cls)
Create a new object of type `E` from the given data, within the scope of
`scope`.
|
<E extends Accessible> |
Api.create(Bundle bundle,
Class<E> cls,
Optional<String> logMessage)
Create a new object of type `E` from the given data, saving an Action log
with the given log message.
|
<T extends Accessible> |
Api.createDependent(String parentId,
Bundle data,
Class<T> cls,
Optional<String> logMessage)
Create a dependent item, belonging to the given parent.
|
<E extends Accessible> |
Api.createOrUpdate(Bundle bundle,
Class<E> cls)
Create or update a new object of type `E` from the given data, within the
scope of `scope`.
|
<E extends Accessible> |
Api.createOrUpdate(Bundle bundle,
Class<E> cls,
Optional<String> logMessage)
Create or update a new object of type `E` from the given data, within the
scope of `scope`.
|
<E extends Accessible> |
Api.detail(String id,
Class<E> cls)
Fetch an item, as a user.
|
<E extends Accessible> |
Api.update(Bundle bundle,
Class<E> cls)
Update an object bundle, also updating dependent items.
|
<E extends Accessible> |
Api.update(Bundle bundle,
Class<E> cls,
Optional<String> logMessage)
Create or update a new object of type `E` from the given data, saving an
Action log with the given log message.
|
<T extends Accessible> |
Api.updateDependent(String parentId,
Bundle data,
Class<T> cls,
Optional<String> logMessage)
Update a dependent item, belonging to the given parent.
|
Modifier and Type | Method and Description |
---|---|
Iterable<List<SystemEvent>> |
EventsApi.aggregateForItem(Accessible item) |
Iterable<SystemEvent> |
EventsApi.listForItem(Accessible item) |
void |
Api.Acl.setAccessors(Accessible entity,
Set<Accessor> accessors) |
InheritedItemPermissionSet |
Api.Acl.setItemPermissions(Accessible item,
Accessor accessor,
Set<PermissionType> permissionList)
Set permissions for the given user on the given item.
|
Modifier and Type | Method and Description |
---|---|
<E extends Accessible> |
ApiImpl.create(Bundle bundle,
Class<E> cls) |
<E extends Accessible> |
ApiImpl.create(Bundle bundle,
Class<E> cls,
Optional<String> logMessage) |
<T extends Accessible> |
ApiImpl.createDependent(String parentId,
Bundle data,
Class<T> cls,
Optional<String> logMessage) |
<E extends Accessible> |
ApiImpl.createOrUpdate(Bundle bundle,
Class<E> cls) |
<E extends Accessible> |
ApiImpl.createOrUpdate(Bundle bundle,
Class<E> cls,
Optional<String> logMessage) |
<E extends Accessible> |
ApiImpl.detail(String id,
Class<E> cls) |
<E extends Accessible> |
ApiImpl.update(Bundle bundle,
Class<E> cls) |
<E extends Accessible> |
ApiImpl.update(Bundle bundle,
Class<E> cls,
Optional<String> logMessage) |
<T extends Accessible> |
ApiImpl.updateDependent(String parentId,
Bundle data,
Class<T> cls,
Optional<String> logMessage) |
Modifier and Type | Method and Description |
---|---|
Iterable<List<SystemEvent>> |
EventsApiImpl.aggregateForItem(Accessible item)
Aggregate an item's events.
|
Iterable<SystemEvent> |
EventsApiImpl.listForItem(Accessible item)
List an item's events.
|
Modifier and Type | Method and Description |
---|---|
void |
ImportCallback.itemImported(Mutation<? extends Accessible> mutation) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractImporter<I,T extends Accessible> |
interface |
ItemImporter<I,T extends Accessible>
Interface for importers that import documentary units, historical agents and virtual collections,
with their constituent logical data, description(s), and date periods.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractImporter.handleCallbacks(Mutation<? extends Accessible> mutation)
Call all registered ImportCallbacks for the given mutation.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AccessPoint
Holds the information on a relationship specified in some Description,
but without the target-end of the relationship being determined.
|
interface |
Annotation
A frame class representing an annotation.
|
interface |
ContentType
Frame class representing a type of content in the
graph.
|
interface |
Country
Frame class representing a country.
|
interface |
DocumentaryUnit
A frame class for graph nodes representing documentary
unit items.
|
interface |
DocumentaryUnitDescription
Frame class representing the description of a document.
|
interface |
Group
Frame class representing a group of users or other groups
that can be assigned permissions.
|
interface |
HistoricalAgent
A frame class representing a historical agent item.
|
interface |
HistoricalAgentDescription
Frame class representing the description of a historical
agent.
|
interface |
Link
Links two items together with a given body, with may either be
a text property or some other entity.
|
interface |
MaintenanceEvent
Frame class representing a pre-ingest event that took place
upon some documentary unit item.
|
interface |
Permission
Frame class representing a type of permission.
|
interface |
Repository
A frame class for graph nodes representing repository
items.
|
interface |
RepositoryDescription
Frame class representing the description of a repository.
|
interface |
UnknownProperty
Holds information about the collection or institute,
but we don't specify (in the database) what it exactly means.
|
interface |
UserProfile
A frame class representing a user within the database.
|
interface |
VirtualUnit
Virtual documentary unit.
|
Modifier and Type | Class and Description |
---|---|
static class |
Country.Impl
Implementation of complex methods.
|
static class |
DocumentaryUnit.Impl
Implementation of complex methods.
|
static class |
Group.Impl
Implementation of complex methods.
|
static class |
Repository.Impl
Implementation of complex methods.
|
static class |
UserProfile.Impl |
static class |
VirtualUnit.Impl
Implementation of complex methods.
|
Modifier and Type | Method and Description |
---|---|
Iterable<Accessible> |
Group.getAllUserProfileMembers()
Get all members of this group, including members of
groups within this group.
|
Iterable<Accessible> |
Group.Impl.getAllUserProfileMembers() |
Iterable<Accessible> |
Link.getLinkBodies() |
Iterable<Accessible> |
Group.getMembersAsEntities()
TODO FIXME use this in case we need AccesibleEnity's instead of Accessors,
|
Modifier and Type | Method and Description |
---|---|
void |
Link.addLinkBody(Accessible entity) |
Modifier and Type | Interface and Description |
---|---|
interface |
AbstractUnit
An abstract entity representing either a documentary (physical) unit
or a virtual unit.
|
interface |
Described
An entity that can have descriptions.
|
interface |
Description
An entity that describes another entity.
|
interface |
Linkable
An entity that can hold incoming links.
|
interface |
Promotable
An entity that can be promoted and demoted.
|
interface |
Versioned
An entity that may have prior versions.
|
interface |
Watchable
An entity that can be watched by users.
|
Modifier and Type | Class and Description |
---|---|
static class |
Accessible.Impl
Implementation of complex methods.
|
static class |
Entity.Impl |
static class |
Promotable.Impl
Implementation of complex methods.
|
static class |
Versioned.Impl |
static class |
Watchable.Impl |
Modifier and Type | Method and Description |
---|---|
Iterable<Accessible> |
PermissionScope.getAllContainedItems()
Get an iterable of all items within this scope, recursively down
to all lower levels.
|
Iterable<Accessible> |
PermissionScope.Impl.getAllContainedItems() |
Iterable<Accessible> |
PermissionScope.getContainedItems()
Get an iterable of all items immediately within this scope.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AuthoritativeItem
An item that belongs in some authoritative set.
|
interface |
AuthoritativeSet
A frame class representing a item that holds other
authoritative items, such as concepts and
historical agents.
|
interface |
Concept
This models the thesaurus terms or keywords in a way that is better managing multi-linguality.
|
interface |
ConceptDescription
Description for a SKOS concept.
|
interface |
Vocabulary
A collection of 'related' concepts, or maybe a bit like the SKOS Concept Scheme
Note that any concept in this Vocabulary that has no parent might be considered a topConcept.
|
Modifier and Type | Class and Description |
---|---|
static class |
AuthoritativeSet.Impl
Implementation of complex methods.
|
static class |
Concept.Impl
Implementation of complex methods.
|
Modifier and Type | Interface and Description |
---|---|
interface |
SystemEvent
Frame class representing an event that happened in the
graph.
|
interface |
Version
Frame class representing a serialized version of
some other node.
|
Modifier and Type | Class and Description |
---|---|
static class |
SystemEvent.Impl
Implementation of complex methods.
|
static class |
Version.Impl
Implementation of complex methods.
|
Modifier and Type | Method and Description |
---|---|
Accessible |
Version.getEntity()
Loops up through the chain of versions until the latest and fetches
the item to which the events refer.
|
Accessible |
Version.Impl.getEntity() |
Accessible |
SystemEvent.getFirstSubject()
Fetch the first subject of this event.
|
Accessible |
SystemEvent.Impl.getFirstSubject() |
Modifier and Type | Method and Description |
---|---|
Iterable<Accessible> |
SystemEvent.getSubjects()
Fetch the subject items to whom this event pertains.
|
Iterable<Accessible> |
SystemEvent.Impl.getSubjects() |
Modifier and Type | Method and Description |
---|---|
Set<Accessible> |
ActionManager.EventContext.getSubjects()
Return the subjects of this event.
|
Modifier and Type | Method and Description |
---|---|
ActionManager.EventContext |
ActionManager.EventContext.addSubjects(Accessible... entities)
Add subjects to an event.
|
ActionManager.EventContext |
ActionManager.newEventContext(Accessible subject,
Actioner user,
EventTypes type)
Create an action for the given subject, user, and type.
|
ActionManager.EventContext |
ActionManager.newEventContext(Accessible subject,
Actioner user,
EventTypes type,
Optional<String> logMessage)
Create an action node that describes what user U has done with subject S
via logMessage log.
|
Modifier and Type | Method and Description |
---|---|
Optional<List<String>> |
IdRegenerator.reGenerateId(Accessible item) |
Modifier and Type | Method and Description |
---|---|
List<List<String>> |
IdRegenerator.reGenerateIds(Iterable<? extends Accessible> items) |
Copyright © 2018 The European Holocaust Research Infrastructure (EHRI). All rights reserved.