com.atlassian.jira.retranslate

Interface ReTranslateKeysService

All Known Implementing Classes:

ReTranslateKeysServiceImpl

public interface ReTranslateKeysService

Utility for helping fix un-translated i18n keys that have unintentionally made their way into the database. This service provides a way to overwrite occurrences of i18n keys with the default Jira language translation of them in a given table & column. It also lets you check what replacements will be made before actually writing them to the database (see dryRunReTranslateAllKeys(java.lang.String, java.lang.String, java.lang.String)).

Since:

8.2.5

See Also:

"JRASERVER-69388" and DELTA-859 for more context

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<List<Pair<String,String>>>	dryRunReTranslateAllKeys(String tableOrEntityName, String columnOrFieldName, String keyName) Does a "dry run" of replacing all occurrences of key with its default jira i18n translation in the table & column specified by tableOrEntityName & columnOrFieldName.
ServiceOutcome<List<Pair<String,String>>>	reTranslateAllKeys(String tableOrEntityName, String columnOrFieldName, String keyName) Replaces all occurrences of key with its default jira i18n translation in the table & column specified by tableOrEntityName & columnOrFieldName.

Method Detail

dryRunReTranslateAllKeys

ServiceOutcome<List<Pair<String,String>>> dryRunReTranslateAllKeys(String tableOrEntityName,
                                                                   String columnOrFieldName,
                                                                   String keyName)

Does a "dry run" of replacing all occurrences of key with its default jira i18n translation in the table & column specified by tableOrEntityName & columnOrFieldName. Table & column apply to AO tables; if tableOrEntityName starts with "AO_", then the assumption is that plugin tables are being targeted. Otherwise, we assume that Jira table is the intended target, and the first two parameters are interpreted as entityname and fieldname. These are OfBiz constructs that differ from raw table & column names--for a full inventory of them, see Jira's entitymodel.xml file.

This method has no side-effects. Values are read directly from the database, but nothing is written out to it.

This method is a way of previewing the results of a key-translation operation before actually applying it via reTranslateAllKeys(java.lang.String, java.lang.String, java.lang.String).

Parameters:

tableOrEntityName - Either a plugins "AO_" style table name or a jira OfBiz-style entity name to check for translations

columnOrFieldName - Either the name of a column from an AO-based table or an OfBiz-style field-name

keyName - an i18n key that will be replaced with its default jira i18n translation

Returns:

A ServiceOutcome that contains a List of proposed translations OR the reasons for the call's failure.

See Also:

"entitymodel.xml" for a full listing of Jira entity & field names

reTranslateAllKeys

ServiceOutcome<List<Pair<String,String>>> reTranslateAllKeys(String tableOrEntityName,
                                                             String columnOrFieldName,
                                                             String keyName)

Replaces all occurrences of key with its default jira i18n translation in the table & column specified by tableOrEntityName & columnOrFieldName. Table & column apply to AO tables; if tableOrEntityName starts with "AO_", then the assumption is that plugin tables are being targeted. Otherwise, we assume that Jira table is the intended target, and the first two parameters are interpreted as entityname and fieldname. These are OfBiz constructs that differ from raw table & column names--for a full inventory of them, see Jira's entitymodel.xml file.

These transformations are applied to the database and overwrite the original text.

Clients should call dryRunReTranslateAllKeys(java.lang.String, java.lang.String, java.lang.String) first to check the expected translations without actually writing them out to the db.

Note: When updating an AO table, a restart of either the affected plugins or all of Jira may be required in order for the changes to propagate from the database up into the plugins' caches.

Parameters:

tableOrEntityName - Either a plugins "AO_" style table name or a jira OfBiz-style entity name to check for translations

columnOrFieldName - Either the name of a column from an AO-based table or an OfBiz-style field-name

keyName - an i18n key that will be replaced with its default jira i18n translation

Returns:

A ServiceOutcome that contains a List of the translations carried out in the db OR the reasons for the call's failure.

See Also:

"entitymodel.xml" for a full listing of Jira entity & field names