Package com.flowable.platform.engine.impl.configuration

Class ConfigurationServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<PlatformEngineConfiguration>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<PlatformEngineConfiguration>

com.flowable.platform.engine.impl.configuration.ConfigurationServiceImpl

All Implemented Interfaces:

ConfigurationService

public class ConfigurationServiceImpl
extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<PlatformEngineConfiguration>
implements ConfigurationService

Author:

Filip Hrisafov

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor	Description
ConfigurationServiceImpl(PlatformEngineConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
ConfigurationPropertyBuilder	createConfigurationPropertyBuilder(String namespace, String name)	Create a builder for a configuration property.
ConfigurationPropertyQuery	createConfigurationPropertyQuery()	Create a query for configuration properties
DataTableFavoriteConfigurationBuilder	createDataTableFavoriteConfigurationBuilder(String favoriteKey)	Create a data table favorite configuration builder with the given favorite key.
DataTableFavoriteConfigurationQuery	createDataTableFavoriteConfigurationQuery()	Create a query for querying data table configurations.
SecretBuilder	createSecretBuilder(String secretName)	Create a secret builder for the secret with the given name
SecretQuery	createSecretQuery()	Create a query for querying secrets
SystemConfigurationBuilder	createSystemConfigurationBuilder(String type)	Create a system configuration builder with the given type.
SystemConfigurationQuery	createSystemConfigurationQuery()	Create a query for querying system configuration.
ThemeBuilder	createThemeBuilder(String themeName)	Create a theme builder for theme with the given name
ThemeQuery	createThemeQuery()	Create a query for querying themes
ConfigurationPropertyBuilder	createUpdateConfigurationPropertyBuilder(String configurationId)	Create an update builder for a configuration property.
DataTableFavoriteConfigurationBuilder	createUpdateDataTableFavoriteConfigurationBuilder(String favoriteKey, String configurationId)	Create an update data table favorite configuration builder with the given key and configuration id.
SystemConfigurationBuilder	createUpdateSystemConfigurationBuilder(String configurationId)	Create an update system configuration builder with the given configuration id
void	deleteConfigurationProperty(String configurationId)	Delete the configuration property with the given id.
void	deleteDataTableFavoriteConfiguration(String configurationId)	Delete the favorite with the given id.
void	deleteSecret(String secretId)	Delete the secret with the given id.
void	deleteSecretByNameAndTenant(String secretName, String tenantId)	Delete the secret with the given name in the given tenant.
void	deleteSystemConfiguration(String configurationId)	Delete the system configuration with the given id.
void	deleteTheme(String themeId)	Delete the theme with the given id.
String	getDefaultThemeName(String tenantId)	Get the default theme name for the given tenant
Map<String,String>	getLanguages()	The Locale mapping from browser Locale key to the key that should be used for Work and the Form engine
void	setDefaultThemeName(String themeName, String tenantId)	Set the default theme name for the given tenant
void	setOwner(String configurationId, String userId)	Add an identity link of the given type between the configuration with the given id and the user.

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationServiceImpl

public ConfigurationServiceImpl(PlatformEngineConfiguration configuration)

Method Details

getLanguages

public Map<String,String> getLanguages()

Description copied from interface: ConfigurationService

The Locale mapping from browser Locale key to the key that should be used for Work and the Form engine

Specified by:

getLanguages in interface ConfigurationService

createThemeQuery

public ThemeQuery createThemeQuery()

Description copied from interface: ConfigurationService

Create a query for querying themes

Specified by:

createThemeQuery in interface ConfigurationService

createThemeBuilder

public ThemeBuilder createThemeBuilder(String themeName)

Description copied from interface: ConfigurationService

Create a theme builder for theme with the given name

Specified by:

createThemeBuilder in interface ConfigurationService

Parameters:

themeName - the name of the theme

deleteTheme

public void deleteTheme(String themeId)

Description copied from interface: ConfigurationService

Delete the theme with the given id.

Specified by:

deleteTheme in interface ConfigurationService

Parameters:

themeId - the id of the theme that should be deleted

setDefaultThemeName

public void setDefaultThemeName(String themeName,
 String tenantId)

Description copied from interface: ConfigurationService

Set the default theme name for the given tenant

Specified by:

setDefaultThemeName in interface ConfigurationService

Parameters:

themeName - the name of the default theme

tenantId - the id of the tenant

getDefaultThemeName

public String getDefaultThemeName(String tenantId)

Description copied from interface: ConfigurationService

Get the default theme name for the given tenant

Specified by:

getDefaultThemeName in interface ConfigurationService

Parameters:

tenantId - the id of the tenant

Returns:

the name of the default theme

createDataTableFavoriteConfigurationQuery

public DataTableFavoriteConfigurationQuery createDataTableFavoriteConfigurationQuery()

Description copied from interface: ConfigurationService

Create a query for querying data table configurations.

Specified by:

createDataTableFavoriteConfigurationQuery in interface ConfigurationService

createDataTableFavoriteConfigurationBuilder

public DataTableFavoriteConfigurationBuilder createDataTableFavoriteConfigurationBuilder(String favoriteKey)

Description copied from interface: ConfigurationService

Create a data table favorite configuration builder with the given favorite key.

Specified by:

createDataTableFavoriteConfigurationBuilder in interface ConfigurationService

Parameters:

favoriteKey - the key of the favorite

createUpdateDataTableFavoriteConfigurationBuilder

public DataTableFavoriteConfigurationBuilder createUpdateDataTableFavoriteConfigurationBuilder(String favoriteKey,
 String configurationId)

Description copied from interface: ConfigurationService

Create an update data table favorite configuration builder with the given key and configuration id.

Specified by:

createUpdateDataTableFavoriteConfigurationBuilder in interface ConfigurationService

Parameters:

favoriteKey - the key of the configuration

configurationId - the id of the configuration

deleteDataTableFavoriteConfiguration

public void deleteDataTableFavoriteConfiguration(String configurationId)

Description copied from interface: ConfigurationService

Delete the favorite with the given id.

Specified by:

deleteDataTableFavoriteConfiguration in interface ConfigurationService

Parameters:

configurationId - the id of the favorite that should be deleted

createSecretQuery

public SecretQuery createSecretQuery()

Description copied from interface: ConfigurationService

Create a query for querying secrets

Specified by:

createSecretQuery in interface ConfigurationService

createSecretBuilder

public SecretBuilder createSecretBuilder(String secretName)

Description copied from interface: ConfigurationService

Create a secret builder for the secret with the given name

Specified by:

createSecretBuilder in interface ConfigurationService

Parameters:

secretName - the name of the secret

deleteSecret

public void deleteSecret(String secretId)

Description copied from interface: ConfigurationService

Delete the secret with the given id.

Specified by:

deleteSecret in interface ConfigurationService

Parameters:

secretId - the id of the secret that should be deleted

deleteSecretByNameAndTenant

public void deleteSecretByNameAndTenant(String secretName,
 String tenantId)

Description copied from interface: ConfigurationService

Delete the secret with the given name in the given tenant.

Specified by:

deleteSecretByNameAndTenant in interface ConfigurationService

Parameters:

secretName - the name of the secret that should be deleted

tenantId - the id of the tenant in which the secret exists

createSystemConfigurationQuery

public SystemConfigurationQuery createSystemConfigurationQuery()

Description copied from interface: ConfigurationService

Create a query for querying system configuration.

Specified by:

createSystemConfigurationQuery in interface ConfigurationService

createSystemConfigurationBuilder

public SystemConfigurationBuilder createSystemConfigurationBuilder(String type)

Description copied from interface: ConfigurationService

Create a system configuration builder with the given type.

Specified by:

createSystemConfigurationBuilder in interface ConfigurationService

Parameters:

type - the type of the system configuration

createUpdateSystemConfigurationBuilder

public SystemConfigurationBuilder createUpdateSystemConfigurationBuilder(String configurationId)

Description copied from interface: ConfigurationService

Create an update system configuration builder with the given configuration id

Specified by:

createUpdateSystemConfigurationBuilder in interface ConfigurationService

Parameters:

configurationId - the id of the configuration

deleteSystemConfiguration

public void deleteSystemConfiguration(String configurationId)

Description copied from interface: ConfigurationService

Delete the system configuration with the given id.

Specified by:

deleteSystemConfiguration in interface ConfigurationService

Parameters:

configurationId - the id of the system configuration that should be deleted

createConfigurationPropertyQuery

public ConfigurationPropertyQuery createConfigurationPropertyQuery()

Description copied from interface: ConfigurationService

Create a query for configuration properties

Specified by:

createConfigurationPropertyQuery in interface ConfigurationService

createConfigurationPropertyBuilder

public ConfigurationPropertyBuilder createConfigurationPropertyBuilder(String namespace,
 String name)

Description copied from interface: ConfigurationService

Create a builder for a configuration property. Using this builder will always create a new property.

Specified by:

createConfigurationPropertyBuilder in interface ConfigurationService

Parameters:

namespace - the mandatory namespace for the configuration

name - the mandatory name for the configuration

createUpdateConfigurationPropertyBuilder

public ConfigurationPropertyBuilder createUpdateConfigurationPropertyBuilder(String configurationId)

Description copied from interface: ConfigurationService

Create an update builder for a configuration property. Using this builder will always update the configuration property for the given id.

Specified by:

createUpdateConfigurationPropertyBuilder in interface ConfigurationService

Parameters:

configurationId - the id of the configuration that should be updated

deleteConfigurationProperty

public void deleteConfigurationProperty(String configurationId)

Description copied from interface: ConfigurationService

Delete the configuration property with the given id.

Specified by:

deleteConfigurationProperty in interface ConfigurationService

setOwner

public void setOwner(String configurationId,
 String userId)

Description copied from interface: ConfigurationService

Add an identity link of the given type between the configuration with the given id and the user.

Specified by:

setOwner in interface ConfigurationService

Parameters:

configurationId - the id of the configuration

userId - the id of the user