com.atlassian.confluence.impl.security.AbstractSpacePermissionManager

com.atlassian.confluence.impl.security.CoarseGrainedCachingSpacePermissionManager

All Implemented Interfaces:: SpacePermissionManagerInternal, SpacePermissionSaverInternal, DefaultConfluenceAccessManager.AccessManagerPermissionChecker, SpacePermissionManager, SpacePermissionSaver

Direct Known Subclasses:: RecoveryAwareCGCachingSpacePermissionManager

@Deprecated(since="9.4", forRemoval=true) public class CoarseGrainedCachingSpacePermissionManager extends AbstractSpacePermissionManager

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.4. Use CachingSpacePermissionManager instead.

Space permission manager that caches all permissions for each space.

Whenever there is a cache miss, all permissions for the current space (can be global) are fetched in one go and cached as one block. Entries can be primed before they are needed and the entries will never expire. Any permission changes will invalidate the cache entry for the affected space.

Since:

5.9

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

protected final SpacePermissionDao

spacePermissionDao

Deprecated, for removal: This API element is subject to removal in a future version.
Constructor Summary

Constructors

Constructor

Description

CoarseGrainedCachingSpacePermissionManager(PermissionCheckExemptions permissionCheckExemptions, com.atlassian.cache.CacheFactory cacheFactory, SpacePermissionManagerInternal delegate, SpacePermissionDao spacePermissionDao, com.atlassian.event.api.EventPublisher eventPublisher, ConfluenceAccessManager confluenceAccessManager, SpacePermissionAccessMapper spacePermissionAccessMapper, com.atlassian.crowd.embedded.api.CrowdService crowdService, AccessModeManager accessModeManager, GlobalSettingsManager settingsManager)

Deprecated, for removal: This API element is subject to removal in a future version.
Method Summary

Modifier and Type

Method

Description

void

createDefaultSpacePermissions(Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

void

createPrivateSpacePermissions(Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

void

flushCaches()

Deprecated, for removal: This API element is subject to removal in a future version.

List<SpacePermission>

getAllPermissionsForGroup(String group)

Deprecated, for removal: This API element is subject to removal in a future version.

List<SpacePermission>

getGlobalPermissions()

Deprecated, for removal: This API element is subject to removal in a future version.

List<SpacePermission>

getGlobalPermissions(String permissionType)

Deprecated, for removal: This API element is subject to removal in a future version.

protected Iterable<String>

getGroupNamesWithPermission(@Nullable Space targetSpace, String permissionType)

Deprecated, for removal: This API element is subject to removal in a future version.

Map<String,Long>

getGroupsForPermissionType(String permissionType, Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

Collection<com.atlassian.user.Group>

getGroupsWithPermissions(@Nullable Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

Returns all groups which have permissions in a space or on a global level.

List<SpacePermission>

getPermissionsForAnonymousUsers(Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

Get all permissions granted to the anonymous users in the given space

List<SpacePermission>

getPermissionsForGroup(String group, Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

Get all permissions for the given group in the specified space

List<SpacePermission>

getPermissionsForUser(ConfluenceUser user, Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

Get all permissions for the given user in the specified space

Map<String,Long>

getUsersForPermissionType(String permissionType, Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

Collection<ConfluenceUser>

getUsersWithPermissions(@Nullable Space space)

Deprecated, for removal: This API element is subject to removal in a future version.

Returns a collection of user objects with VIEWSPACE_PERMISSION in the space.

boolean

permissionExists(SpacePermission permission)

Deprecated, for removal: This API element is subject to removal in a future version.

Check whether the given SpacePermission exists.

void

prime(Iterable<? extends Space> spaces)

Deprecated, for removal: This API element is subject to removal in a future version.

void

removeAllPermissions(Space space)

Deprecated.
since 5.9.

void

removeAllPermissions(Space space, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Removes all permissions belonging to space

void

removeAllPermissionsForGroup(String group)

Deprecated.
since 5.8.

void

removeAllPermissionsForGroup(String group, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Removes all permissions for the given group.

void

removeAllUserPermissions(ConfluenceUser user)

Deprecated.
since 5.9.

void

removeAllUserPermissions(ConfluenceUser user, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Removes all permissions for the given user.

void

removeGlobalPermissionForUser(ConfluenceUser user, String permissionType)

Deprecated.
since 5.9.

void

removeGlobalPermissionForUser(ConfluenceUser user, String permissionType, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Removes global permission of specified type that is directly associated with a user.

void

removePermission(SpacePermission permission)

Deprecated.
since 5.9.

void

removePermission(SpacePermission permission, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Removes the given permission.

void

removePermissions(Collection<SpacePermission> permissionsToRemove, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Removes the given permissions.

void

saveGlobalPermissions(Collection<SpacePermission> spacePermissions, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Adds global permissions

void

savePermission(SpacePermission permission)

Deprecated.
since 5.9.

void

savePermission(SpacePermission permission, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Saves the permission.

void

saveSpacePermissions(Space space, Collection<SpacePermission> spacePermissions, SpacePermissionContext context)

Deprecated, for removal: This API element is subject to removal in a future version.

Adds space permissions to the space

Methods inherited from class com.atlassian.confluence.impl.security.AbstractSpacePermissionManager
getDefaultGlobalPermissions, groupHasPermission, hasAllPermissions, hasGlobalPermissionViaGroups, hasPermission, hasPermissionForSpace, hasPermissionNoExemptions, isPermittedInReadOnlyAccessMode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.security.SpacePermissionManager
getDefaultGlobalPermissions, groupHasPermission, hasAllPermissions, hasPermission, hasPermissionForSpace, hasPermissionNoExemptions, isPermittedInReadOnlyAccessMode

Field Details
- spacePermissionDao
  
  protected final SpacePermissionDao spacePermissionDao
  
  Deprecated, for removal: This API element is subject to removal in a future version.
Constructor Details
- CoarseGrainedCachingSpacePermissionManager
  
  public CoarseGrainedCachingSpacePermissionManager(PermissionCheckExemptions permissionCheckExemptions, com.atlassian.cache.CacheFactory cacheFactory, SpacePermissionManagerInternal delegate, SpacePermissionDao spacePermissionDao, com.atlassian.event.api.EventPublisher eventPublisher, ConfluenceAccessManager confluenceAccessManager, SpacePermissionAccessMapper spacePermissionAccessMapper, com.atlassian.crowd.embedded.api.CrowdService crowdService, AccessModeManager accessModeManager, GlobalSettingsManager settingsManager)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Since:
  
  7.5
Method Details
- removeAllPermissions
  
  @Deprecated public void removeAllPermissions(Space space)
  
  Deprecated.
  since 5.9. Use SpacePermissionManagerInternal.removeAllPermissions(com.atlassian.confluence.spaces.Space, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
  
  Description copied from interface: SpacePermissionManager
  
  Removes all permissions belonging to space
  
  Specified by:
  
  removeAllPermissions in interface SpacePermissionManager
  
  Parameters:
  
  space - The space to remove the permissions for
- removeAllPermissions
  
  public void removeAllPermissions(Space space, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManagerInternal
  
  Removes all permissions belonging to space
  
  Specified by:
  
  removeAllPermissions in interface SpacePermissionManagerInternal
  
  Parameters:
  
  space - The space to remove the permissions for
  
  context - The context for this removal
- removePermission
  
  @Deprecated public void removePermission(SpacePermission permission)
  
  Deprecated.
  since 5.9. Use SpacePermissionManagerInternal.removePermission(SpacePermission, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
  
  Description copied from interface: SpacePermissionManager
  
  Removes the given permission, and generates a SpacePermissionRemoveEvent in the process.
  
  Specified by:
  
  removePermission in interface SpacePermissionManager
  
  Parameters:
  
  permission - the permission to remove
- removePermission
  
  public void removePermission(SpacePermission permission, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManagerInternal
  
  Removes the given permission.
  May generate a SpacePermissionRemoveEvent in the process, depending on the context.
  
  Specified by:
  
  removePermission in interface SpacePermissionManagerInternal
  
  Parameters:
  
  permission - the permission to remove
  
  context - the context for the removal
- removeAllUserPermissions
  
  @Deprecated public void removeAllUserPermissions(ConfluenceUser user)
  
  Deprecated.
  since 5.9. Use SpacePermissionManagerInternal.removeAllUserPermissions(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
  
  Description copied from interface: SpacePermissionManager
  
  Removes all permissions for the given user, and generates a SpacePermissionsRemoveForUserEvent in the process.
  
  Specified by:
  
  removeAllUserPermissions in interface SpacePermissionManager
- removeAllUserPermissions
  
  public void removeAllUserPermissions(ConfluenceUser user, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManagerInternal
  
  Removes all permissions for the given user.
  May generate a SpacePermissionsRemoveForUserEvent in the process, depending on the context.
  
  Specified by:
  
  removeAllUserPermissions in interface SpacePermissionManagerInternal
  
  Parameters:
  
  user - the user to remove permissions for
  
  context - the context for the removal
- removePermissions
  
  public void removePermissions(Collection<SpacePermission> permissionsToRemove, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManagerInternal
  
  Removes the given permissions.
  May generate a SpacePermissionRemoveEvent in the process, depending on the context.
  
  Specified by:
  
  removePermissions in interface SpacePermissionManagerInternal
  
  Parameters:
  
  permissionsToRemove - the permissions to remove
  
  context - the context for the removal
- removeGlobalPermissionForUser
  
  @Deprecated public void removeGlobalPermissionForUser(ConfluenceUser user, String permissionType)
  
  Deprecated.
  since 5.9. Use SpacePermissionManagerInternal.removeGlobalPermissionForUser(com.atlassian.confluence.user.ConfluenceUser, String, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
  
  Description copied from interface: SpacePermissionManager
  
  Removes global permission of specified type that is directly associated with a user, and generates a SpacePermissionsRemoveForUserEvent in the process.
  
  Specified by:
  
  removeGlobalPermissionForUser in interface SpacePermissionManager
  
  Parameters:
  
  user - the user to look up
  
  permissionType - the permission type to remove
- removeGlobalPermissionForUser
  
  public void removeGlobalPermissionForUser(ConfluenceUser user, String permissionType, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManagerInternal
  
  Removes global permission of specified type that is directly associated with a user.
  May generate a SpacePermissionsRemoveForUserEvent in the process, depending on the context.
  
  Specified by:
  
  removeGlobalPermissionForUser in interface SpacePermissionManagerInternal
  
  Parameters:
  
  user - the user to look up
  
  permissionType - the permission type to remove
  
  context - the context for the removal
- removeAllPermissionsForGroup
  
  @Deprecated public void removeAllPermissionsForGroup(String group)
  
  Deprecated.
  since 5.8. Use SpacePermissionManagerInternal.removeAllPermissionsForGroup(String, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
  
  Description copied from interface: SpacePermissionManager
  
  Removes all permissions for the given group, and generates a SpacePermissionsRemoveForGroupEvent in the process.
  
  Specified by:
  
  removeAllPermissionsForGroup in interface SpacePermissionManager
  
  Parameters:
  
  group - the group to remove
- removeAllPermissionsForGroup
  
  public void removeAllPermissionsForGroup(String group, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManagerInternal
  
  Removes all permissions for the given group.
  May generate a SpacePermissionsRemoveForGroupEvent in the process, depending on the context.
  
  Specified by:
  
  removeAllPermissionsForGroup in interface SpacePermissionManagerInternal
  
  Parameters:
  
  group - the group to remove
- getPermissionsForGroup
  
  public List<SpacePermission> getPermissionsForGroup(String group, Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManager
  
  Get all permissions for the given group in the specified space
  
  Specified by:
  
  getPermissionsForGroup in interface SpacePermissionManager
  
  Parameters:
  
  group - the name of the group
  
  space - the space entity
  
  Returns:
  
  a list of space permissions granted to the group in the given space
- getPermissionsForUser
  
  public List<SpacePermission> getPermissionsForUser(ConfluenceUser user, Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManager
  
  Get all permissions for the given user in the specified space
  
  Specified by:
  
  getPermissionsForUser in interface SpacePermissionManager
  
  Parameters:
  
  user - the user to look up
  
  space - the space entity
  
  Returns:
  
  a list of space permissions granted to the user in the given space
- getPermissionsForAnonymousUsers
  
  public List<SpacePermission> getPermissionsForAnonymousUsers(Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManager
  
  Get all permissions granted to the anonymous users in the given space
  
  Specified by:
  
  getPermissionsForAnonymousUsers in interface SpacePermissionManager
  
  Parameters:
  
  space - the space entity
  
  Returns:
  
  a list of space permissions granted to anonymous users in the given space
- getAllPermissionsForGroup
  
  public List<SpacePermission> getAllPermissionsForGroup(String group)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  getAllPermissionsForGroup in interface SpacePermissionManager
- getGlobalPermissions
  
  public List<SpacePermission> getGlobalPermissions()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  getGlobalPermissions in interface SpacePermissionManager
- getGlobalPermissions
  
  public List<SpacePermission> getGlobalPermissions(String permissionType)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  getGlobalPermissions in interface SpacePermissionManager
- flushCaches
  
  public void flushCaches()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  flushCaches in interface SpacePermissionManager
- createDefaultSpacePermissions
  
  public void createDefaultSpacePermissions(Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  createDefaultSpacePermissions in interface SpacePermissionManager
- createPrivateSpacePermissions
  
  public void createPrivateSpacePermissions(Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  createPrivateSpacePermissions in interface SpacePermissionManager
- getGroupsWithPermissions
  
  public Collection<com.atlassian.user.Group> getGroupsWithPermissions(@Nullable Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManager
  
  Returns all groups which have permissions in a space or on a global level. If space is null, permissions on the global level will be checked.
  
  Specified by:
  
  getGroupsWithPermissions in interface SpacePermissionManager
  
  Parameters:
  
  space - - space to query, if null global permissions returned
  
  Returns:
  
  Collection of groups with permissions
- getGroupsForPermissionType
  
  public Map<String,Long> getGroupsForPermissionType(String permissionType, Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  getGroupsForPermissionType in interface SpacePermissionManager
- getUsersWithPermissions
  
  public Collection<ConfluenceUser> getUsersWithPermissions(@Nullable Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManager
  
  Returns a collection of user objects with VIEWSPACE_PERMISSION in the space. If no space is provided A list of users with USE_CONFLUENCE_PERMISSION will be returned
  
  Specified by:
  
  getUsersWithPermissions in interface SpacePermissionManager
  
  Parameters:
  
  space - - space to query, if null global permissions returned
  
  Returns:
  
  Collection of User objects
- getUsersForPermissionType
  
  public Map<String,Long> getUsersForPermissionType(String permissionType, Space space)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  getUsersForPermissionType in interface SpacePermissionManager
- getGroupNamesWithPermission
  
  protected Iterable<String> getGroupNamesWithPermission(@Nullable Space targetSpace, String permissionType)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Specified by:
  
  getGroupNamesWithPermission in class AbstractSpacePermissionManager
- permissionExists
  
  public boolean permissionExists(SpacePermission permission)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionManager
  
  Check whether the given SpacePermission exists. Checks by attribute equality rather than by id.
  
  Specified by:
  
  permissionExists in interface DefaultConfluenceAccessManager.AccessManagerPermissionChecker
  
  Specified by:
  
  permissionExists in interface SpacePermissionManager
  
  Parameters:
  
  permission - the permission to look for.
  
  Returns:
  
  true if the permission is recognised by the manager as existing.
- savePermission
  
  @Deprecated public void savePermission(SpacePermission permission)
  
  Deprecated.
  since 5.9. Use SpacePermissionSaverInternal.savePermission(SpacePermission, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
  
  Description copied from interface: SpacePermissionSaver
  
  Saves the permission, and generates a SpacePermissionSaveEvent in the process.
  
  Specified by:
  
  savePermission in interface SpacePermissionSaver
- savePermission
  
  public void savePermission(SpacePermission permission, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionSaverInternal
  
  Saves the permission.
  May generate a SpacePermissionSaveEvent in the process, depending on the context.
  
  Specified by:
  
  savePermission in interface SpacePermissionSaverInternal
  
  Parameters:
  
  permission - the permission to save
  
  context - the context for the save
- saveSpacePermissions
  
  public void saveSpacePermissions(Space space, Collection<SpacePermission> spacePermissions, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionSaverInternal
  
  Adds space permissions to the space
  
  Specified by:
  
  saveSpacePermissions in interface SpacePermissionSaverInternal
  
  Parameters:
  
  space - Space to which permissions should be granted
  
  spacePermissions - Collection of space permissions. They should all belong to the same space.
  
  context - the context of the save
- prime
  
  public void prime(Iterable<? extends Space> spaces)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
- saveGlobalPermissions
  
  public void saveGlobalPermissions(Collection<SpacePermission> spacePermissions, SpacePermissionContext context)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  
  Description copied from interface: SpacePermissionSaverInternal
  
  Adds global permissions
  
  Specified by:
  
  saveGlobalPermissions in interface SpacePermissionSaverInternal
  
  Parameters:
  
  spacePermissions - Collection of global permissions.
  
  context - the context of the save

Class CoarseGrainedCachingSpacePermissionManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.confluence.impl.security.AbstractSpacePermissionManager

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.confluence.security.SpacePermissionManager

Field Details

spacePermissionDao

Constructor Details

CoarseGrainedCachingSpacePermissionManager

Method Details

removeAllPermissions

removeAllPermissions

removePermission

removePermission

removeAllUserPermissions

removeAllUserPermissions

removePermissions

removeGlobalPermissionForUser

removeGlobalPermissionForUser

removeAllPermissionsForGroup

removeAllPermissionsForGroup

getPermissionsForGroup

getPermissionsForUser

getPermissionsForAnonymousUsers

getAllPermissionsForGroup

getGlobalPermissions

getGlobalPermissions

flushCaches

createDefaultSpacePermissions

createPrivateSpacePermissions

getGroupsWithPermissions

getGroupsForPermissionType

getUsersWithPermissions

getUsersForPermissionType

getGroupNamesWithPermission

permissionExists

savePermission

savePermission

saveSpacePermissions

prime

saveGlobalPermissions