com.atlassian.confluence.core

Interface ContentPermissionManager

All Known Subinterfaces:

ContentPermissionManagerInternal

All Known Implementing Classes:

DefaultContentPermissionManager

public interface ContentPermissionManager

Method Summary

Modifier and Type	Method and Description
void	addContentPermission(ContentPermission permission, ContentEntityObject content) Add permissions to the content entity objecct through the manager.
void	copyContentPermissions(AbstractPage from, AbstractPage to) Deprecated. since 5.10.1 use copyContentPermissions(ContentEntityObject, ContentEntityObject)
void	copyContentPermissions(ContentEntityObject from, ContentEntityObject to) Copies all content permissions from one content entity to another.
List<ContentPermissionSet>	getContentPermissionSets(ContentEntityObject ceo, String type) Get the ContentPermissionSets that affect this ceo, both inherited and directly.
List<ContentPermission>	getInheritedContentPermissions(ContentEntityObject contentEntityObject) Deprecated. Since 2.6 use getInheritedContentPermissionSets(ContentEntityObject)
List<ContentPermissionSet>	getInheritedContentPermissionSets(ContentEntityObject contentEntityObject)
List<ContentPermissionSet>	getInheritedContentPermissionSets(ContentEntityObject contentEntityObject, boolean includeEditPermissions) Get the inherited ContentPermissionSets that affect this ceo.
List<ContentPermission>	getInheritedContentUserPermissions(ContentEntityObject contentEntityObject)
Map<Long,Boolean>	getPermissionSets(com.atlassian.user.User user, Space space) Retrieves the configured permissions regarding whether the specified user can view the pages inside a space.
List<Page>	getPermittedChildren(Page page, com.atlassian.user.User user) Returns a list of Page objects that are direct children of the passed in page.
List<Page>	getPermittedChildrenIgnoreInheritedPermissions(Page page, com.atlassian.user.User user) Gets the list of child pages under the given page that are visible to the given user.
Set<ContentPermission>	getViewContentPermissions(Page page) Deprecated. since 5.8. use getContentPermissionSets(ContentEntityObject, String) passing permission type ContentPermission.VIEW_PERMISSION
boolean	hasContentLevelPermission(com.atlassian.user.User user, String permissionType, ContentEntityObject content) fetches the inherited and explicit content level permissions for this content object and determines whether the user has access.
boolean	hasPermittedChildrenIgnoreInheritedPermissions(Page page, com.atlassian.user.User remoteUser) Does the given page have children visible to the given user.
boolean	isPermissionInherited(Page childPage) Does the child page get its permissions from any ancestor?
void	removeAllGroupPermissions(String groupName) Remove all content permission associated with a given group.
void	removeAllUserPermissions(ConfluenceUser user) Remove all content permission associated with a given user.
void	removeAllUserPermissions(String username) Deprecated. since 5.3. Use removeAllUserPermissions(com.atlassian.confluence.user.ConfluenceUser) instead.
void	removeContentPermission(ContentPermission permission)
void	setContentPermissions(Collection<ContentPermission> contentPermissions, ContentEntityObject content, String type) Set the Content Permissions on the CEO to be the list of ContentPermissions passed.
void	setContentPermissions(Map<String,Collection<ContentPermission>> requiredPermissionsMap, ContentEntityObject content) Set the Content Permissions on the CEO to be the list of ContentPermissions passed.

Method Detail

addContentPermission

void addContentPermission(ContentPermission permission,
                          ContentEntityObject content)

Add permissions to the content entity objecct through the manager. This will ensure that already existing permissions are updated and that the content will be reindexed.

Parameters:

permission -

content -

setContentPermissions

void setContentPermissions(Collection<ContentPermission> contentPermissions,
                           ContentEntityObject content,
                           String type)

Set the Content Permissions on the CEO to be the list of ContentPermissions passed. Passing an empty list removes all permissions. Passing a list containing just the existing permissions does nothing.

Parameters:

contentPermissions - set of ContentPermissions

content -

type -

setContentPermissions

void setContentPermissions(@Nonnull
                           Map<String,Collection<ContentPermission>> requiredPermissionsMap,
                           ContentEntityObject content)

Set the Content Permissions on the CEO to be the list of ContentPermissions passed. Passing an empty list removes all permissions. Passing a list containing just the existing permissions does nothing. It is recommended to use this method for setting different types of content permissions in a batch, because it performs more smart and performant caching updates than setContentPermissions(java.util.Collection, ContentEntityObject, String) does

Parameters:

requiredPermissionsMap - - map of ContentPermissions for each type

content -

Since:

5.8

removeContentPermission

void removeContentPermission(ContentPermission permission)

removeAllGroupPermissions

void removeAllGroupPermissions(String groupName)

Remove all content permission associated with a given group.

Parameters:

groupName -

removeAllUserPermissions

void removeAllUserPermissions(ConfluenceUser user)

Remove all content permission associated with a given user.

Parameters:

user -

Since:

5.3

removeAllUserPermissions

@Deprecated
void removeAllUserPermissions(String username)

Deprecated. since 5.3. Use removeAllUserPermissions(com.atlassian.confluence.user.ConfluenceUser) instead.

Remove all content permission associated with a given user.

Parameters:

username -

getInheritedContentPermissions

@Deprecated
List<ContentPermission> getInheritedContentPermissions(ContentEntityObject contentEntityObject)

Deprecated. Since 2.6 use getInheritedContentPermissionSets(ContentEntityObject)

Returns all inherited content permission objects attached to the ancestors of this entity object, that is, all view permissions but *not* edit permissions.

getInheritedContentUserPermissions

List<ContentPermission> getInheritedContentUserPermissions(ContentEntityObject contentEntityObject)

getInheritedContentPermissionSets

List<ContentPermissionSet> getInheritedContentPermissionSets(ContentEntityObject contentEntityObject)

Returns:

a list of ContentPermissionSets of type ContentPermission.VIEW_PERMISSION of all ancestors of contentEntityObject

hasContentLevelPermission

boolean hasContentLevelPermission(com.atlassian.user.User user,
                                  String permissionType,
                                  ContentEntityObject content)

fetches the inherited and explicit content level permissions for this content object and determines whether the user has access.

Parameters:

permissionType - ContentPermission.VIEW_PERMISSION or ContentPermission.EDIT_PERMISSION

Returns:

true if the user has the specified type of permission on the given content

getPermittedChildren

List<Page> getPermittedChildren(Page page,
                                com.atlassian.user.User user)

Returns a list of Page objects that are direct children of the passed in page. This method will only return the children the passed in user has permission to view.

hasPermittedChildrenIgnoreInheritedPermissions

boolean hasPermittedChildrenIgnoreInheritedPermissions(Page page,
                                                       com.atlassian.user.User remoteUser)

Does the given page have children visible to the given user. This method assumes that the given page is already visible to the given user and does not check the inherited permissions.

getPermittedChildrenIgnoreInheritedPermissions

List<Page> getPermittedChildrenIgnoreInheritedPermissions(Page page,
                                                          com.atlassian.user.User user)

Gets the list of child pages under the given page that are visible to the given user. This method assumes that the given page is already visible to the given user and does not check the inherited permissions.

Since:

5.10

getViewContentPermissions

@Deprecated
Set<ContentPermission> getViewContentPermissions(Page page)

Deprecated. since 5.8. use getContentPermissionSets(ContentEntityObject, String) passing permission type ContentPermission.VIEW_PERMISSION

Get view permissions on this page and its ancestors.

Parameters:

page -

Returns:

a list of ContentPermission instances

getInheritedContentPermissionSets

List<ContentPermissionSet> getInheritedContentPermissionSets(ContentEntityObject contentEntityObject,
                                                             boolean includeEditPermissions)

Get the inherited ContentPermissionSets that affect this ceo. Note that EDIT Permissions are not currently inherited, however edit permissions are treated as view permissions when considering inheritance, unless the boolean 'includeEditPermissions' is set to false.

Parameters:

contentEntityObject - whose permissions will be returned. Not null.

includeEditPermissions - which specifies whether or not edit permissions should be additionally treated as view permissions.

Returns:

a list of ContentPermissionSets. Not null, but can be empty.

Since:

5.8

getContentPermissionSets

List<ContentPermissionSet> getContentPermissionSets(ContentEntityObject ceo,
                                                    String type)

Get the ContentPermissionSets that affect this ceo, both inherited and directly. Note that EDIT Permissions are not currently inherited, so calling this method with EDIT will return only the direct ContentPermissionSet.

Parameters:

ceo - whose permissions will be returned. Not null.

type - one of ContentPermission.VIEW_PERMISSION or ContentPermission.EDIT_PERMISSION

Returns:

a list of ContentPermissionSets. Not null, but can be empty.

isPermissionInherited

boolean isPermissionInherited(Page childPage)

Does the child page get its permissions from any ancestor?

Parameters:

childPage -

Returns:

boolean True if the child page does not have a view permission set, and an ancestor does.

copyContentPermissions

@Deprecated
void copyContentPermissions(AbstractPage from,
                                        AbstractPage to)

Deprecated. since 5.10.1 use copyContentPermissions(ContentEntityObject, ContentEntityObject)

Copies all content permissions from one page to another.

Since:

5.10

copyContentPermissions

void copyContentPermissions(ContentEntityObject from,
                            ContentEntityObject to)

Copies all content permissions from one content entity to another.

Since:

5.10.1

getPermissionSets

Map<Long,Boolean> getPermissionSets(com.atlassian.user.User user,
                                    Space space)

Retrieves the configured permissions regarding whether the specified user can view the pages inside a space. If a page is not configured in the tables - CONTENT_PERM_SET and CONTENT_PERM, then the permission of that page will not be included here. Note: the permission returned here does not consider the inherited permission from parent page.

Parameters:

user - - confluence user to be checked

space - - confluence space

Returns:

a Map where the key is the page id and the value indicates the view permission.

Since:

5.10.8