eu.ehri.extension

Class AnnotationResource

java.lang.Object

eu.ehri.extension.base.AbstractResource

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

eu.ehri.extension.AnnotationResource

All Implemented Interfaces:

DeleteResource, GetResource, ListResource, TxCheckedResource, UpdateResource

public class AnnotationResource
extends AbstractAccessibleResource<Annotation>
implements GetResource, ListResource, UpdateResource, DeleteResource

Web service interface for creating annotations.

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	BODY_PARAM
static String	TARGET_PARAM

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
AnnotationResource(org.neo4j.graphdb.GraphDatabaseService database)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createAnnotation(String id, String did, List<String> accessors, Bundle bundle) Create an annotation for a particular item.
void	delete(String id) Delete a resource.
javax.ws.rs.core.Response	get(String id) Fetch a resource by id.
javax.ws.rs.core.Response	list() List available resources.
javax.ws.rs.core.Response	update(String id, Bundle bundle) Update a resource.

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

TARGET_PARAM

public static final String TARGET_PARAM

See Also:

Constant Field Values

BODY_PARAM

public static final String BODY_PARAM

See Also:

Constant Field Values

Constructor Detail

AnnotationResource

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

Method Detail

get

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

Description copied from interface: GetResource

Fetch a resource by id.

Specified by:

get in interface GetResource

Parameters:

id - The requested item id

Returns:

A serialized item representation

Throws:

ItemNotFound

list

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

Description copied from interface: ListResource

List available resources. The default behaviour is to return a page of 20 items.

The default list limit can be overridden using the limit parameter, and disabled completely using a value of -1.

Item lists are paginated using the page parameter.

The page, limit, and total number of items is returned in the Content-Range response header in the form:

page=1; count=20; total=50

If the header X-Stream is set to true no count of total items will be performed. This is more efficient when returning large numbers of items or when limiting is disabled completely. Example:

      
 curl http://localhost:7474/ehri/[RESOURCE]/list?page=5&limit=10
      
 

Specified by:

list in interface ListResource

Returns:

A list of serialized item representations

createAnnotation

public javax.ws.rs.core.Response createAnnotation(String id,
                                                  String did,
                                                  List<String> accessors,
                                                  Bundle bundle)
                                           throws PermissionDenied,
                                                  AccessDenied,
                                                  ValidationError,
                                                  DeserializationError,
                                                  ItemNotFound,
                                                  SerializationError

Create an annotation for a particular item.

Parameters:

id - the ID of the item being annotation

did - the (optional) ID of the sub-item target, e.g. a description

bundle - the JSON representation of the annotation

accessors - user IDs who can access the annotation

Returns:

the annotation

Throws:

PermissionDenied

AccessDenied

ValidationError

DeserializationError

ItemNotFound

SerializationError

update

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

Description copied from interface: UpdateResource

Update a resource.

Specified by:

update in interface UpdateResource

Parameters:

id - The resource ID.

bundle - A resource bundle, with or without an ID.

Returns:

A serialized representation of the updated resource.

Throws:

PermissionDenied

ItemNotFound

ValidationError

DeserializationError

delete

public void delete(String id)
            throws PermissionDenied,
                   ItemNotFound,
                   ValidationError

Description copied from interface: DeleteResource

Delete a resource.

Specified by:

delete in interface DeleteResource

Parameters:

id - The resource ID.

Throws:

PermissionDenied

ItemNotFound

ValidationError