com.atlassian.confluence.core
Class DefaultContentPermissionManager

java.lang.Object
  com.atlassian.confluence.core.DefaultContentPermissionManager

All Implemented Interfaces:

ContentPermissionManager

public class DefaultContentPermissionManager
extends java.lang.Object
implements ContentPermissionManager

Field Summary

protected ContentPermissionDao	contentPermissionDao
protected PageManager	pageManager

Constructor Summary

DefaultContentPermissionManager()

Method Summary

void	addContentPermission(ContentPermission permission, ContentEntityObject content) Adds a new current content permission to the CEO if it doesn't have it already.
protected boolean	cannotHaveInheritedPermissions(ContentEntityObject contentEntityObject) Check (for speed) whether we should even bother to query for possible inherited permissions.
java.util.List	getContentPermissionSets(ContentEntityObject ceo, java.lang.String type) Get the ContentPermissionSets that affect this ceo, both inherited and directly.
java.util.List	getInheritedContentPermissions(ContentEntityObject contentEntityObject) Returns all inherited content permission objects attached to the ancestors of this entity object, that is, all view permissions but *not* edit permissions.
java.util.List	getInheritedContentPermissionSets(ContentEntityObject contentEntityObject)
java.util.List	getInheritedContentUserPermissions(ContentEntityObject contentEntityObject) Filters the inherited content permission sets of a page for a list of inherited user permissions (of type ContentPermission.VIEW_PERMISSION)
java.util.List	getInheritedViewContentPermissions(Page page) Deprecated. use ContentPermissionManager.getInheritedContentPermissionSets(ContentEntityObject)
java.util.List	getPermittedChildren(Page page, com.atlassian.user.User user) Returns a list of Page objects that are direct children of the passed in page.
java.util.Set	getViewContentPermissions(Page page) Get view permissions on this page and its ancestors.
boolean	hasContentLevelPermission(com.atlassian.user.User user, java.lang.String permissionType, ContentEntityObject content) fetches the inherited and explicit content level permissions for this content object and determines whether the user has access.
void	removeAllGroupPermissions(java.lang.String groupName) Remove all content permission associtated with a given group.
void	removeAllUserPermissions(java.lang.String userName) Remove all content permission associtated with a given user.
void	removeContentPermission(ContentPermission contentPermission)
void	setContentPermissionDao(ContentPermissionDao contentPermissionDao)
void	setContentPermissions(java.util.Collection requiredPermissions, ContentEntityObject content, java.lang.String type) Set the Content Permissions on the CEO to be the list of ContentPermissions passed.
void	setContentPermissionSetDao(ContentPermissionSetDao contentPermissionSetDao)
void	setEventManager(com.atlassian.event.EventManager eventManager)
void	setIndexer(ConfluenceIndexer indexer)
void	setInheritedContentPermissionManager(InheritedContentPermissionManager inheritedContentPermissionManager)
void	setPageManager(PageManager pageManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pageManager

protected PageManager pageManager

contentPermissionDao

protected ContentPermissionDao contentPermissionDao

Constructor Detail

DefaultContentPermissionManager

public DefaultContentPermissionManager()

Method Detail

getInheritedContentPermissions

public java.util.List getInheritedContentPermissions(ContentEntityObject contentEntityObject)

Description copied from interface: ContentPermissionManager

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

Specified by:

getInheritedContentPermissions in interface ContentPermissionManager

cannotHaveInheritedPermissions

protected boolean cannotHaveInheritedPermissions(ContentEntityObject contentEntityObject)

Check (for speed) whether we should even bother to query for possible inherited permissions.

At the moment this simply checks if the CEO is hierarchical AND has a parent - could be optimised further in the future.

Returns:

TRUE if this object cannot have inherited permissions, FALSE is the object could have inherited permissions

getInheritedContentUserPermissions

public java.util.List getInheritedContentUserPermissions(ContentEntityObject contentEntityObject)

Filters the inherited content permission sets of a page for a list of inherited user permissions (of type ContentPermission.VIEW_PERMISSION)

Specified by:

getInheritedContentUserPermissions in interface ContentPermissionManager

getInheritedContentPermissionSets

public java.util.List getInheritedContentPermissionSets(ContentEntityObject contentEntityObject)

Specified by:

getInheritedContentPermissionSets in interface ContentPermissionManager

Returns:

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

getContentPermissionSets

public java.util.List getContentPermissionSets(ContentEntityObject ceo,
                                               java.lang.String type)

Description copied from interface: ContentPermissionManager

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.

Specified by:

getContentPermissionSets in interface ContentPermissionManager

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.

hasContentLevelPermission

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

Description copied from interface: ContentPermissionManager

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

Specified by:

hasContentLevelPermission in interface ContentPermissionManager

permissionType - ContentPermission.VIEW_PERMISSION or ContentPermission.EDIT_PERMISSION

Returns:

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

removeContentPermission

public void removeContentPermission(ContentPermission contentPermission)

Specified by:

removeContentPermission in interface ContentPermissionManager

removeAllGroupPermissions

public void removeAllGroupPermissions(java.lang.String groupName)

Description copied from interface: ContentPermissionManager

Remove all content permission associtated with a given group.

Specified by:

removeAllGroupPermissions in interface ContentPermissionManager

removeAllUserPermissions

public void removeAllUserPermissions(java.lang.String userName)

Description copied from interface: ContentPermissionManager

Remove all content permission associtated with a given user.

Specified by:

removeAllUserPermissions in interface ContentPermissionManager

addContentPermission

public void addContentPermission(ContentPermission permission,
                                 ContentEntityObject content)

Adds a new current content permission to the CEO if it doesn't have it already.

Specified by:

addContentPermission in interface ContentPermissionManager

Throws:

java.lang.IllegalArgumentException - if the permission's user or group is invalid.

setContentPermissions

public void setContentPermissions(java.util.Collection requiredPermissions,
                                  ContentEntityObject content,
                                  java.lang.String type)

Description copied from interface: ContentPermissionManager

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.

Specified by:

setContentPermissions in interface ContentPermissionManager

Parameters:

requiredPermissions - set of ContentPermissions

getPermittedChildren

public java.util.List 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. This method will sort the children according to the ChildPositionComparator.

Specified by:

getPermittedChildren in interface ContentPermissionManager

Parameters:

page -

user -

Returns:

getInheritedViewContentPermissions

public java.util.List getInheritedViewContentPermissions(Page page)

Deprecated. use ContentPermissionManager.getInheritedContentPermissionSets(ContentEntityObject)

Description copied from interface: ContentPermissionManager

only get inherited permissions that are restrict the viewing of pages

Specified by:

getInheritedViewContentPermissions in interface ContentPermissionManager

Returns:

a list of ContentPermission instances

getViewContentPermissions

public java.util.Set getViewContentPermissions(Page page)

Description copied from interface: ContentPermissionManager

Get view permissions on this page and its ancestors.

Specified by:

getViewContentPermissions in interface ContentPermissionManager

Returns:

a list of ContentPermission instances

setContentPermissionDao

public void setContentPermissionDao(ContentPermissionDao contentPermissionDao)

setPageManager

public void setPageManager(PageManager pageManager)

setContentPermissionSetDao

public void setContentPermissionSetDao(ContentPermissionSetDao contentPermissionSetDao)

setIndexer

public void setIndexer(ConfluenceIndexer indexer)

setEventManager

public void setEventManager(com.atlassian.event.EventManager eventManager)

setInheritedContentPermissionManager

public void setInheritedContentPermissionManager(InheritedContentPermissionManager inheritedContentPermissionManager)