public class AuthoritativeSetResource extends AbstractAccessibleResource<AuthoritativeSet> implements GetResource, ListResource, DeleteResource, CreateResource, UpdateResource, ParentResource
AbstractAccessibleResource.Handler<E extends Accessible>, AbstractAccessibleResource.NoOpHandler<E extends Accessible>
aclManager, actionManager, AGGREGATION_PARAM, cls, EVENT_TYPE_PARAM, FROM_PARAM, ITEM_ID_PARAM, ITEM_TYPE_PARAM, SHOW_PARAM, TO_PARAM, USER_PARAM
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 and Description |
---|
AuthoritativeSetResource(org.neo4j.graphdb.GraphDatabaseService database) |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
create(Bundle bundle,
List<String> accessors)
Create a resource.
|
javax.ws.rs.core.Response |
createChild(String id,
Bundle bundle,
List<String> accessors)
Create a subordinate resource.
|
void |
delete(String id)
Delete a resource.
|
javax.ws.rs.core.Response |
deleteAllAuthoritativeSetHistoricalAgents(String id) |
javax.ws.rs.core.Response |
exportEag(String id,
String lang)
Export the given set's historical agents as EAC streamed
in a ZIP file.
|
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 |
listChildren(String id,
boolean all)
List available resources subordinate to this item.
|
javax.ws.rs.core.Response |
update(String id,
Bundle bundle)
Update a resource.
|
createItem, createItem, createItem, deleteItem, deleteItem, exportItemsAsZip, getAccessors, getEventsApi, getItem, listItems, updateItem, updateItem
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
public AuthoritativeSetResource(@Context org.neo4j.graphdb.GraphDatabaseService database)
public javax.ws.rs.core.Response get(String id) throws ItemNotFound
GetResource
get
in interface GetResource
id
- The requested item idItemNotFound
public javax.ws.rs.core.Response list()
ListResource
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
list
in interface ListResource
public javax.ws.rs.core.Response listChildren(String id, boolean all) throws ItemNotFound
ParentResource
Example:
curl http://localhost:7474/ehri/[RESOURCE]/[ID]/list
listChildren
in interface ParentResource
ItemNotFound
public javax.ws.rs.core.Response create(Bundle bundle, List<String> accessors) throws PermissionDenied, ValidationError, DeserializationError
CreateResource
create
in interface CreateResource
bundle
- The resource data.accessors
- The users/groups who can initially access this resource.PermissionDenied
ValidationError
DeserializationError
public javax.ws.rs.core.Response update(String id, Bundle bundle) throws PermissionDenied, ValidationError, DeserializationError, ItemNotFound
UpdateResource
update
in interface UpdateResource
id
- The resource ID.bundle
- A resource bundle, with or without an ID.PermissionDenied
ValidationError
DeserializationError
ItemNotFound
public void delete(String id) throws PermissionDenied, ItemNotFound, ValidationError
DeleteResource
delete
in interface DeleteResource
id
- The resource ID.PermissionDenied
ItemNotFound
ValidationError
public javax.ws.rs.core.Response deleteAllAuthoritativeSetHistoricalAgents(String id) throws ItemNotFound, AccessDenied, PermissionDenied
ItemNotFound
AccessDenied
PermissionDenied
public javax.ws.rs.core.Response createChild(String id, Bundle bundle, List<String> accessors) throws PermissionDenied, ValidationError, DeserializationError, ItemNotFound
ParentResource
createChild
in interface ParentResource
id
- The parent resource ID.bundle
- A resource bundle.accessors
- The users/groups who can access this item.PermissionDenied
ValidationError
DeserializationError
ItemNotFound
public javax.ws.rs.core.Response exportEag(String id, String lang) throws IOException, ItemNotFound
id
- the set IDlang
- a three-letter ISO639-2 codeIOException
ItemNotFound
Copyright © 2018 The European Holocaust Research Infrastructure (EHRI). All rights reserved.