eu.ehri.extension

Class AdminResource

java.lang.Object

eu.ehri.extension.base.AbstractResource

eu.ehri.extension.AdminResource

All Implemented Interfaces:

TxCheckedResource

public class AdminResource
extends AbstractResource

Provides additional Admin methods needed by client systems and general graph-maintenance functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_USER_ID_FORMAT
static String	DEFAULT_USER_ID_PREFIX
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, 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
AdminResource(org.neo4j.graphdb.GraphDatabaseService database)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createDefaultUserProfile(String jsonData, List<String> groups) Create a new user with a default name and identifier.
javax.ws.rs.core.Response	exportNodes()
javax.ws.rs.core.Response	getGraphSON() Export the DB as a stream of JSON in GraphSON format.

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

DEFAULT_USER_ID_PREFIX

public static final String DEFAULT_USER_ID_PREFIX

See Also:

Constant Field Values

DEFAULT_USER_ID_FORMAT

public static final String DEFAULT_USER_ID_FORMAT

See Also:

Constant Field Values

Constructor Detail

AdminResource

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

Method Detail

getGraphSON

public javax.ws.rs.core.Response getGraphSON()
                                      throws Exception

Export the DB as a stream of JSON in GraphSON format.

The mode used is EXTENDED.

Throws:

Exception

exportNodes

public javax.ws.rs.core.Response exportNodes()
                                      throws Exception

Throws:

Exception

createDefaultUserProfile

public javax.ws.rs.core.Response createDefaultUserProfile(String jsonData,
                                                          List<String> groups)
                                                   throws Exception

Create a new user with a default name and identifier.

Parameters:

jsonData - Additional key/value data for the created object

groups - IDs for groups to which the user should belong

Returns:

A new user

Throws:

Exception