eu.ehri.extension.base

Class AbstractAccessibleResource<E extends Accessible>

java.lang.Object

eu.ehri.extension.base.AbstractResource

eu.ehri.extension.base.AbstractAccessibleResource<E>

Type Parameters:

E - the specific Accessible derived class

All Implemented Interfaces:

TxCheckedResource

Direct Known Subclasses:

AnnotationResource, AuthoritativeSetResource, ContentTypeResource, CountryResource, CvocConceptResource, DocumentaryUnitResource, GenericResource, GraphQLResource, GroupResource, HistoricalAgentResource, LinkResource, RepositoryResource, SystemEventResource, UserProfileResource, VersionResource, VirtualUnitResource, VocabularyResource

public class AbstractAccessibleResource<E extends Accessible>
extends AbstractResource

Handle CRUD operations on Accessible's by using the eu.ehri.project.views.Views class generic code. Resources for specific entities can extend this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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.

Field Summary

Fields

Modifier and Type	Field and Description
protected AclManager	aclManager
protected ActionManager	actionManager
static String	AGGREGATION_PARAM
protected Class<E>	cls
static String	EVENT_TYPE_PARAM
static String	FROM_PARAM
static String	ITEM_ID_PARAM
static String	ITEM_TYPE_PARAM
static String	SHOW_PARAM
static String	TO_PARAM
static String	USER_PARAM

Fields inherited from class eu.ehri.extension.base.AbstractResource

ACCESSOR_PARAM, ALL_PARAM, AUTH_HEADER_NAME, COMMIT_PARAM, CSV_MEDIA_TYPE, DEFAULT_LIST_LIMIT, FILTER_PARAM, graph, GROUP_PARAM, ID_PARAM, INCLUDE_PROPS_PARAM, ITEM_CACHE_TIME, jsonFactory, jsonMapper, LIMIT_PARAM, LOG_MESSAGE_HEADER_NAME, LOG_PARAM, logger, manager, N3_MIMETYPE, OFFSET_PARAM, PATCH_HEADER_NAME, RANGE_HEADER_NAME, RDF_MIMETYPE_FORMATS, RDF_XML_MIMETYPE, request, requestHeaders, RESOURCE_ENDPOINT_PREFIX, SCOPE_PARAM, SORT_PARAM, STREAM_HEADER_NAME, TOLERANT_PARAM, TURTLE_MIMETYPE, uriInfo, VERSION_PARAM

Constructor Summary

Constructors

Constructor and Description
AbstractAccessibleResource(org.neo4j.graphdb.GraphDatabaseService database, Class<E> cls) Constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createItem(Bundle entityBundle, List<String> accessorIds)
javax.ws.rs.core.Response	createItem(Bundle entityBundle, List<String> accessorIds, AbstractAccessibleResource.Handler<E> handler) Create an instance of the 'entity' in the database
<T extends Accessible> javax.ws.rs.core.Response	createItem(Bundle entityBundle, List<String> accessorIds, AbstractAccessibleResource.Handler<T> handler, Api scopedApi, Class<T> otherCls) Create an instance of the 'entity' in the database
protected void	deleteItem(String id) Delete (remove) an instance of the 'entity' in the database
protected void	deleteItem(String id, AbstractAccessibleResource.Handler<E> preProcess) Delete (remove) an instance of the 'entity' in the database, running a handler callback beforehand.
protected <T extends Entity> javax.ws.rs.core.Response	exportItemsAsZip(XmlExporter<T> exporter, Iterable<T> items, String lang)
protected Set<Accessor>	getAccessors(List<String> accessorIds, Accessor current) Get a set of accessor frames given a list of names.
protected EventsApi	getEventsApi() Get an event query builder object.
javax.ws.rs.core.Response	getItem(String id) Retieve (get) an instance of the 'entity' in the database
javax.ws.rs.core.Response	listItems() List all instances of the 'entity' accessible to the given user.
javax.ws.rs.core.Response	updateItem(Bundle entityBundle) Update (change) an instance of the 'entity' in the database.
javax.ws.rs.core.Response	updateItem(String id, Bundle rawBundle) Update (change) an instance of the 'entity' in the database

Methods inherited from class eu.ehri.extension.base.AbstractResource

anonymousApi, api, beginTx, creationResponse, getCacheControl, getCurrentActioner, getCurrentUser, getGraph, getIntQueryParam, getItemUri, getLogMessage, getQuery, getRdfFormat, getRequesterUserProfile, getSerializer, getStringListQueryParam, isPatch, isStreaming, single, streamingList, streamingList, streamingListOfLists, streamingPage, streamingPage, streamingVertexList, streamingVertexList

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_TYPE_PARAM

public static final String ITEM_TYPE_PARAM

See Also:

Constant Field Values

ITEM_ID_PARAM

public static final String ITEM_ID_PARAM

See Also:

Constant Field Values

EVENT_TYPE_PARAM

public static final String EVENT_TYPE_PARAM

See Also:

Constant Field Values

USER_PARAM

public static final String USER_PARAM

See Also:

Constant Field Values

FROM_PARAM

public static final String FROM_PARAM

See Also:

Constant Field Values

TO_PARAM

public static final String TO_PARAM

See Also:

Constant Field Values

SHOW_PARAM

public static final String SHOW_PARAM

See Also:

Constant Field Values

AGGREGATION_PARAM

public static final String AGGREGATION_PARAM

See Also:

Constant Field Values

aclManager

protected final AclManager aclManager

actionManager

protected final ActionManager actionManager

cls

protected final Class<E extends Accessible> cls

Constructor Detail

AbstractAccessibleResource

public AbstractAccessibleResource(@Context
                                  org.neo4j.graphdb.GraphDatabaseService database,
                                  Class<E> cls)

Constructor

Parameters:

database - the injected neo4j database

cls - the entity Java class

Method Detail

listItems

public javax.ws.rs.core.Response listItems()

List all instances of the 'entity' accessible to the given user.

Returns:

a list of entities

createItem

public <T extends Accessible> javax.ws.rs.core.Response createItem(Bundle entityBundle,
                                                                   List<String> accessorIds,
                                                                   AbstractAccessibleResource.Handler<T> handler,
                                                                   Api scopedApi,
                                                                   Class<T> otherCls)
                                                            throws PermissionDenied,
                                                                   ValidationError,
                                                                   DeserializationError

Create an instance of the 'entity' in the database

Type Parameters:

T - the generic type of class T

Parameters:

entityBundle - a bundle of item data 'id' fields)

accessorIds - a list of accessors who can initially view this item

handler - a callback function that allows additional operations to be run on the created object after it is initialised but before the response is generated. This is useful for adding relationships to the new item.

scopedApi - the Api instance to use to create the item. This allows callers to override the scope used.

otherCls - the class of the created item.

Returns:

the response of the create request, the 'location' will contain the url of the newly created instance.

Throws:

PermissionDenied

ValidationError

DeserializationError

createItem

public javax.ws.rs.core.Response createItem(Bundle entityBundle,
                                            List<String> accessorIds,
                                            AbstractAccessibleResource.Handler<E> handler)
                                     throws PermissionDenied,
                                            ValidationError,
                                            DeserializationError

Create an instance of the 'entity' in the database

Parameters:

entityBundle - a bundle of item data 'id' fields)

accessorIds - a list of accessors who can initially view this item

handler - a callback function that allows additional operations to be run on the created object after it is initialised but before the response is generated. This is useful for adding relationships to the new item.

Returns:

the response of the create request, the 'location' will contain the url of the newly created instance.

Throws:

PermissionDenied

ValidationError

DeserializationError

createItem

public javax.ws.rs.core.Response createItem(Bundle entityBundle,
                                            List<String> accessorIds)
                                     throws PermissionDenied,
                                            ValidationError,
                                            DeserializationError

Throws:

PermissionDenied

ValidationError

DeserializationError

getItem

public javax.ws.rs.core.Response getItem(String id)
                                  throws ItemNotFound

Retieve (get) an instance of the 'entity' in the database

Parameters:

id - the Entities identifier string

Returns:

the response of the request, which contains the json representation

Throws:

ItemNotFound

updateItem

public javax.ws.rs.core.Response updateItem(Bundle entityBundle)
                                     throws PermissionDenied,
                                            ValidationError,
                                            ItemNotFound,
                                            DeserializationError

Update (change) an instance of the 'entity' in the database.

Parameters:

entityBundle - the bundle

Returns:

the response of the update request

Throws:

PermissionDenied

ValidationError

ItemNotFound

DeserializationError

updateItem

public javax.ws.rs.core.Response updateItem(String id,
                                            Bundle rawBundle)
                                     throws PermissionDenied,
                                            ValidationError,
                                            DeserializationError,
                                            ItemNotFound

Update (change) an instance of the 'entity' in the database

If the Patch header is true top-level bundle data will be merged instead of overwritten.

Parameters:

id - the item's ID

rawBundle - the bundle

Returns:

the response of the update request

Throws:

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

deleteItem

protected void deleteItem(String id,
                          AbstractAccessibleResource.Handler<E> preProcess)
                   throws PermissionDenied,
                          ItemNotFound,
                          ValidationError

Delete (remove) an instance of the 'entity' in the database, running a handler callback beforehand.

Parameters:

id - the item's ID

preProcess - a handler to run before deleting the item

Throws:

PermissionDenied

ItemNotFound

ValidationError

deleteItem

protected void deleteItem(String id)
                   throws PermissionDenied,
                          ItemNotFound,
                          ValidationError

Delete (remove) an instance of the 'entity' in the database

Parameters:

id - the item's ID

Throws:

PermissionDenied

ItemNotFound

ValidationError

exportItemsAsZip

protected <T extends Entity> javax.ws.rs.core.Response exportItemsAsZip(XmlExporter<T> exporter,
                                                                        Iterable<T> items,
                                                                        String lang)
                                                                 throws IOException

Throws:

IOException

getEventsApi

protected EventsApi getEventsApi()

Get an event query builder object.

Returns:

a new event query builder

getAccessors

protected Set<Accessor> getAccessors(List<String> accessorIds,
                                     Accessor current)

Get a set of accessor frames given a list of names.

Parameters:

accessorIds - a list of accessor IDs

current - the current accessor

Returns:

a set a accessors