com.atlassian.jira.entity.property
Interface JsonEntityPropertyManager

All Known Implementing Classes:

JsonEntityPropertyManagerImpl

@ExperimentalApi
public interface JsonEntityPropertyManager

Low-level database API for accessing JSON entity properties.

Since:

v6.1

Method Summary

long	countByEntity(String entityName, Long entityId) Counts the number of properties that match the given entity.
long	countByEntityNameAndPropertyKey(String entityName, String key) Counts the number of properties that match the given entity name and property key.
void	delete(String entityName, Long entityId, String key) Deletes the stored value for an entity property, if it exists.
void	deleteByEntity(String entityName, Long entityId) Deletes all properties that are associated with the provided entity.
void	deleteByEntityNameAndPropertyKey(String entityName, String key) Deletes all properties that are associated with the provided entity name and property key.
List<String>	findKeys(String entityName, String keyPrefix) Produces a list of entity property keys that match the provided entity name and key prefix.
EntityProperty	get(String entityName, Long entityId, String key) Look up an entity property by the entity name, entity id, and property key.
int	getMaximumValueLength() The maximum allowed length (in characters) permitted for the String json value when calling put(String, Long, String, String).
void	put(String entityName, Long entityId, String key, String json) Set the value for an entity property, creating, updating, or deleting it as necessary.
com.atlassian.jira.entity.property.EntityPropertyQuery<?>	query() Returns a query object for finding, counting, or deleting properties with various restrictions.

Method Detail

get

@Nullable
EntityProperty get(String entityName,
                            Long entityId,
                            String key)

Look up an entity property by the entity name, entity id, and property key.

Returns:

the matching property entry, or null if the property does not exist.

put

void put(@Nonnull
         String entityName,
         @Nonnull
         Long entityId,
         @Nonnull
         String key,
         @Nullable
         String json)

Set the value for an entity property, creating, updating, or deleting it as necessary.

Parameters:

entityName - the entity name for the property (maximum length 255)

entityId - the entity ID for the property

key - the key for the property (maximum length 255)

json - the new value for the property, or null to delete it (maximum length is available by calling getMaximumValueLength())

Throws:

IllegalArgumentException - if entityName, key, or json exceeds the maximum permitted length.

delete

void delete(@Nonnull
            String entityName,
            @Nonnull
            Long entityId,
            @Nonnull
            String key)

Deletes the stored value for an entity property, if it exists.

Parameters:

entityName - the entity name for the property

entityId - the entity ID for the property

key - the key for the property

getMaximumValueLength

int getMaximumValueLength()

The maximum allowed length (in characters) permitted for the String json value when calling put(String, Long, String, String). This value is currently 32,768, but this may change in the future.

query

com.atlassian.jira.entity.property.EntityPropertyQuery<?> query()

Returns a query object for finding, counting, or deleting properties with various restrictions. See EntityPropertyQuery for usage and minimum requirements.

Returns:

the query object

findKeys

@Nonnull
List<String> findKeys(@Nonnull
                              String entityName,
                              @Nonnull
                              String keyPrefix)

Produces a list of entity property keys that match the provided entity name and key prefix. This convenience method is exactly equivalent to:

     query().entityName(entityName)
          .keyPrefix(keyPrefix)
          .findKeys()
 

Parameters:

entityName - the entity name for the entities that are associated with the properties.

keyPrefix - the prefix to apply for limiting which keys are returned; must not be null or a blank string

Returns:

the list of distinct matching keys, sorted in ascending alphabetical order

Throws:

IllegalArgumentException - if either entityName or keyPrefix is null or blank

countByEntity

long countByEntity(@Nonnull
                   String entityName,
                   @Nonnull
                   Long entityId)

Counts the number of properties that match the given entity. This convenience method is exactly equivalent to:

     query().entityName(entityName)
          .entityId(entityId)
          .count()
 

Parameters:

entityName - the entity name of the owning entity

entityId - the entity ID of the owning entity

Returns:

the count of properties assigned to that entity

Throws:

IllegalArgumentException - if either entityName is null or blank or entityId is null.

countByEntityNameAndPropertyKey

long countByEntityNameAndPropertyKey(@Nonnull
                                     String entityName,
                                     @Nonnull
                                     String key)

Counts the number of properties that match the given entity name and property key. This convenience method is exactly equivalent to:

     query().entityName(entityName)
          .key(key)
          .count()
 

Parameters:

entityName - the entity name of the owning entities

key - the property key to look for

Returns:

the count of properties with that key which are assigned to entities with the given name

Throws:

IllegalArgumentException - if either entityName or key is null or blank

deleteByEntity

void deleteByEntity(@Nonnull
                    String entityName,
                    @Nonnull
                    Long entityId)

Deletes all properties that are associated with the provided entity. This convenience method is exactly equivalent to:

     query().entityName(entityName)
          .entityId(entityId)
          .delete()
 

Parameters:

entityName - the entity name for the properties

entityId - the entity ID for the properties

deleteByEntityNameAndPropertyKey

void deleteByEntityNameAndPropertyKey(@Nonnull
                                      String entityName,
                                      @Nonnull
                                      String key)

Deletes all properties that are associated with the provided entity name and property key. This convenience method is exactly equivalent to:

     query().entityName(entityName)
          .key(key)
          .delete()
 

Parameters:

entityName - the entity name for the properties

key - the property key for the properties