eu.ehri.extension

Class GroupResource

java.lang.Object

eu.ehri.extension.base.AbstractResource

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

eu.ehri.extension.GroupResource

All Implemented Interfaces:

DeleteResource, GetResource, ListResource, TxCheckedResource, UpdateResource

public class GroupResource
extends AbstractAccessibleResource<Group>
implements GetResource, ListResource, UpdateResource, DeleteResource

Provides a web service interface for the Group model.

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

Method Summary

Modifier and Type	Method and Description
void	addMember(String id, String aid) Add an accessor to a group.
javax.ws.rs.core.Response	aggregateUserActions(String userId, EventsApi.Aggregation aggregation) Fetch an aggregate list of a user's actions.
javax.ws.rs.core.Response	createGroup(Bundle bundle, List<String> accessors, List<String> members)
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	listChildren(String id, boolean all) list members of the specified group; UserProfiles and sub-Groups (direct descendants)
void	removeMember(String id, String aid) Remove an accessor from a group.
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

MEMBER_PARAM

public static final String MEMBER_PARAM

See Also:

Constant Field Values

Constructor Detail

GroupResource

public GroupResource(@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

createGroup

public javax.ws.rs.core.Response createGroup(Bundle bundle,
                                             List<String> accessors,
                                             List<String> members)
                                      throws PermissionDenied,
                                             ValidationError,
                                             DeserializationError,
                                             ItemNotFound

Throws:

PermissionDenied

ValidationError

DeserializationError

ItemNotFound

update

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

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

ValidationError

DeserializationError

ItemNotFound

addMember

public void addMember(String id,
                      String aid)
               throws PermissionDenied,
                      ItemNotFound

Add an accessor to a group.

Throws:

PermissionDenied

ItemNotFound

removeMember

public void removeMember(String id,
                         String aid)
                  throws PermissionDenied,
                         ItemNotFound

Remove an accessor from a group.

Throws:

PermissionDenied

ItemNotFound

listChildren

public javax.ws.rs.core.Response listChildren(String id,
                                              boolean all)
                                       throws ItemNotFound

list members of the specified group; UserProfiles and sub-Groups (direct descendants)

Throws:

ItemNotFound

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

aggregateUserActions

public javax.ws.rs.core.Response aggregateUserActions(String userId,
                                                      EventsApi.Aggregation aggregation)
                                               throws ItemNotFound

Fetch an aggregate list of a user's actions.

Parameters:

userId - the user's ID

aggregation - the manner in which to aggregate the results, accepting "user", "strict" or "off" (no aggregation). Default is strict.

Returns:

a list of event ranges

Throws:

ItemNotFound