com.atlassian.jira.issue.fields.config.persistence

Class CachedFieldConfigSchemePersister

java.lang.Object

com.atlassian.jira.issue.fields.config.persistence.FieldConfigSchemePersisterImpl

com.atlassian.jira.issue.fields.config.persistence.CachedFieldConfigSchemePersister

All Implemented Interfaces:

FieldConfigSchemePersister

public class CachedFieldConfigSchemePersister
extends FieldConfigSchemePersisterImpl

A simple caching wrapper

NOTE : you may be wondering about the cache invalidation strategy on this cache. Will the top level classes that use this cache such as com.atlassian.jira.issue.CustomFieldManager@refreshCache call init() and this clears the cache.

TODO: This probably should be rewritten so that the upper lays of code are not responsible for clearing the lower level caches and also the "cache inheritance" pattern should be removed.

Field Summary

Fields inherited from class com.atlassian.jira.issue.fields.config.persistence.FieldConfigSchemePersisterImpl

ENTITY_CONFIG_ID, ENTITY_DESCRIPTION, ENTITY_FIELD, ENTITY_ID, ENTITY_ISSUE_TYPE, ENTITY_NAME, ENTITY_RELATED_TABLE_NAME, ENTITY_SCHEME_ID, ENTITY_TABLE_NAME, FK_RELATED_CONFIGS

Constructor Summary

Constructors

Constructor and Description
CachedFieldConfigSchemePersister(OfBizDelegator delegator, QueryDslAccessor queryDslAccessor, ConstantsManager constantsManager, FieldConfigPersister fieldConfigPersister, FieldConfigContextPersister fieldContextPersister, FieldConfigManager fieldConfigManager, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
FieldConfigScheme	create(FieldConfigScheme configScheme, ConfigurableField field)
FieldConfigScheme	getConfigSchemeForFieldConfig(FieldConfig fieldConfig) Finds the FieldConfigScheme that contains the FieldConfig
List<FieldConfigScheme>	getConfigSchemesForCustomField(ConfigurableField field)
FieldConfigScheme	getFieldConfigScheme(Long configSchemeId)
void	init()
void	onClearCache(ClearCacheEvent event)
void	onSchemeContextUpdated(FieldConfigSchemeContextUpdated fieldConfigSchemeContextUpdated)
void	remove(Long fieldConfigSchemeId)
void	removeByIssueType(IssueType issueType) Removes FieldConfigScheme associations for the given issue type.
protected void	removeRelatedConfigsForUpdate(FieldConfigScheme configScheme, org.ofbiz.core.entity.GenericValue gv)
FieldConfigScheme	update(FieldConfigScheme configScheme)

Methods inherited from class com.atlassian.jira.issue.fields.config.persistence.FieldConfigSchemePersisterImpl

createWithDefaultValues, getConfigSchemeIdsForCustomFieldId, getInvalidFieldConfigSchemeAfterIssueTypeRemoval, invalidateAll, removeIfExist

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedFieldConfigSchemePersister

public CachedFieldConfigSchemePersister(OfBizDelegator delegator,
                                        QueryDslAccessor queryDslAccessor,
                                        ConstantsManager constantsManager,
                                        FieldConfigPersister fieldConfigPersister,
                                        FieldConfigContextPersister fieldContextPersister,
                                        FieldConfigManager fieldConfigManager,
                                        com.atlassian.cache.CacheManager cacheManager)

Method Detail

init

public void init()

Specified by:

init in interface FieldConfigSchemePersister

Overrides:

init in class FieldConfigSchemePersisterImpl

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

onSchemeContextUpdated

@EventListener
public void onSchemeContextUpdated(FieldConfigSchemeContextUpdated fieldConfigSchemeContextUpdated)

getFieldConfigScheme

@Nullable
public FieldConfigScheme getFieldConfigScheme(Long configSchemeId)

Specified by:

getFieldConfigScheme in interface FieldConfigSchemePersister

Overrides:

getFieldConfigScheme in class FieldConfigSchemePersisterImpl

getConfigSchemesForCustomField

@Nullable
public List<FieldConfigScheme> getConfigSchemesForCustomField(ConfigurableField field)

Specified by:

getConfigSchemesForCustomField in interface FieldConfigSchemePersister

Overrides:

getConfigSchemesForCustomField in class FieldConfigSchemePersisterImpl

getConfigSchemeForFieldConfig

@Nullable
public FieldConfigScheme getConfigSchemeForFieldConfig(FieldConfig fieldConfig)

Description copied from interface: FieldConfigSchemePersister

Finds the FieldConfigScheme that contains the FieldConfig

Specified by:

getConfigSchemeForFieldConfig in interface FieldConfigSchemePersister

Overrides:

getConfigSchemeForFieldConfig in class FieldConfigSchemePersisterImpl

Parameters:

fieldConfig - the config to find the containing FieldConfigScheme of; cannot be null.

Returns:

the first scheme that contains the FieldConfig. Not Null.

create

public FieldConfigScheme create(FieldConfigScheme configScheme,
                                ConfigurableField field)

Specified by:

create in interface FieldConfigSchemePersister

Overrides:

create in class FieldConfigSchemePersisterImpl

update

public FieldConfigScheme update(FieldConfigScheme configScheme)

Specified by:

update in interface FieldConfigSchemePersister

Overrides:

update in class FieldConfigSchemePersisterImpl

removeRelatedConfigsForUpdate

protected void removeRelatedConfigsForUpdate(@Nonnull
                                             FieldConfigScheme configScheme,
                                             @Nonnull
                                             org.ofbiz.core.entity.GenericValue gv)
                                      throws org.ofbiz.core.entity.GenericEntityException

Overrides:

removeRelatedConfigsForUpdate in class FieldConfigSchemePersisterImpl

Throws:

org.ofbiz.core.entity.GenericEntityException

remove

public void remove(Long fieldConfigSchemeId)

Specified by:

remove in interface FieldConfigSchemePersister

Overrides:

remove in class FieldConfigSchemePersisterImpl

removeByIssueType

public void removeByIssueType(IssueType issueType)

Description copied from interface: FieldConfigSchemePersister

Removes FieldConfigScheme associations for the given issue type. Please note that this method call on it's own is NOT safe. it removes rows from a many-to-many table without considering other entities in the many-to-many relationship. What this means is that if there's only one row left in the table, this method may remove it, and you'll end up with orphaned values. Only use this in conjunction with FieldConfigSchemePersister.getInvalidFieldConfigSchemeAfterIssueTypeRemoval(com.atlassian.jira.issue.issuetype.IssueType).

Also see FieldConfigSchemeManagerImpl.removeInvalidFieldConfigSchemesForIssueType(com.atlassian.jira.issue.issuetype.IssueType) for correct usage.

Specified by:

removeByIssueType in interface FieldConfigSchemePersister

Overrides:

removeByIssueType in class FieldConfigSchemePersisterImpl

Parameters:

issueType - the issue type to remove the associations for