com.atlassian.confluence.api.service.permissions

Interface ContentRestrictionService

All Known Implementing Classes:

ContentRestrictionServiceImpl

@ExperimentalApi
public interface ContentRestrictionService

Since:

5.7

Method Summary

Methods

Modifier and Type	Method and Description
ContentRestriction	getRestrictionsForOperation(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... expansions) Retrieves all restrictions for given operation key on given content.
Map<OperationKey,ContentRestriction>	getRestrictionsGroupByOperation(ContentId target, Expansion... expansions) List all restrictions that exist directly on the given content.

Method Detail

getRestrictionsGroupByOperation

Map<OperationKey,ContentRestriction> getRestrictionsGroupByOperation(ContentId target,
                                                                   Expansion... expansions)
                                                                     throws NotFoundException

List all restrictions that exist directly on the given content. Note that the subjects returned in each ContentRestriction are hard-limited to an arbitrary maximum size. Obtaining more can be done via the getRestrictionsForOperation(com.atlassian.confluence.api.model.content.id.ContentId, com.atlassian.confluence.api.model.permissions.OperationKey, com.atlassian.confluence.api.model.pagination.PageRequest, com.atlassian.confluence.api.model.Expansion...) method.

Parameters:

target - the id of the content to look up permissions for

expansions - the expansions to apply to the returned data. These expansions start from the operation itself.

Returns:

a Map of all ContentRestrictions, grouped by operation key

Throws:

NotFoundException - if given content id does not exist, or is not viewable by user

Since:

5.7

getRestrictionsForOperation

ContentRestriction getRestrictionsForOperation(ContentId target,
                                             OperationKey operationKey,
                                             PageRequest pageRequest,
                                             Expansion... expansions)
                                               throws NotFoundException

Retrieves all restrictions for given operation key on given content.

Parameters:

target - the id of the content to look up permissions for

operationKey - the operation key to look up restrictions for

pageRequest - pagination through the subjects contained within the ContentRestriction

expansions - the expansions to the ContentRestriction.

Returns:

ContentRestriction containing relevant restrictions for given operation key, or null if operation key does not have corresponding restrictions.

Throws:

NotFoundException - if given content id does not exist, or is not viewable by user, or if the given operation key is not recognised for the content.

Since:

5.7