eu.ehri.extension

Class BatchResource

java.lang.Object

eu.ehri.extension.base.AbstractResource

eu.ehri.extension.BatchResource

All Implemented Interfaces:

TxCheckedResource

public class BatchResource
extends AbstractResource

Resource class for import endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT

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

Method Summary

Modifier and Type	Method and Description
String	batchDelete(String scope, Boolean version, String log, boolean commit, Table ids) Delete a batch of objects via JSON containing their IDs.
ImportLog	batchUpdate(String scope, Boolean tolerant, Boolean version, String log, boolean commit, InputStream inputStream) Update a batch of items via JSON containing (partial) data bundles.

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

BatchResource

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

Method Detail

batchUpdate

public ImportLog batchUpdate(String scope,
                             Boolean tolerant,
                             Boolean version,
                             String log,
                             boolean commit,
                             InputStream inputStream)
                      throws IOException,
                             ItemNotFound,
                             ValidationError,
                             DeserializationError

Update a batch of items via JSON containing (partial) data bundles.

Parameters:

scope - the ID of there item's permission scope

tolerant - whether to allow individual validation failures

version - whether to create a version prior to delete

log - an optional log message

inputStream - a JSON document containing partial bundles containing the needed data transformations

Returns:

an import log describing the changes committed

Throws:

IOException

ItemNotFound

ValidationError

DeserializationError

batchDelete

public String batchDelete(String scope,
                          Boolean version,
                          String log,
                          boolean commit,
                          Table ids)
                   throws IOException,
                          DeserializationError

Delete a batch of objects via JSON containing their IDs.

Parameters:

scope - the ID of there item's permission scope

version - whether to create a version prior to delete

log - an optional log message.

Returns:

the number of items deleted

Throws:

IOException

DeserializationError