com.sap.pdms.commons.config.variants

Class ConfigurationMigrationApi

java.lang.Object

com.sap.pdms.commons.config.variants.ConfigurationMigrationApi

public class ConfigurationMigrationApi
extends Object

This API replaces the deprecated ConfigurationApi and shall be used by all iPros. Internally, the deprecated ConfigurationAPI is mapped to the VariantAPI and data is stored in the new format.

Constructor Summary

Constructors

Constructor and Description
ConfigurationMigrationApi() Creates a new instance of ConfigurationApi.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createConfiguration(String payload, String configId) Creates the configuration for a given configurationId.
javax.ws.rs.core.Response	createConfigurations(String payload) Creates all the configurations.
javax.ws.rs.core.Response	deleteAllConfigurations() Deletes all the configurations.
javax.ws.rs.core.Response	deleteConfigurationForID(String configId) Deletes the configuration for a given configurationId.
javax.ws.rs.core.Response	deleteFrontendConfigForId(String configId) Deletes the common configuration for a given configurationId.
javax.ws.rs.core.Response	deleteTextInterpretationsForConfigId(String configId) Deletes the text-interpretations for all languages for a given configurationId.
javax.ws.rs.core.Response	deleteTextInterpretationsForConfigIdandLangId(String configId, String langId) Deletes all the text interpretations for a given configurationId and language.
javax.ws.rs.core.Response	deleteTextInterpretationsForConfigIdandLangIDandKey(String configId, String langId, String key) Deletes the text value for a given configurationId,language and key.
javax.ws.rs.core.Response	fetchConfigurations() Fetches all the configurations.
javax.ws.rs.core.Response	fetchConfigurationWithId(String configId, String acceptLanguage, String sapRequestLanguage, String locale) Fetches the configuration for a given configurationId.
javax.ws.rs.core.Response	getFrontendConfigForId(String configId) Fetches the common configuration for a given configurationId.
javax.ws.rs.core.Response	getTextInterpretationsForConfigId(String configId, String acceptLanguage, String sapRequestLanguage, String locale) Fetches text-interpretations for a given configurationId.
javax.ws.rs.core.Response	getTextInterpretationsForConfigIdandLangId(String configId, String langId) Fetches all the text-interpretations for a given configurationId and language.
javax.ws.rs.core.Response	getTextInterpretationsForConfigIdandLangIDandKey(String configId, String langId, String key) Fetch text value for a given configurationId,language and key.
javax.ws.rs.core.Response	updateConfiguration(String payload) Updates all the configurations.
javax.ws.rs.core.Response	updateKeysForConfigIdandLangId(String configId, String langId, String payload) Updates the key-text interpretations for a given configurationId and language.
javax.ws.rs.core.Response	updateTextInterpretationsForConfigIdandLangIDandKey(String configId, String langId, String key, String payload) Updates the text value for a given configurationId,language and key.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationMigrationApi

public ConfigurationMigrationApi()

Creates a new instance of ConfigurationApi.

Method Detail

fetchConfigurations

public javax.ws.rs.core.Response fetchConfigurations()
                                              throws PdmsBackendException

Fetches all the configurations. A configuration object contains two key fields, common-config and i18N. The former is the common configuration object. A common configuration object contains all the information required for an application to be fully functional. eg : zoom level,latitude and longitude information for a map application. I18N is a JsonArray which contains all text-interpretations for different languages.

Returns:

the array which holds all the configurations as a string.

Throws:

PdmsBackendException - if there is an error while fetching the configurations

updateConfiguration

public javax.ws.rs.core.Response updateConfiguration(String payload)
                                              throws PdmsBackendException

Updates all the configurations.

Parameters:

payload - the jsonArray which holds configuration(s) in string format.

Returns:

the standard Ok response based on the outcome of update operation.

Throws:

PdmsBackendException - if there is an error while updating the configurations

createConfigurations

public javax.ws.rs.core.Response createConfigurations(String payload)
                                               throws PdmsBackendException

Creates all the configurations.

Parameters:

payload - the jsonArray which holds configuration(s) in string format.

Returns:

the standard Ok response based on the outcome of create operation.

Throws:

PdmsBackendException - if there is an error while creating the configurations

deleteAllConfigurations

public javax.ws.rs.core.Response deleteAllConfigurations()
                                                  throws PdmsBackendException

Deletes all the configurations.

Returns:

the standard Ok response based on the outcome of deletion.

Throws:

PdmsBackendException - if there is an error while deleting the configurations

fetchConfigurationWithId

public javax.ws.rs.core.Response fetchConfigurationWithId(String configId,
                                                          @HeaderParam(value="accept-language")
                                                          String acceptLanguage,
                                                          String sapRequestLanguage,
                                                          String locale)
                                                   throws PdmsBackendException

Fetches the configuration for a given configurationId. the configuration includes common configuration object and text-interpretations.

Parameters:

configId - the unique configurationId per application.

acceptLanguage - the accept-language header of the HTTP request

sapRequestLanguage - the x-sap-request-language query parameter

locale - the locale query parameter

Returns:

the jsonObject which holds the configuration.

Throws:

PdmsBackendException - if there is an error while fetching the configurations

createConfiguration

public javax.ws.rs.core.Response createConfiguration(String payload,
                                                     String configId)
                                              throws PdmsBackendException

Creates the configuration for a given configurationId.

Parameters:

payload - the configurationObject that is to be created.

configId - the unique configurationId per application.

Returns:

the standard Ok response based on the outcome of update operation.

Throws:

PdmsBackendException - if there is an error while creating the configuration

deleteConfigurationForID

public javax.ws.rs.core.Response deleteConfigurationForID(String configId)
                                                   throws PdmsBackendException

Deletes the configuration for a given configurationId.

Parameters:

configId - the unique configurationId per application.

Returns:

the standard Ok response based on the outcome of deletion.

Throws:

PdmsBackendException - if there is an error while deleting the configuration

getTextInterpretationsForConfigId

public javax.ws.rs.core.Response getTextInterpretationsForConfigId(String configId,
                                                                   @HeaderParam(value="accept-language")
                                                                   String acceptLanguage,
                                                                   String sapRequestLanguage,
                                                                   String locale)
                                                            throws PdmsBackendException

Fetches text-interpretations for a given configurationId.

Parameters:

configId - the unique configurationId per application.

acceptLanguage - the accept-language header value of the HTTP request

sapRequestLanguage - the x-sap-request-language query parameter

locale - the locale query parameter

Returns:

the jsonObject which contains the text-interpretations

Throws:

PdmsBackendException - if there is an error while fetching the configuration

deleteTextInterpretationsForConfigId

public javax.ws.rs.core.Response deleteTextInterpretationsForConfigId(String configId)
                                                               throws PdmsBackendException

Deletes the text-interpretations for all languages for a given configurationId.

Parameters:

configId - the unique configurationId per application.

Returns:

the standard Ok response based on the outcome of deletion.

Throws:

PdmsBackendException - if there is an error while deleting the configuration

getTextInterpretationsForConfigIdandLangId

public javax.ws.rs.core.Response getTextInterpretationsForConfigIdandLangId(String configId,
                                                                            String langId)
                                                                     throws PdmsBackendException

Fetches all the text-interpretations for a given configurationId and language.

Parameters:

configId - the unique configurationId per application.

langId - the language identifier.

Returns:

the JsonObject which holds the text-interpretation mapping.

Throws:

PdmsBackendException - if there is an error while fetching the configuration

updateKeysForConfigIdandLangId

public javax.ws.rs.core.Response updateKeysForConfigIdandLangId(String configId,
                                                                String langId,
                                                                String payload)
                                                         throws PdmsBackendException

Updates the key-text interpretations for a given configurationId and language.

Parameters:

configId - the unique configurationId per application.

langId - the language identifier.

payload - the string which contains all the key-text values to be updated.

Returns:

the jsonObject which contains all the updated key-text values.

Throws:

PdmsBackendException - if there is an error while creating the configuration

deleteTextInterpretationsForConfigIdandLangId

public javax.ws.rs.core.Response deleteTextInterpretationsForConfigIdandLangId(String configId,
                                                                               String langId)
                                                                        throws PdmsBackendException

Deletes all the text interpretations for a given configurationId and language.

Parameters:

configId - the unique configurationId per application.

langId - the language identifier.

Returns:

the standard Ok response based on the outcome of deletion.

Throws:

PdmsBackendException - if there is an error while deleting the configuration

getTextInterpretationsForConfigIdandLangIDandKey

public javax.ws.rs.core.Response getTextInterpretationsForConfigIdandLangIDandKey(String configId,
                                                                                  String langId,
                                                                                  String key)
                                                                           throws PdmsBackendException

Fetch text value for a given configurationId,language and key.

Parameters:

configId - the unique configurationId per application.

langId - the language identifier.

key - the label identifier for the text in text-interpretations.

Returns:

the jsonObject which holds text for given configId,language and key.

Throws:

PdmsBackendException - if there is an error while fetching the configuration

updateTextInterpretationsForConfigIdandLangIDandKey

public javax.ws.rs.core.Response updateTextInterpretationsForConfigIdandLangIDandKey(String configId,
                                                                                     String langId,
                                                                                     String key,
                                                                                     String payload)
                                                                              throws PdmsBackendException

Updates the text value for a given configurationId,language and key.

Parameters:

configId - the unique configurationId per application.

langId - the language identifier.

key - the label identifier for the text in text-interpretations.

payload - the string which holds the key-text value to be updated.

Returns:

the jsonObject with key-text value.

Throws:

PdmsBackendException - if there is an error while creating the configuration

deleteTextInterpretationsForConfigIdandLangIDandKey

public javax.ws.rs.core.Response deleteTextInterpretationsForConfigIdandLangIDandKey(String configId,
                                                                                     String langId,
                                                                                     String key)
                                                                              throws PdmsBackendException

Deletes the text value for a given configurationId,language and key.

Parameters:

configId - the unique configurationId per application.

langId - the language identifier.

key - the label identifier for the text in text-interpretations.

Returns:

the standard Ok response based on the outcome of deletion.

Throws:

PdmsBackendException - if there is an error while deleting the configuration

getFrontendConfigForId

public javax.ws.rs.core.Response getFrontendConfigForId(String configId)
                                                 throws PdmsBackendException

Fetches the common configuration for a given configurationId. A common configuration object contains all the information required for an application to be fully functional. eg : zoom level,latitude and longitude information for a map application.

Parameters:

configId - the unique configurationId per application.

Returns:

the common configuration.

Throws:

PdmsBackendException - if there is an error while fetching the configuration

deleteFrontendConfigForId

public javax.ws.rs.core.Response deleteFrontendConfigForId(String configId)
                                                    throws PdmsBackendException

Deletes the common configuration for a given configurationId. A common configuration object contains all the information required for an application to be fully functional. eg : zoom level,latitude and longitude information for a map application.

Parameters:

configId - the unique configurationId per application.

Returns:

the common configuration deleted.

Throws:

PdmsBackendException - if there is an error while deleting the configuration