public interface

GenericConfigManager

com.atlassian.jira.issue.customfields.manager.GenericConfigManager
Known Indirect Subclasses

Class Overview

Used to store Generic configuration values (mostly default values for certain fields). Implementations should aim to manage any plain java object. Two implementations of this interface exist in JIRA: An in memory cache (CachedGenericConfigManager) and an implementation responsible for storing the config values in the DB (DefaultGenericConfigManager). For DB persistence, objects are serialized to XML.

Summary

Constants
String ENTITY_DATA_KEY
String ENTITY_DATA_TYPE
String ENTITY_ID
String ENTITY_TABLE_NAME
String ENTITY_XML_VALUE
Public Methods
void create(String dataType, String key, Object obj)
Stores a new entry for the config manager.
void remove(String dataType, String key)
Removes a generic config value.
Object retrieve(String dataType, String key)
Retrieves a particular entry.
void update(String dataType, String key, Object obj)
Updates an entry.

Constants

public static final String ENTITY_DATA_KEY

Constant Value: "datakey"

public static final String ENTITY_DATA_TYPE

Constant Value: "datatype"

public static final String ENTITY_ID

Constant Value: "id"

public static final String ENTITY_TABLE_NAME

Constant Value: "GenericConfiguration"

public static final String ENTITY_XML_VALUE

Constant Value: "xmlvalue"

Public Methods

public void create (String dataType, String key, Object obj)

Stores a new entry for the config manager. For example a customfield may have a default value.

Parameters
dataType The datatype for which to store the generic config (e.g.: DefaultValue)
key A key that identifies the element (e.g.: 10000)
obj The actual object to store.

public void remove (String dataType, String key)

Removes a generic config value.

Parameters
dataType The datatype for which to store the generic config (e.g.: DefaultValue)
key A key that identifies the element (e.g.: 10000)

public Object retrieve (String dataType, String key)

Retrieves a particular entry.

Parameters
dataType The datatype for which to store the generic config (e.g.: DefaultValue)
key A key that identifies the element (e.g.: 10000)
Returns
  • The entry, or null if it doesn't exist.

public void update (String dataType, String key, Object obj)

Updates an entry.

Parameters
dataType The datatype for which to store the generic config (e.g.: DefaultValue)
key A key that identifies the element (e.g.: 10000)
obj The actual object to store.