com.atlassian.jira.rest.internal.v2.retranslatekeys

Class ReTranslateKeysInternalResource

java.lang.Object

com.atlassian.jira.rest.internal.v2.retranslatekeys.ReTranslateKeysInternalResource

public class ReTranslateKeysInternalResource
extends Object

Resource for testing out and applying i18n key replacements to the contents of a specified db table & column. Both Ofbiz/Jira core and ActiveObjects/Plugin tables can be targeted, although the incantations are slightly different in each case.

Since:

8.2.5

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReTranslateKeysInternalResource.BeforeAfterBean

Constructor Summary

Constructors

Constructor and Description
ReTranslateKeysInternalResource(ReTranslateKeysService reTranslateKeysService, ResponseFactory responseFactory)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	dryRunReTranslateAllKeys(String tableOrEntityName, String columnOrFieldName, String key) Returns the results of doing a "dry run" of replacing all occurrences of key with its default jira i18n translation in table & column specified by tableOrEntityName & columnOrFieldName.
javax.ws.rs.core.Response	reTranslateAllKeys(String tableOrEntityName, String columnOrFieldName, String key) Returns the results of replacing 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

ReTranslateKeysInternalResource

public ReTranslateKeysInternalResource(ReTranslateKeysService reTranslateKeysService,
                                       ResponseFactory responseFactory)

Method Detail

dryRunReTranslateAllKeys

public javax.ws.rs.core.Response dryRunReTranslateAllKeys(String tableOrEntityName,
                                                          String columnOrFieldName,
                                                          String key)

Returns the results of doing a "dry run" of replacing all occurrences of key with its default jira i18n translation in 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.

GET-ting this endpoint 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 calling POST against the same URL.

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

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

Returns:

a List of proposed translations in the form of ReTranslateKeysInternalResource.BeforeAfterBeans; empty if none are found.

See Also:

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

reTranslateAllKeys

public javax.ws.rs.core.Response reTranslateAllKeys(String tableOrEntityName,
                                                    String columnOrFieldName,
                                                    String key)

Returns the results 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.

POST-ing to this endpoint means that the transformations are applied to the database and overwrite the original text.

Clients should first call GET against this same URL 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

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

Returns:

List of carried-out translations in the form of ReTranslateKeysInternalResource.BeforeAfterBeans; empty if none are found.

See Also:

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