com.atlassian.confluence.security

Class CachingSpacePermissionManager

java.lang.Object

com.atlassian.confluence.security.AbstractSpacePermissionManager

com.atlassian.confluence.security.DefaultSpacePermissionManager

com.atlassian.confluence.security.CachingSpacePermissionManager

All Implemented Interfaces:

SpacePermissionManagerInternal, SpacePermissionSaverInternal, DefaultConfluenceAccessManager.AccessManagerPermissionChecker, SpacePermissionManager, SpacePermissionSaver

Direct Known Subclasses:

RecoveryAwareCachingSpacePermissionManager

@Internal
 @ParametersAreNonnullByDefault
public class CachingSpacePermissionManager
extends DefaultSpacePermissionManager

Implementation of SpacePermissionManager that implements caching before a SpacePermission is requested, saved or removed from the SpacePermissionDao. This is designed to increase performance and reduce the amount of hits on the database.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_KEY Deprecated. Since 7.3 No replacement.

Fields inherited from class com.atlassian.confluence.security.DefaultSpacePermissionManager

spacePermissionDao

Fields inherited from class com.atlassian.confluence.security.AbstractSpacePermissionManager

confluenceAccessManager, permissionCheckExemptions, spacePermissionAccessMapper

Constructor Summary

Constructors

Constructor and Description
CachingSpacePermissionManager(SpacePermissionDao spacePermissionDao, PermissionCheckExemptions permissionCheckExemptions, SpacePermissionDefaultsStoreFactory spacePermissionDefaultsStoreFactory, com.atlassian.cache.CacheFactory cacheFactory, com.atlassian.event.api.EventPublisher eventPublisher, ConfluenceAccessManager confluenceAccessManager, SpacePermissionAccessMapper spacePermissionAccessMapper, com.atlassian.crowd.embedded.api.CrowdService crowdService, com.google.common.base.Supplier<UserAccessor> userAccessor, AccessModeManager accessModeManager) Deprecated.
CachingSpacePermissionManager(SpacePermissionDao spacePermissionDao, PermissionCheckExemptions permissionCheckExemptions, SpacePermissionDefaultsStoreFactory spacePermissionDefaultsStoreFactory, TransactionAwareCacheFactory cacheFactory, com.atlassian.event.api.EventPublisher eventPublisher, ConfluenceAccessManager confluenceAccessManager, SpacePermissionAccessMapper spacePermissionAccessMapper, com.atlassian.crowd.embedded.api.CrowdService crowdService, com.google.common.base.Supplier<UserAccessor> userAccessor, AccessModeManager accessModeManager) Deprecated. since 7.5
CachingSpacePermissionManager(SpacePermissionDao spacePermissionDao, PermissionCheckExemptions permissionCheckExemptions, SpacePermissionDefaultsStoreFactory spacePermissionDefaultsStoreFactory, TransactionAwareCacheFactory cacheFactory, com.atlassian.event.api.EventPublisher eventPublisher, ConfluenceAccessManager confluenceAccessManager, SpacePermissionAccessMapper spacePermissionAccessMapper, com.atlassian.crowd.embedded.api.CrowdService crowdService, UserAccessor userAccessor, AccessModeManager accessModeManager)

Method Summary

Modifier and Type	Method and Description
void	flushCaches()
protected Set<String>	getGroupNamesWithPermission(@Nullable Space targetSpace, String permissionType)
boolean	hasPermissionNoExemptions(String permissionType, @Nullable Space space, @Nullable com.atlassian.user.User remoteUser) Returns true if the user has the specified permission on the target space.
boolean	isLookAheadEnabled()
boolean	permissionExists(SpacePermission permission) Looks up permission in the cache instance.
protected void	removeAllPermissionsFromDao(Space space)
protected void	removePermissionFromDao(SpacePermission spacePermission) Removes realPermission from the DAO.
protected void	savePermissionToDao(SpacePermission spacePermission) Saves permission to the DAO.
void	setLookAheadEnabled(boolean lookAheadEnabled)

Methods inherited from class com.atlassian.confluence.security.DefaultSpacePermissionManager

createDefaultSpacePermissions, createPrivateSpacePermissions, getAllPermissionsForGroup, getAllPermissionsForUser, getGlobalPermissions, getGlobalPermissions, getGroupsForPermissionType, getGroupsWithPermissions, getUsersForPermissionType, getUsersWithPermissions, removeAllPermissions, removeAllPermissions, removeAllPermissionsForGroup, removeAllPermissionsForGroup, removeAllUserPermissions, removeAllUserPermissions, removeGlobalPermissionForUser, removeGlobalPermissionForUser, removePermission, removePermission, savePermission, savePermission

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

getAccessModeManager, getDefaultGlobalPermissions, getUserAccessor, groupHasPermission, hasAllPermissions, hasGlobalPermissionViaGroups, hasPermission, hasPermissionForSpace, isPermittedInReadOnlyAccessMode

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_KEY

@Deprecated
public static final String CACHE_KEY

Deprecated. Since 7.3 No replacement.

Constructor Detail

CachingSpacePermissionManager

public CachingSpacePermissionManager(SpacePermissionDao spacePermissionDao,
                                     PermissionCheckExemptions permissionCheckExemptions,
                                     SpacePermissionDefaultsStoreFactory spacePermissionDefaultsStoreFactory,
                                     TransactionAwareCacheFactory cacheFactory,
                                     com.atlassian.event.api.EventPublisher eventPublisher,
                                     ConfluenceAccessManager confluenceAccessManager,
                                     SpacePermissionAccessMapper spacePermissionAccessMapper,
                                     com.atlassian.crowd.embedded.api.CrowdService crowdService,
                                     UserAccessor userAccessor,
                                     AccessModeManager accessModeManager)

Since:

7.5

CachingSpacePermissionManager

@Deprecated
public CachingSpacePermissionManager(SpacePermissionDao spacePermissionDao,
                                                 PermissionCheckExemptions permissionCheckExemptions,
                                                 SpacePermissionDefaultsStoreFactory spacePermissionDefaultsStoreFactory,
                                                 TransactionAwareCacheFactory cacheFactory,
                                                 com.atlassian.event.api.EventPublisher eventPublisher,
                                                 ConfluenceAccessManager confluenceAccessManager,
                                                 SpacePermissionAccessMapper spacePermissionAccessMapper,
                                                 com.atlassian.crowd.embedded.api.CrowdService crowdService,
                                                 com.google.common.base.Supplier<UserAccessor> userAccessor,
                                                 AccessModeManager accessModeManager)

Deprecated. since 7.5

CachingSpacePermissionManager

@Deprecated
public CachingSpacePermissionManager(SpacePermissionDao spacePermissionDao,
                                                 PermissionCheckExemptions permissionCheckExemptions,
                                                 SpacePermissionDefaultsStoreFactory spacePermissionDefaultsStoreFactory,
                                                 com.atlassian.cache.CacheFactory cacheFactory,
                                                 com.atlassian.event.api.EventPublisher eventPublisher,
                                                 ConfluenceAccessManager confluenceAccessManager,
                                                 SpacePermissionAccessMapper spacePermissionAccessMapper,
                                                 com.atlassian.crowd.embedded.api.CrowdService crowdService,
                                                 com.google.common.base.Supplier<UserAccessor> userAccessor,
                                                 AccessModeManager accessModeManager)

Deprecated.

Method Detail

permissionExists

public boolean permissionExists(SpacePermission permission)

Looks up permission in the cache instance. If it is not found, then it is looked up by the DAO and the result (true or false) is also recorded.

If permission belongs to a space, it is looked up in the Space's own permissions list.

In addition, when lookAheadEnabled is true, #doLookAheadCache will be called and the results cached, provided permission does not belong to a space.

Specified by:

permissionExists in interface DefaultConfluenceAccessManager.AccessManagerPermissionChecker

Specified by:

permissionExists in interface SpacePermissionManager

Overrides:

permissionExists in class DefaultSpacePermissionManager

Parameters:

permission - the SpacePermission to look up

Returns:

true if the permission exists, false otherwise

savePermissionToDao

protected void savePermissionToDao(SpacePermission spacePermission)

Saves permission to the DAO. In addition, this method removes the permission from the cache, to prevent corruption of the cache when there is a transaction rollback (since the cache isn't transactional)

Overrides:

savePermissionToDao in class DefaultSpacePermissionManager

Parameters:

spacePermission - the SpacePermission to save

removePermissionFromDao

protected void removePermissionFromDao(SpacePermission spacePermission)

Removes realPermission from the DAO. In addition, the permission is also removed from the cache.

Overrides:

removePermissionFromDao in class DefaultSpacePermissionManager

Parameters:

spacePermission - the SpacePermission to remove

removeAllPermissionsFromDao

protected void removeAllPermissionsFromDao(Space space)

Overrides:

removeAllPermissionsFromDao in class DefaultSpacePermissionManager

flushCaches

public void flushCaches()

Specified by:

flushCaches in interface SpacePermissionManager

Overrides:

flushCaches in class DefaultSpacePermissionManager

isLookAheadEnabled

public boolean isLookAheadEnabled()

setLookAheadEnabled

public void setLookAheadEnabled(boolean lookAheadEnabled)

hasPermissionNoExemptions

public boolean hasPermissionNoExemptions(String permissionType,
                                         @Nullable Space space,
                                         @Nullable com.atlassian.user.User remoteUser)

Description copied from interface: SpacePermissionManager

Returns true if the user has the specified permission on the target space. This method does not allow exemptions for super-users like SpacePermissionManager.hasPermission(String, Space, User) does.

For parameter and return value information, see SpacePermissionManager.hasPermission(String, Space, User).

Specified by:

hasPermissionNoExemptions in interface SpacePermissionManager

Overrides:

hasPermissionNoExemptions in class AbstractSpacePermissionManager

getGroupNamesWithPermission

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

Overrides:

getGroupNamesWithPermission in class DefaultSpacePermissionManager