Package org.opencms.ai

Class CmsDeeplTranslation

java.lang.Object

org.opencms.ai.CmsDeeplTranslation

All Implemented Interfaces:

I_CmsContentTranslator, I_CmsConfigurationParameterHandler

public class CmsDeeplTranslation
extends Object
implements I_CmsContentTranslator

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Object	PARAM_TARGET_LOCALE_MAPPING	Configuration parameter for determining a target locale mapping.
static final String	SECRET_API_KEY	Key used for looking up the API key in the secret store.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsDeeplTranslation()

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
I_CmsXmlContentAugmentation	getContentAugmentation()	Returns a fresh content augmentation object for doing the actual translation work.
static com.deepl.api.Language	getMatchingLanguage(Locale locale, List<com.deepl.api.Language> languages)	Tries to find a suitable Language object from a list of DeepL-supported languages that matches a given locale.
protected Map<Locale,Locale>	getTargetLocaleMapping()	Gets (and lazily creates if necessary) the target locale mapping.
void	initConfiguration()	Initializes a configuration after all parameters have been added.
void	initialize(CmsObject cms)	Initializes the content translator with an admin CmsObject.
boolean	isEnabled(CmsObject cms, CmsADEConfigData config, CmsFile file)	Checks if the translation should be enabled for the current context.

Methods inherited from class java.lang.Object

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

Field Details

SECRET_API_KEY

public static final String SECRET_API_KEY

Key used for looking up the API key in the secret store.

See Also:

• Constant Field Values

PARAM_TARGET_LOCALE_MAPPING

protected static final Object PARAM_TARGET_LOCALE_MAPPING

Configuration parameter for determining a target locale mapping.

Constructor Details

CmsDeeplTranslation

public CmsDeeplTranslation()

Method Details

getMatchingLanguage

public static com.deepl.api.Language getMatchingLanguage(Locale locale,
 List<com.deepl.api.Language> languages)

Tries to find a suitable Language object from a list of DeepL-supported languages that matches a given locale.

Parameters:

locale - the locale

languages - the languages

Returns:

the matching language

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getContentAugmentation

public I_CmsXmlContentAugmentation getContentAugmentation()

Description copied from interface: I_CmsContentTranslator

Returns a fresh content augmentation object for doing the actual translation work.

Specified by:

getContentAugmentation in interface I_CmsContentTranslator

Returns:

the content augmentation object

See Also:

• I_CmsContentTranslator.getContentAugmentation()

initConfiguration

public void initConfiguration()
                       throws CmsConfigurationException

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

Throws:

CmsConfigurationException - if something goes wrong

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize(CmsObject cms)

Description copied from interface: I_CmsContentTranslator

Initializes the content translator with an admin CmsObject.

If the translator is already initialized, this should do nothing.

Specified by:

initialize in interface I_CmsContentTranslator

Parameters:

cms - an admin CmsObject

isEnabled

public boolean isEnabled(CmsObject cms,
 CmsADEConfigData config,
 CmsFile file)

Description copied from interface: I_CmsContentTranslator

Checks if the translation should be enabled for the current context.

Specified by:

isEnabled in interface I_CmsContentTranslator

Parameters:

cms - the CMS context

config - the currently active ADE configuration

file - the edited file

Returns:

true if the translation should be enabled

See Also:

• I_CmsContentTranslator.isEnabled(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData, org.opencms.file.CmsFile)

getTargetLocaleMapping

protected Map<Locale,Locale> getTargetLocaleMapping()

Gets (and lazily creates if necessary) the target locale mapping.

DeepL API only lists en-US / en-GB for English, and pt-BR / pt-PT for Portuguese as target languages. Using just en or pt might work, but it's probably a good idea to be specific, So if just en or pt is specified, we map it to the variant that's more widely used by default.

This can be overriden by the configuration parameter targetLocaleMapping, which has the form l1:r1|l2:r2|..., where the li is the locale to map, and the ri is the locale to map to.

Returns: