com.atlassian.jira.issue.context.persistence

Class CachingFieldConfigContextPersister

java.lang.Object

com.atlassian.jira.issue.context.persistence.CachingFieldConfigContextPersister

All Implemented Interfaces:

Startable, FieldConfigContextPersister

@Internal
public class CachingFieldConfigContextPersister
extends Object
implements FieldConfigContextPersister, Startable

Caching decorator for FieldConfigContextPersister. This corresponds to the configurationcontext table, which is essentially an association table between CustomField and either a ProjectCategory or a Project, but not both (in practice it is always a Project). Each association also has FieldConfigScheme as a property of the association, and this is where things like default values for custom fields are ultimately stored. When both the project and projectCategory are null, then that database row is in fact a special row holding the FieldConfigScheme for the "Global Context".

See CustomField Configuration - DB Entity Model for a more in-depth explanation of how this all works.

Since:

v5.1

Constructor Summary

Constructors

Constructor and Description
CachingFieldConfigContextPersister(OfBizDelegator delegator, ProjectManager projectManager, com.atlassian.cache.CacheManager cacheManager, com.atlassian.event.api.EventPublisher eventPublisher) Creates a new CachingFieldConfigContextPersister that wraps a new FieldConfigContextPersisterImpl instance.

Method Summary

Modifier and Type	Method and Description
com.atlassian.jira.issue.context.persistence.CachingFieldConfigContextPersister.IssueTypeSet	configSchemeIssueTypeLoader(Long schemeId)
List<JiraContextNode>	getAllContextsForConfigScheme(FieldConfigScheme fieldConfigScheme)
Long	getRelevantConfigSchemeId(IssueContext issueContext, String fieldId)
Long	getRelevantConfigSchemeId(Long projectId, String fieldId)
void	onClearCache(ClearCacheEvent clearCacheEvent) Clears this CachingFieldConfigContextPersister's cache upon receiving a ClearCacheEvent.
void	removeContexts(String fieldId, Collection<? extends JiraContextNode> contextNodes) Bulk remove a collection of contextNode for a given fieldId
void	removeContextsForConfigScheme(FieldConfigScheme fieldConfigScheme)
void	removeContextsForProject(Project project)
void	start() Registers this CachingFieldConfigContextPersister's cache in the JIRA instrumentation.
void	store(String fieldId, Collection<? extends JiraContextNode> contextNodes, FieldConfigScheme fieldConfigScheme) Bulk store fieldId/contextNode/scheme triplets.
void	store(String fieldId, JiraContextNode contextNode, FieldConfigScheme fieldConfigScheme) Store a fieldId/contextNode/scheme triplet.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingFieldConfigContextPersister

public CachingFieldConfigContextPersister(OfBizDelegator delegator,
                                          ProjectManager projectManager,
                                          com.atlassian.cache.CacheManager cacheManager,
                                          com.atlassian.event.api.EventPublisher eventPublisher)

Creates a new CachingFieldConfigContextPersister that wraps a new FieldConfigContextPersisterImpl instance.

Parameters:

delegator - the OfBizDelegator

projectManager - the ProjectManager

eventPublisher - is used to rise that config scheme was updated

Method Detail

start

public void start()
           throws Exception

Registers this CachingFieldConfigContextPersister's cache in the JIRA instrumentation.

Specified by:

start in interface Startable

Throws:

Exception

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent clearCacheEvent)

Clears this CachingFieldConfigContextPersister's cache upon receiving a ClearCacheEvent.

Parameters:

clearCacheEvent - a ClearCacheEvent

getAllContextsForConfigScheme

public List<JiraContextNode> getAllContextsForConfigScheme(FieldConfigScheme fieldConfigScheme)

Specified by:

getAllContextsForConfigScheme in interface FieldConfigContextPersister

removeContextsForConfigScheme

public void removeContextsForConfigScheme(@Nonnull
                                          FieldConfigScheme fieldConfigScheme)

Specified by:

removeContextsForConfigScheme in interface FieldConfigContextPersister

removeContextsForProject

public void removeContextsForProject(Project project)

Specified by:

removeContextsForProject in interface FieldConfigContextPersister

removeContexts

public void removeContexts(String fieldId,
                           Collection<? extends JiraContextNode> contextNodes)

Description copied from interface: FieldConfigContextPersister

Bulk remove a collection of contextNode for a given fieldId

Specified by:

removeContexts in interface FieldConfigContextPersister

getRelevantConfigSchemeId

@Nullable
public Long getRelevantConfigSchemeId(@Nonnull
                                                IssueContext issueContext,
                                                @Nonnull
                                                String fieldId)

Specified by:

getRelevantConfigSchemeId in interface FieldConfigContextPersister

getRelevantConfigSchemeId

@Nullable
public Long getRelevantConfigSchemeId(@Nullable
                                                Long projectId,
                                                @Nonnull
                                                String fieldId)

Specified by:

getRelevantConfigSchemeId in interface FieldConfigContextPersister

store

public void store(String fieldId,
                  JiraContextNode contextNode,
                  FieldConfigScheme fieldConfigScheme)

Description copied from interface: FieldConfigContextPersister

Store a fieldId/contextNode/scheme triplet.

Specified by:

store in interface FieldConfigContextPersister

store

public void store(String fieldId,
                  Collection<? extends JiraContextNode> contextNodes,
                  FieldConfigScheme fieldConfigScheme)

Description copied from interface: FieldConfigContextPersister

Bulk store fieldId/contextNode/scheme triplets.

Specified by:

store in interface FieldConfigContextPersister

configSchemeIssueTypeLoader

@Nonnull
public com.atlassian.jira.issue.context.persistence.CachingFieldConfigContextPersister.IssueTypeSet configSchemeIssueTypeLoader(Long schemeId)