Package com.atlassian.jira.issue.fields.usage

Class CustomFieldUsageDataService

java.lang.Object

com.atlassian.jira.issue.fields.usage.CustomFieldUsageDataService

public class CustomFieldUsageDataService
extends Object

Calculating usage data for custom fields:

• `Last value update`: the last date when custom field's value was set or changed
• `Issues`: number of issues in which custom field is set to a non default value

The values are being calculated by background operations that can be disabled with JiraFeatureFlagRegistrar.CUSTOMFIELDS_IDENTIFICATION feature flag. Once calculated, the values are being stored with the custom field. since 8.16

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomFieldUsageDataService.LockNotAcquiredException

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CF_USAGE_CLUSTER_LOCK_NAME
static final int	DEFAULT_DATA_COLLECTION_QUERY_MAX_IDS
static final Set<String>	DEFAULT_TRUSTED_CUSTOM_FIELD_TYPE_KEYS	As custom fields don't store their values in one single standardized way we divided them into two groups: trusted and untrusted custom fields.

Constructor Summary

Constructors

Constructor	Description
CustomFieldUsageDataService(CustomFieldManager customFieldManager, CustomFieldUsageDAO dao, CustomFieldUsageDataWriter lastUpdateDataWriter, ApplicationProperties applicationProperties, CustomFieldUsageEnabledCheck featureEnabledCheck, com.atlassian.beehive.ClusterLockService clusterLockService, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
Set<String>	getTrustedKeys()
void	onPluginFrameworkShutdownEvent(com.atlassian.plugin.event.events.PluginFrameworkShutdownEvent event)
void	updateLastValueUpdateForCustomFields(Set<Long> customFieldsId)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TRUSTED_CUSTOM_FIELD_TYPE_KEYS

public static final Set<String> DEFAULT_TRUSTED_CUSTOM_FIELD_TYPE_KEYS

As custom fields don't store their values in one single standardized way we divided them into two groups: trusted and untrusted custom fields. Trusted custom fields are fields for which we can track their usage with 100% accuracy. For untrusted custom fields we collect usage information, but the data might be not complete.

DEFAULT_DATA_COLLECTION_QUERY_MAX_IDS

public static final int DEFAULT_DATA_COLLECTION_QUERY_MAX_IDS

See Also:

• Constant Field Values

CF_USAGE_CLUSTER_LOCK_NAME

public static final String CF_USAGE_CLUSTER_LOCK_NAME

Constructor Details

CustomFieldUsageDataService

public CustomFieldUsageDataService(CustomFieldManager customFieldManager,
 CustomFieldUsageDAO dao,
 CustomFieldUsageDataWriter lastUpdateDataWriter,
 ApplicationProperties applicationProperties,
 CustomFieldUsageEnabledCheck featureEnabledCheck,
 com.atlassian.beehive.ClusterLockService clusterLockService,
 com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

updateLastValueUpdateForCustomFields

public void updateLastValueUpdateForCustomFields(Set<Long> customFieldsId)

getTrustedKeys

public Set<String> getTrustedKeys()

Returns:

a set of keys of trusted custom fields

onPluginFrameworkShutdownEvent

@EventListener
public void onPluginFrameworkShutdownEvent(com.atlassian.plugin.event.events.PluginFrameworkShutdownEvent event)