eu.ehri.extension

Class PermissionsResource

java.lang.Object

eu.ehri.extension.base.AbstractResource

eu.ehri.extension.PermissionsResource

All Implemented Interfaces:

TxCheckedResource

public class PermissionsResource
extends AbstractResource

Web service resource for setting and reading permissions.

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

Method Summary

Modifier and Type	Method and Description
static javax.ws.rs.core.CacheControl	getCacheControl() Get the cache control that should be applied to permission data.
InheritedItemPermissionSet	getEntityMatrix(String userId, String id) Get the permission matrix for a given user on the given entity.
InheritedGlobalPermissionSet	getGlobalMatrix() Get the global permission matrix for the user making the request, based on the Authorization header.
InheritedGlobalPermissionSet	getGlobalMatrix(String userId) Get the global permission matrix for the given accessor.
InheritedGlobalPermissionSet	getScopedMatrix(String userId, String id) Get the user's permissions for a given scope.
javax.ws.rs.core.Response	listPermissionGrants(String id) Get a list of permission grants for the given user
InheritedGlobalPermissionSet	setGlobalMatrix(String userId, GlobalPermissionSet globals) Set a user's global permission matrix.
InheritedItemPermissionSet	setItemPermissions(String userId, String id, ItemPermissionSet itemPerms) Set a user's permissions on a given item.
InheritedGlobalPermissionSet	setScopedPermissions(String userId, String id, GlobalPermissionSet globals) Set a user's permissions on a content type with a given scope.

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

PermissionsResource

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

Method Detail

getCacheControl

public static javax.ws.rs.core.CacheControl getCacheControl()

Get the cache control that should be applied to permission data.

Returns:

A cache control object

getGlobalMatrix

public InheritedGlobalPermissionSet getGlobalMatrix()
                                             throws PermissionDenied,
                                                    ItemNotFound

Get the global permission matrix for the user making the request, based on the Authorization header.

Returns:

The current user's global permissions

Throws:

PermissionDenied

ItemNotFound

getGlobalMatrix

public InheritedGlobalPermissionSet getGlobalMatrix(String userId)
                                             throws PermissionDenied,
                                                    ItemNotFound

Get the global permission matrix for the given accessor.

Parameters:

userId - The user ID

Returns:

The user's global permissions

Throws:

PermissionDenied

ItemNotFound

setGlobalMatrix

public InheritedGlobalPermissionSet setGlobalMatrix(String userId,
                                                    GlobalPermissionSet globals)
                                             throws PermissionDenied,
                                                    ItemNotFound

Set a user's global permission matrix.

Parameters:

userId - The user ID

globals - The permission matrix data

Returns:

The new permissions

Throws:

PermissionDenied

ItemNotFound

getEntityMatrix

public InheritedItemPermissionSet getEntityMatrix(String userId,
                                                  String id)
                                           throws PermissionDenied,
                                                  ItemNotFound

Get the permission matrix for a given user on the given entity.

Parameters:

userId - The user's ID

id - The item id

Returns:

The user's permissions for that item

Throws:

PermissionDenied

ItemNotFound

setItemPermissions

public InheritedItemPermissionSet setItemPermissions(String userId,
                                                     String id,
                                                     ItemPermissionSet itemPerms)
                                              throws PermissionDenied,
                                                     ItemNotFound

Set a user's permissions on a given item.

Parameters:

id - the item id

userId - the user id

itemPerms - the serialized permission list

Throws:

PermissionDenied

ItemNotFound

getScopedMatrix

public InheritedGlobalPermissionSet getScopedMatrix(String userId,
                                                    String id)
                                             throws PermissionDenied,
                                                    ItemNotFound

Get the user's permissions for a given scope.

Parameters:

userId - The user's permissions

id - The scope ID

Returns:

The matrix for the given scope

Throws:

PermissionDenied

ItemNotFound

setScopedPermissions

public InheritedGlobalPermissionSet setScopedPermissions(String userId,
                                                         String id,
                                                         GlobalPermissionSet globals)
                                                  throws PermissionDenied,
                                                         ItemNotFound

Set a user's permissions on a content type with a given scope.

Parameters:

userId - the user

id - the scope id

globals - the serialized permission list

Returns:

The new permission matrix

Throws:

PermissionDenied

ItemNotFound

listPermissionGrants

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

Get a list of permission grants for the given user

Parameters:

id - the user's id

Returns:

a list of permission grants for the user

Throws:

ItemNotFound