Package org.craftercms.studio.impl.v2.service.configuration

Class ConfigurationServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.configuration.ConfigurationServiceImpl

All Implemented Interfaces:

ConfigurationService

public class ConfigurationServiceImpl
extends Object
implements ConfigurationService

Constructor Summary

Constructors

Constructor	Description
ConfigurationServiceImpl()

Method Summary

Modifier and Type	Method	Description
String	getCacheKey(String siteId, String module, String path, String environment, String suffix)	Builds the key for a given file
org.dom4j.Document	getConfigurationAsDocument(String siteId, String module, String path, String environment)	Get configuration as DOM document for given parameters
String	getConfigurationAsString(String siteId, String module, String path, String environment)	Get configuration as string for given parameters
ConfigurationHistory	getConfigurationHistory(String siteId, String module, String path, String environment)	Get configuration history for given parameters
org.dom4j.Document	getGlobalConfigurationAsDocument(String path)	Get configuration from global repository as Document
String	getGlobalConfigurationAsString(String path)	Get configuration from global repository as String
Map<NormalizedGroup,List<NormalizedRole>>	getGlobalRoleMappings()	Get global role mappings configuration
org.apache.commons.configuration2.HierarchicalConfiguration<?>	getGlobalXmlConfiguration(String path)	Reads a configuration file using Apache Commons Configuration
org.springframework.core.io.Resource	getPluginFile(String siteId, String pluginId, String type, String name, String filename)	Get a file from a plugin
Map<NormalizedGroup,List<NormalizedRole>>	getRoleMappings(String siteId)	Get role mappings configuration for given site
TranslationConfiguration	getTranslationConfiguration(String siteId)	Get the translation configuration for a given site
org.apache.commons.configuration2.HierarchicalConfiguration<?>	getXmlConfiguration(String siteId, String path)	Reads a configuration file using Apache Commons Configuration
org.apache.commons.configuration2.HierarchicalConfiguration<?>	getXmlConfiguration(String siteId, String module, String path)	Reads a configuration for the current environment, or fallback to the default environment if the file is missing
void	invalidateConfiguration(String siteId)	Invalidates all objects for a given site
void	invalidateConfiguration(String siteId, String path)	Invalidates the cache for the given file
void	invalidateConfiguration(String siteId, String module, String path, String environment)	Invalidates the cache for the given file
Map<String,Object>	legacyGetConfiguration(String site, String path)	This method holds logic for API 1, can be deleted when API 1 get configuration is removed
void	makeBlobStoresReadOnly(String siteId)	Update blob stores configuration to make all blobStores read-only
void	setConfigurationServiceInternal(ConfigurationService configurationServiceInternal)
void	writeConfiguration(String siteId, String module, String path, String environment, InputStream content)	Write configuration file for given parameters
void	writeGlobalConfiguration(String path, InputStream content)	Write configuration file within global repo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.studio.api.v2.service.config.ConfigurationService

getCacheKey

Constructor Details

ConfigurationServiceImpl

public ConfigurationServiceImpl()

Method Details

setConfigurationServiceInternal

public void setConfigurationServiceInternal(ConfigurationService configurationServiceInternal)

getRoleMappings

public Map<NormalizedGroup,List<NormalizedRole>> getRoleMappings(String siteId)
                                                          throws ServiceLayerException

Description copied from interface: ConfigurationService

Get role mappings configuration for given site

Specified by:

getRoleMappings in interface ConfigurationService

Parameters:

siteId - Site id to use

Returns:

role mappings configuration

Throws:

ServiceLayerException

getGlobalRoleMappings

public Map<NormalizedGroup,List<NormalizedRole>> getGlobalRoleMappings()
                                                                throws ServiceLayerException

Description copied from interface: ConfigurationService

Get global role mappings configuration

Specified by:

getGlobalRoleMappings in interface ConfigurationService

Returns:

role mappings configuration

Throws:

ServiceLayerException

getConfigurationAsString

public String getConfigurationAsString(String siteId,
 String module,
 String path,
 String environment)
                                throws ContentNotFoundException

Description copied from interface: ConfigurationService

Get configuration as string for given parameters

Specified by:

getConfigurationAsString in interface ConfigurationService

Parameters:

siteId - site id to use

module - CrafterCMS module

path - path of configuration file

environment - environment to use. if empty using default

Returns:

String content of configuration file

Throws:

ContentNotFoundException - if there is any issue reading the file from the repository

getConfigurationAsDocument

public org.dom4j.Document getConfigurationAsDocument(String siteId,
 String module,
 String path,
 String environment)
                                              throws ServiceLayerException

Description copied from interface: ConfigurationService

Get configuration as DOM document for given parameters

Specified by:

getConfigurationAsDocument in interface ConfigurationService

Parameters:

siteId - site id to use

module - CrafterCMS module

path - path of configuration file

environment - environment to use. if empty using default

Returns:

DOM document representing configuration file

Throws:

ServiceLayerException - if there is any error loading the configuration

getXmlConfiguration

public org.apache.commons.configuration2.HierarchicalConfiguration<?> getXmlConfiguration(String siteId,
 String path)
                                                                                   throws ConfigurationException

Description copied from interface: ConfigurationService

Reads a configuration file using Apache Commons Configuration

Specified by:

getXmlConfiguration in interface ConfigurationService

Parameters:

siteId - the id of the site

path - the path of the file

Returns:

the configuration object

Throws:

ConfigurationException - if there is any error reading or parsing the file

getXmlConfiguration

public org.apache.commons.configuration2.HierarchicalConfiguration<?> getXmlConfiguration(String siteId,
 String module,
 String path)
                                                                                   throws ConfigurationException

Description copied from interface: ConfigurationService

Reads a configuration for the current environment, or fallback to the default environment if the file is missing

Specified by:

getXmlConfiguration in interface ConfigurationService

Parameters:

siteId - the id of the site

module - the module

path - the path of the file

Returns:

the configuration object

Throws:

ConfigurationException - if there is any error reading or parsing the file

getGlobalXmlConfiguration

public org.apache.commons.configuration2.HierarchicalConfiguration<?> getGlobalXmlConfiguration(String path)
                                                                                         throws ConfigurationException

Description copied from interface: ConfigurationService

Reads a configuration file using Apache Commons Configuration

Specified by:

getGlobalXmlConfiguration in interface ConfigurationService

Parameters:

path - the path of the file

Returns:

the configuration object

Throws:

ConfigurationException - if there is any error reading or parsing the file

getGlobalConfigurationAsDocument

public org.dom4j.Document getGlobalConfigurationAsDocument(String path)
                                                    throws ServiceLayerException

Description copied from interface: ConfigurationService

Get configuration from global repository as Document

Specified by:

getGlobalConfigurationAsDocument in interface ConfigurationService

Parameters:

path - path of the configuration file

Returns:

the Document

Throws:

ServiceLayerException - if there is any error reading the configuration

getGlobalConfigurationAsString

public String getGlobalConfigurationAsString(String path)
                                      throws ContentNotFoundException

Description copied from interface: ConfigurationService

Get configuration from global repository as String

Specified by:

getGlobalConfigurationAsString in interface ConfigurationService

Parameters:

path - path of configuration file

Returns:

String content of configuration file

Throws:

ContentNotFoundException - if there is any issue reading the file from the repository

writeConfiguration

public void writeConfiguration(String siteId,
 String module,
 String path,
 String environment,
 InputStream content)
                        throws ServiceLayerException,
UserNotFoundException

Description copied from interface: ConfigurationService

Write configuration file for given parameters

Specified by:

writeConfiguration in interface ConfigurationService

Parameters:

siteId - site id to use

module - CrafterCMS module

path - path where to store configuration file

environment - environment to use. if empty using default

content - content of configuration file

Throws:

ServiceLayerException - general service error

UserNotFoundException

getCacheKey

public String getCacheKey(String siteId,
 String module,
 String path,
 String environment,
 String suffix)

Description copied from interface: ConfigurationService

Builds the key for a given file

Specified by:

getCacheKey in interface ConfigurationService

Parameters:

siteId - the id of the site

module - the module of the file

path - the path of the file

environment - the environment of the file

suffix - the suffix for the cache key

Returns:

the key for the file

getPluginFile

public org.springframework.core.io.Resource getPluginFile(String siteId,
 String pluginId,
 String type,
 String name,
 String filename)
                                                   throws ContentNotFoundException

Description copied from interface: ConfigurationService

Get a file from a plugin

Specified by:

getPluginFile in interface ConfigurationService

Parameters:

siteId - the id of site

pluginId - the id of the plugin

type - the type of plugin

name - the name of the plugin

filename - the path and name of the file

Returns:

the file as a resource

Throws:

ContentNotFoundException - if there is any issue reading the file from the repository

getConfigurationHistory

public ConfigurationHistory getConfigurationHistory(String siteId,
 String module,
 String path,
 String environment)
                                             throws ServiceLayerException

Description copied from interface: ConfigurationService

Get configuration history for given parameters

Specified by:

getConfigurationHistory in interface ConfigurationService

Parameters:

siteId - site id to use

module - CrafterCMS module

path - path of configuration file

environment - environment to use. if empty using default

Returns:

configuration history

Throws:

ServiceLayerException

writeGlobalConfiguration

public void writeGlobalConfiguration(String path,
 InputStream content)
                              throws ServiceLayerException

Description copied from interface: ConfigurationService

Write configuration file within global repo

Specified by:

writeGlobalConfiguration in interface ConfigurationService

Parameters:

path - path of configuration file

content - content of configuration file

Throws:

ServiceLayerException - general service error

getTranslationConfiguration

public TranslationConfiguration getTranslationConfiguration(String siteId)
                                                     throws ServiceLayerException

Description copied from interface: ConfigurationService

Get the translation configuration for a given site

Specified by:

getTranslationConfiguration in interface ConfigurationService

Parameters:

siteId - the id of the site

Returns:

the translation configuration

Throws:

ServiceLayerException - general service error

invalidateConfiguration

public void invalidateConfiguration(String siteId,
 String path)

Description copied from interface: ConfigurationService

Invalidates the cache for the given file

Specified by:

invalidateConfiguration in interface ConfigurationService

Parameters:

siteId - the id of the site

path - the path of the file

invalidateConfiguration

public void invalidateConfiguration(String siteId,
 String module,
 String path,
 String environment)

Description copied from interface: ConfigurationService

Invalidates the cache for the given file

Specified by:

invalidateConfiguration in interface ConfigurationService

Parameters:

siteId - the id of the site

module - the module of the file

path - the path of the file

environment - the environment of the file

invalidateConfiguration

public void invalidateConfiguration(String siteId)

Description copied from interface: ConfigurationService

Invalidates all objects for a given site

Specified by:

invalidateConfiguration in interface ConfigurationService

Parameters:

siteId - the id of the site

makeBlobStoresReadOnly

public void makeBlobStoresReadOnly(String siteId)
                            throws ServiceLayerException

Description copied from interface: ConfigurationService

Update blob stores configuration to make all blobStores read-only

Specified by:

makeBlobStoresReadOnly in interface ConfigurationService

Parameters:

siteId - the id of the site

Throws:

ServiceLayerException - if an error occurs while reading or writing the configuration

legacyGetConfiguration

public Map<String,Object> legacyGetConfiguration(String site,
 String path)
                                          throws ServiceLayerException

Description copied from interface: ConfigurationService

This method holds logic for API 1, can be deleted when API 1 get configuration is removed

Specified by:

legacyGetConfiguration in interface ConfigurationService

Throws:

ServiceLayerException