eu.ehri.extension

Class GenericResource

java.lang.Object

eu.ehri.extension.base.AbstractResource

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

eu.ehri.extension.GenericResource

All Implemented Interfaces:

TxCheckedResource

public class GenericResource
extends AbstractAccessibleResource<Accessible>

Provides a means of fetching items and lists of items regardless of their specific type.

Nested Class Summary

Nested classes/interfaces inherited from class eu.ehri.extension.base.AbstractAccessibleResource

AbstractAccessibleResource.Handler<E extends Accessible>, AbstractAccessibleResource.NoOpHandler<E extends Accessible>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT

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

aclManager, actionManager, AGGREGATION_PARAM, cls, EVENT_TYPE_PARAM, FROM_PARAM, ITEM_ID_PARAM, ITEM_TYPE_PARAM, SHOW_PARAM, TO_PARAM, 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
GenericResource(org.neo4j.graphdb.GraphDatabaseService database)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addDemotion(String id) Down vote an item
javax.ws.rs.core.Response	addPromotion(String id) Up vote an item.
javax.ws.rs.core.Response	annotations(String id) Return a (paged) list of annotations for the given item.
javax.ws.rs.core.Response	createAccessPoint(String id, String did, Bundle bundle) Create an access point on the given description, for the given parent item.
javax.ws.rs.core.Response	createDescription(String id, Bundle bundle) Create a new description for this item.
void	deleteAccessPoint(String id, String did, String apid) Delete the access point with the given ID, on the given description, belonging to the given parent item.
void	deleteDescription(String id, String did) Delete a description with the given ID, belonging to the given parent item.
javax.ws.rs.core.Response	events(String id, EventsApi.Aggregation aggregation) Lookup and page the history for a given item.
Document	exportDc(String id, String langCode)
javax.ws.rs.core.Response	get(String id) Fetch an item of any type by ID.
javax.ws.rs.core.Response	links(String id) Returns a list of items linked to the given description.
javax.ws.rs.core.Response	list(List<String> ids, List<Long> gids) Fetch a list of items by their ID.
javax.ws.rs.core.Response	listFromJson(String json) Fetch a list of items by their ID.
javax.ws.rs.core.Response	listVersions(String id) Lookup and page the versions for a given item.
javax.ws.rs.core.Response	permissionGrants(String id) List all the permission grants that relate specifically to this item.
javax.ws.rs.core.Response	permissionGrantsAsScope(String id) List all the permission grants that relate specifically to this scope.
javax.ws.rs.core.Response	removeDemotion(String id) Remove a down vote.
javax.ws.rs.core.Response	removePromotion(String id) Remove an up vote.
javax.ws.rs.core.Response	setVisibility(String id, List<String> accessorIds) Set the accessors who are able to view an item.
javax.ws.rs.core.Response	updateDescription(String id, Bundle bundle) Update a description belonging to the given item.
javax.ws.rs.core.Response	updateDescriptionWithId(String id, String did, Bundle bundle) Update a description with the given ID, belonging to the given parent item.
javax.ws.rs.core.Response	visibility(String id) Get the accessors who are able to view an item.

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

createItem, createItem, createItem, deleteItem, deleteItem, exportItemsAsZip, getAccessors, getEventsApi, getItem, listItems, updateItem, updateItem

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

ENDPOINT

public static final String ENDPOINT

See Also:

Constant Field Values

Constructor Detail

GenericResource

public GenericResource(@Context
                       org.neo4j.graphdb.GraphDatabaseService database)

Method Detail

list

public javax.ws.rs.core.Response list(List<String> ids,
                                      List<Long> gids)

Fetch a list of items by their ID. Note: if both global IDs and graph IDs (GIDs) are given as query parameters, GIDs will be returned at the head of the response list.

Parameters:

ids - a list of string IDs

gids - a list of graph number IDs

Returns:

A serialized list of items, with nulls for items that are not found or inaccessible.

listFromJson

public javax.ws.rs.core.Response listFromJson(String json)
                                       throws ItemNotFound,
                                              PermissionDenied,
                                              DeserializationError,
                                              IOException

Fetch a list of items by their ID. Note: if both global IDs and graph IDs (GIDs) are given as query parameters, GIDs will be returned at the head of the response list.

Parameters:

json - a JSON-encoded list of IDs, which can consist of either strings or (if a number) graph (long) ids.

Returns:

A serialized list of items, with nulls for items that are not found or inaccessible.

Throws:

ItemNotFound

PermissionDenied

DeserializationError

IOException

get

public javax.ws.rs.core.Response get(String id)
                              throws ItemNotFound,
                                     AccessDenied

Fetch an item of any type by ID.

Parameters:

id - the item's ID

Returns:

A serialized representation.

Throws:

ItemNotFound

AccessDenied

visibility

public javax.ws.rs.core.Response visibility(String id)
                                     throws PermissionDenied,
                                            ItemNotFound,
                                            SerializationError

Get the accessors who are able to view an item.

Parameters:

id - the ID of the item

Returns:

a list of accessor frames

Throws:

PermissionDenied

ItemNotFound

SerializationError

setVisibility

public javax.ws.rs.core.Response setVisibility(String id,
                                               List<String> accessorIds)
                                        throws PermissionDenied,
                                               ItemNotFound,
                                               SerializationError

Set the accessors who are able to view an item. If no accessors are set, the item is globally readable.

Parameters:

id - the ID of the item

accessorIds - the IDs of the users who can access this item.

Returns:

the updated object

Throws:

PermissionDenied

ItemNotFound

SerializationError

addPromotion

public javax.ws.rs.core.Response addPromotion(String id)
                                       throws PermissionDenied,
                                              ItemNotFound

Up vote an item.

Parameters:

id - the ID of the item to promote.

Returns:

200 response

Throws:

PermissionDenied

ItemNotFound

removePromotion

public javax.ws.rs.core.Response removePromotion(String id)
                                          throws PermissionDenied,
                                                 ItemNotFound,
                                                 ValidationError

Remove an up vote.

Parameters:

id - the ID of the item to remove

Returns:

200 response

Throws:

PermissionDenied

ItemNotFound

ValidationError

addDemotion

public javax.ws.rs.core.Response addDemotion(String id)
                                      throws PermissionDenied,
                                             ItemNotFound

Down vote an item

Parameters:

id - the ID of the item to promote.

Returns:

200 response

Throws:

PermissionDenied

ItemNotFound

removeDemotion

public javax.ws.rs.core.Response removeDemotion(String id)
                                         throws PermissionDenied,
                                                ItemNotFound,
                                                ValidationError

Remove a down vote.

Parameters:

id - the ID of the item to remove

Returns:

200 response

Throws:

PermissionDenied

ItemNotFound

ValidationError

events

public javax.ws.rs.core.Response events(String id,
                                        EventsApi.Aggregation aggregation)
                                 throws ItemNotFound,
                                        AccessDenied

Lookup and page the history for a given item.

Parameters:

id - the event id

aggregation - the aggregation strategy

Returns:

A list of events

Throws:

ItemNotFound

AccessDenied

annotations

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

Return a (paged) list of annotations for the given item.

Parameters:

id - the item ID

Returns:

a list of annotations on the item

Throws:

ItemNotFound

links

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

Returns a list of items linked to the given description.

Parameters:

id - the item ID

Returns:

a list of links with the item as a target

Throws:

ItemNotFound

permissionGrants

public javax.ws.rs.core.Response permissionGrants(String id)
                                           throws PermissionDenied,
                                                  ItemNotFound

List all the permission grants that relate specifically to this item.

Returns:

a list of grants for this item

Throws:

PermissionDenied

ItemNotFound

permissionGrantsAsScope

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

List all the permission grants that relate specifically to this scope.

Returns:

a list of grants for which this item is the scope

Throws:

ItemNotFound

createDescription

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

Create a new description for this item.

Parameters:

id - the item ID

bundle - the description bundle

Returns:

the new description

Throws:

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

updateDescription

public javax.ws.rs.core.Response updateDescription(String id,
                                                   Bundle bundle)
                                            throws PermissionDenied,
                                                   ValidationError,
                                                   DeserializationError,
                                                   ItemNotFound,
                                                   SerializationError

Update a description belonging to the given item.

Parameters:

id - the item ID

bundle - the description bundle

Returns:

the new description

Throws:

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

SerializationError

updateDescriptionWithId

public javax.ws.rs.core.Response updateDescriptionWithId(String id,
                                                         String did,
                                                         Bundle bundle)
                                                  throws AccessDenied,
                                                         PermissionDenied,
                                                         ValidationError,
                                                         DeserializationError,
                                                         ItemNotFound,
                                                         SerializationError

Update a description with the given ID, belonging to the given parent item.

Parameters:

id - the item ID

did - the description ID

bundle - the description bundle

Returns:

the new description

Throws:

AccessDenied

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

SerializationError

deleteDescription

public void deleteDescription(String id,
                              String did)
                       throws PermissionDenied,
                              ItemNotFound,
                              ValidationError,
                              SerializationError

Delete a description with the given ID, belonging to the given parent item.

Parameters:

id - the item ID

did - the description ID

Throws:

PermissionDenied

ItemNotFound

ValidationError

SerializationError

createAccessPoint

public javax.ws.rs.core.Response createAccessPoint(String id,
                                                   String did,
                                                   Bundle bundle)
                                            throws PermissionDenied,
                                                   ValidationError,
                                                   DeserializationError,
                                                   ItemNotFound

Create an access point on the given description, for the given parent item.

Parameters:

id - the parent item's ID

did - the description's ID

bundle - the access point data

Returns:

the new access point

Throws:

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

listVersions

public javax.ws.rs.core.Response listVersions(String id)
                                       throws ItemNotFound,
                                              AccessDenied

Lookup and page the versions for a given item.

Parameters:

id - the event id

Returns:

a list of versions

Throws:

ItemNotFound

AccessDenied

deleteAccessPoint

public void deleteAccessPoint(String id,
                              String did,
                              String apid)
                       throws AccessDenied,
                              PermissionDenied,
                              ValidationError,
                              DeserializationError,
                              ItemNotFound

Delete the access point with the given ID, on the given description, belonging to the given parent item.

Parameters:

id - the parent item's ID

did - the description's ID

apid - the access point's ID

Throws:

AccessDenied

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

exportDc

public Document exportDc(String id,
                         String langCode)
                  throws AccessDenied,
                         ItemNotFound,
                         IOException

Throws:

AccessDenied

ItemNotFound

IOException