com.atlassian.jira.issue.search.util

Class DefaultPermissionQueryCache

java.lang.Object

com.atlassian.jira.issue.search.util.DefaultPermissionQueryCache

All Implemented Interfaces:

PermissionQueryCache

public class DefaultPermissionQueryCache
extends Object
implements PermissionQueryCache

Cache for holding precomputed JQL permission query filter. See JRASERVER-14980. In current implementation second call to getPermissionQuery causes permission filter to be precomputed and cached in CachingWrapperFilter which gives us an extra benefit of precalculating its BitSet. Caching can be disabled:

• globally by disabling RequestCacheKeys.WRAP_PERMISSION_FILTER_IN_CACHED_WRAPPER_CACHE feature flag
• per request by using disableCacheForRequest()

Constructor Summary

Constructors

Constructor and Description
DefaultPermissionQueryCache(PermissionsFilterGenerator permissionsFilterGenerator)

Method Summary

Modifier and Type	Method and Description
void	disableCacheForRequest() Disables cache usage for this http request.
Optional<org.apache.lucene.search.Query>	getPermissionQuery(ApplicationUser searchUser) Gets permission cache for passed searchUser.
Optional<org.apache.lucene.search.Query>	getPermissionQuery(ApplicationUser searchUser, Collection<Project> projects) Gets permission cache for passed searchUser in given projects.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPermissionQueryCache

public DefaultPermissionQueryCache(PermissionsFilterGenerator permissionsFilterGenerator)

Method Detail

getPermissionQuery

public Optional<org.apache.lucene.search.Query> getPermissionQuery(ApplicationUser searchUser)

Description copied from interface: PermissionQueryCache

Gets permission cache for passed searchUser.

Specified by:

getPermissionQuery in interface PermissionQueryCache

Parameters:

searchUser - Application user

Returns:

Optional with cached permission filter or Optional.empty() if cache is turned off (either by feature flag or for request) or not applicable for this request (eq. only second and following calls could be cached).

getPermissionQuery

public Optional<org.apache.lucene.search.Query> getPermissionQuery(ApplicationUser searchUser,
                                                                   @Nullable
                                                                   Collection<Project> projects)

Description copied from interface: PermissionQueryCache

Gets permission cache for passed searchUser in given projects.

Specified by:

getPermissionQuery in interface PermissionQueryCache

Parameters:

searchUser - Application user

projects - List of projects

Returns:

Optional with cached permission filter or Optional.empty() if cache is turned off (either by feature flag or for request) or not applicable for this request (eq. only second and following calls could be cached).

disableCacheForRequest

public void disableCacheForRequest()

Description copied from interface: PermissionQueryCache

Disables cache usage for this http request.

Specified by:

disableCacheForRequest in interface PermissionQueryCache