com.atlassian.jira.retranslate

Class ReTranslateKeysServiceImpl

java.lang.Object

com.atlassian.jira.retranslate.ReTranslateKeysServiceImpl

All Implemented Interfaces:

ReTranslateKeysService

public class ReTranslateKeysServiceImpl
extends Object
implements ReTranslateKeysService

Since:

8.2.5

Constructor Summary

Constructors

Constructor and Description
ReTranslateKeysServiceImpl(ApplicationProperties appProps, I18nHelper.BeanFactory i18nFactory, OfBizDelegator ofBizDelegator, com.atlassian.event.api.EventPublisher eventPublisher, QueryDslAccessor queryDslAccessor, JiraAuthenticationContext authContext, GlobalPermissionManager globalPermissionManager)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReTranslateKeysServiceImpl

public ReTranslateKeysServiceImpl(ApplicationProperties appProps,
                                  I18nHelper.BeanFactory i18nFactory,
                                  OfBizDelegator ofBizDelegator,
                                  com.atlassian.event.api.EventPublisher eventPublisher,
                                  QueryDslAccessor queryDslAccessor,
                                  JiraAuthenticationContext authContext,
                                  GlobalPermissionManager globalPermissionManager)

Method Detail

dryRunReTranslateAllKeys

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

Description copied from interface: ReTranslateKeysService

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 ReTranslateKeysService.reTranslateAllKeys(java.lang.String, java.lang.String, java.lang.String).

Specified by:

dryRunReTranslateAllKeys in interface ReTranslateKeysService

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

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

Description copied from interface: ReTranslateKeysService

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 ReTranslateKeysService.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.

Specified by:

reTranslateAllKeys in interface ReTranslateKeysService

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