com.atlassian.jira.propertyset

Class CachingOfBizPropertyEntryStore

java.lang.Object

com.atlassian.jira.propertyset.CachingOfBizPropertyEntryStore

All Implemented Interfaces:

OfBizPropertyEntryStore

@ParametersAreNonnullByDefault
public class CachingOfBizPropertyEntryStore
extends Object
implements OfBizPropertyEntryStore

Caching implementation of property set entries.

Concurrency note: To minimize data inconsistency, mutative operations are (mostly) transactional. To prevent deadlocks, modifications are made to the entry first, then the value. Modifications to entries use the row count to determine whether they were successful or should be counted as overwritten. That is, any time we expect to update or delete a row, we include the type in the request. If the row does not match, then we abort that attempt.

Since:

v6.2

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.propertyset.OfBizPropertyEntryStore

OfBizPropertyEntryStore.PropertyEntry

Constructor Summary

Constructors

Constructor and Description
CachingOfBizPropertyEntryStore(QueryDslAccessor queryDslAccessor, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
protected com.atlassian.jira.propertyset.CachingOfBizPropertyEntryStore.Operation	createRemoveOperation(String entityName, long entityId, String propertyKey)
protected com.atlassian.jira.propertyset.CachingOfBizPropertyEntryStore.Operation	createSetOperation(String entityName, long entityId, String propertyKey, int type, Object value)
boolean	exists(String entityName, long entityId, String propertyKey) Queries whether or not the specified property exists
OfBizPropertyEntryStore.PropertyEntry	getEntry(String entityName, long entityId, String propertyKey) Retrieve the type and value of the specified property.
Collection<String>	getKeys(String entityName, long entityId) Retrieve all keys that are stored in the given property set.
Collection<String>	getKeys(String entityName, long entityId, int type) Retrieve all keys that are stored in the given property set and have the specified value type.
int	getType(String entityName, long entityId, String propertyKey) Queries the type of the specified property, if it exists.
void	invalidateCacheEntry(String entityName, long entityId)
void	onClearCache(ClearCacheEvent event)
void	onDatabaseImportCompleted(DatabaseImportCompletedEvent event)
void	refreshAll()
void	removeEntry(String entityName, long entityId, String propertyKey) Remove a specific property from a property set.
void	removePropertySet(String entityName, long entityId) Removes an entire property set.
void	setEntry(String entityName, long entityId, String propertyKey, int type, Object value) Stores a new value for the specified property.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingOfBizPropertyEntryStore

public CachingOfBizPropertyEntryStore(QueryDslAccessor queryDslAccessor,
                                      com.atlassian.cache.CacheManager cacheManager)

Method Detail

getKeys

@Nonnull
public Collection<String> getKeys(String entityName,
                                           long entityId)

Description copied from interface: OfBizPropertyEntryStore

Retrieve all keys that are stored in the given property set.

Specified by:

getKeys in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

Returns:

all of the keys that are stored for this property set, in no particular order

getKeys

@Nonnull
public Collection<String> getKeys(String entityName,
                                           long entityId,
                                           int type)

Description copied from interface: OfBizPropertyEntryStore

Retrieve all keys that are stored in the given property set and have the specified value type.

Specified by:

getKeys in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

type - the value type, as defined by the value constants in the PropertySet interface, that the keys must have to be returned

Returns:

all of the keys that are stored for this property set and have the given type, in no particular order

getEntry

public OfBizPropertyEntryStore.PropertyEntry getEntry(String entityName,
                                                      long entityId,
                                                      String propertyKey)

Description copied from interface: OfBizPropertyEntryStore

Retrieve the type and value of the specified property.

Specified by:

getEntry in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property to load

Returns:

the property entry, or null if the property does not exist. Note that even if it does "exist", the value can itself be null.

exists

public boolean exists(String entityName,
                      long entityId,
                      String propertyKey)

Description copied from interface: OfBizPropertyEntryStore

Queries whether or not the specified property exists

Specified by:

exists in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property to check

Returns:

whether or not the property exists

getType

public int getType(String entityName,
                   long entityId,
                   String propertyKey)

Description copied from interface: OfBizPropertyEntryStore

Queries the type of the specified property, if it exists.

Specified by:

getType in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property for which to retrieve the type

Returns:

the property set entry's type, or 0 if the property does not exist

setEntry

public void setEntry(String entityName,
                     long entityId,
                     String propertyKey,
                     int type,
                     Object value)

Description copied from interface: OfBizPropertyEntryStore

Stores a new value for the specified property.

Specified by:

setEntry in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property to store

type - the value type that is to be stored, as defined by the value constants in the PropertySet interface.

value - the value to be stored. WARNINGSpecifying null may be tolerated for specific types, but it is generally not supported and can possibly have inconsistent results. Use OfBizPropertyEntryStore.removeEntry(String, long, String), instead.

removeEntry

public void removeEntry(String entityName,
                        long entityId,
                        String propertyKey)

Description copied from interface: OfBizPropertyEntryStore

Remove a specific property from a property set.

Specified by:

removeEntry in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property to remove

createRemoveOperation

protected com.atlassian.jira.propertyset.CachingOfBizPropertyEntryStore.Operation createRemoveOperation(String entityName,
                                                                                                        long entityId,
                                                                                                        String propertyKey)

createSetOperation

protected com.atlassian.jira.propertyset.CachingOfBizPropertyEntryStore.Operation createSetOperation(String entityName,
                                                                                                     long entityId,
                                                                                                     String propertyKey,
                                                                                                     int type,
                                                                                                     Object value)

removePropertySet

public void removePropertySet(String entityName,
                              long entityId)

Removes an entire property set.

Implementation note: There is a concurrency race here if removal of the entire property set overlaps with someone else adding a new value to it or changing the type of an existing property. The worst case result is that the new value entry would get orphaned. Removing an entire property set is pretty rare, doing so concurrently with adding a new value to it should be rare squared, and as consequences go this one is pretty tolerable. As a result, this problem is deliberately ignored. Along those lines, this is not a transactional operation, either. Exceptions during value removal are caught and logged as warnings instead of propagated.

Specified by:

removePropertySet in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

invalidateCacheEntry

public void invalidateCacheEntry(String entityName,
                                 long entityId)

refreshAll

public void refreshAll()

onClearCache

@EventListener
public void onClearCache(@Nullable
                                        ClearCacheEvent event)

onDatabaseImportCompleted

@EventListener
public void onDatabaseImportCompleted(DatabaseImportCompletedEvent event)