com.atlassian.confluence.impl.security

Class CoarseGrainedCachingSpacePermissionManager

java.lang.Object

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

public class CoarseGrainedCachingSpacePermissionManager
extends AbstractSpacePermissionManager

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:

SpacePermissionCachePrimer

Field Summary

Fields

Modifier and Type	Field and Description
protected SpacePermissionDao	spacePermissionDao

Constructor Summary

Constructors

Constructor and Description

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

Method Summary

Modifier and Type	Method and Description
void	createDefaultSpacePermissions(Space space)
void	createPrivateSpacePermissions(Space space)
void	flushCaches()
List<SpacePermission>	getAllPermissionsForGroup(String group)
List<SpacePermission>	getGlobalPermissions()
List<SpacePermission>	getGlobalPermissions(String permissionType)
protected Iterable<String>	getGroupNamesWithPermission(@Nullable Space targetSpace, String permissionType)
Map<String,Long>	getGroupsForPermissionType(String permissionType, Space space)
Collection<com.atlassian.user.Group>	getGroupsWithPermissions(@Nullable Space space) Returns all groups which have permissions in a space or on a global level.
Map<String,Long>	getUsersForPermissionType(String permissionType, Space space)
Collection<com.atlassian.user.User>	getUsersWithPermissions(@Nullable Space space) Returns a collection of user objects with VIEWSPACE_PERMISSION in the space.
boolean	permissionExists(SpacePermission permission) Check whether the given SpacePermission exists.
void	prime(Iterable<? extends Space> spaces) Pre-loads global permissions and permissions for given spaces.
void	removeAllPermissions(Space space) Deprecated. since 5.9. Use SpacePermissionManagerInternal.removeAllPermissions(com.atlassian.confluence.spaces.Space, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
void	removeAllPermissions(Space space, SpacePermissionContext context) Removes all permissions belonging to space
void	removeAllPermissionsForGroup(String group) Deprecated. since 5.8. Use SpacePermissionManagerInternal.removeAllPermissionsForGroup(String, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
void	removeAllPermissionsForGroup(String group, SpacePermissionContext context) Removes all permissions for the given group.
void	removeAllUserPermissions(ConfluenceUser user) Deprecated. since 5.9. Use SpacePermissionManagerInternal.removeAllUserPermissions(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
void	removeAllUserPermissions(ConfluenceUser user, SpacePermissionContext context) Removes all permissions for the given user.
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.
void	removeGlobalPermissionForUser(ConfluenceUser user, String permissionType, SpacePermissionContext context) Removes global permission of specified type that is directly associated with a user.
void	removePermission(SpacePermission permission) Deprecated. since 5.9. Use SpacePermissionManagerInternal.removePermission(SpacePermission, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
void	removePermission(SpacePermission permission, SpacePermissionContext context) Removes the given permission.
void	savePermission(SpacePermission permission) Deprecated. since 5.9. Use SpacePermissionSaverInternal.savePermission(SpacePermission, com.atlassian.confluence.internal.security.SpacePermissionContext) instead.
void	savePermission(SpacePermission permission, SpacePermissionContext context) Saves the permission.

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 Detail

spacePermissionDao

protected final SpacePermissionDao spacePermissionDao

Constructor Detail

CoarseGrainedCachingSpacePermissionManager

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

Since:

7.5

Method Detail

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)

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)

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)

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

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)

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)

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

getAllPermissionsForGroup

public List<SpacePermission> getAllPermissionsForGroup(String group)

Specified by:

getAllPermissionsForGroup in interface SpacePermissionManager

getGlobalPermissions

public List<SpacePermission> getGlobalPermissions()

Specified by:

getGlobalPermissions in interface SpacePermissionManager

getGlobalPermissions

public List<SpacePermission> getGlobalPermissions(String permissionType)

Specified by:

getGlobalPermissions in interface SpacePermissionManager

flushCaches

public void flushCaches()

Specified by:

flushCaches in interface SpacePermissionManager

createDefaultSpacePermissions

public void createDefaultSpacePermissions(Space space)

Specified by:

createDefaultSpacePermissions in interface SpacePermissionManager

createPrivateSpacePermissions

public void createPrivateSpacePermissions(Space space)

Specified by:

createPrivateSpacePermissions in interface SpacePermissionManager

getGroupsWithPermissions

public Collection<com.atlassian.user.Group> getGroupsWithPermissions(@Nullable Space space)

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)

Specified by:

getGroupsForPermissionType in interface SpacePermissionManager

getUsersWithPermissions

public Collection<com.atlassian.user.User> getUsersWithPermissions(@Nullable Space space)

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)

Specified by:

getUsersForPermissionType in interface SpacePermissionManager

getGroupNamesWithPermission

protected Iterable<String> getGroupNamesWithPermission(@Nullable Space targetSpace,
                                                       String permissionType)

Specified by:

getGroupNamesWithPermission in class AbstractSpacePermissionManager

permissionExists

public boolean permissionExists(SpacePermission permission)

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)

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

prime

public void prime(Iterable<? extends Space> spaces)

Pre-loads global permissions and permissions for given spaces.

Parameters:

spaces - spaces whose permissions should be pre-loaded