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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLACEHOLDER_NAME
static String	PLACEHOLDER_TYPE

Constructor Summary

Constructors

Constructor and Description
ConfigurationServiceImpl()

Method Summary

Modifier and Type	Method and Description
Map<String,List<String>>	geRoleMappings(String siteId) Get role mappings configuration for given site
AuditServiceInternal	getAuditServiceInternal()
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
String	getGlobalConfiguration(String path) Get configuration from global repository as String
ObjectMetadataManager	getObjectMetadataManager()
ObjectStateService	getObjectStateService()
org.springframework.core.io.Resource	getPluginFile(String siteId, String type, String name, String filename) Get a a file from a plugin
SecurityService	getSecurityService()
SiteService	getSiteService()
org.apache.commons.configuration2.HierarchicalConfiguration<?>	getXmlConfiguration(String siteId, String path) Reads a configuration file using Apache Commons Configuration
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setConfigurationCache(net.sf.ehcache.Cache configurationCache)
void	setConfigurationReader(org.craftercms.commons.config.EncryptionAwareConfigurationReader configurationReader)
void	setContentService(ContentService contentService)
void	setEventService(EventService eventService)
void	setObjectMetadataManager(ObjectMetadataManager objectMetadataManager)
void	setObjectStateService(ObjectStateService objectStateService)
void	setSecurityService(SecurityService securityService)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteService(SiteService siteService)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
protected InputStream	validate(InputStream content, String filename)
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

Field Detail

PLACEHOLDER_TYPE

public static final String PLACEHOLDER_TYPE

See Also:

Constant Field Values

PLACEHOLDER_NAME

public static final String PLACEHOLDER_NAME

See Also:

Constant Field Values

Constructor Detail

ConfigurationServiceImpl

public ConfigurationServiceImpl()

Method Detail

geRoleMappings

public Map<String,List<String>> geRoleMappings(String siteId)
                                        throws ConfigurationException

Description copied from interface: ConfigurationService

Get role mappings configuration for given site

Specified by:

geRoleMappings in interface ConfigurationService

Parameters:

siteId - Site id to use

Returns:

role mappings configuration

Throws:

ConfigurationException

getConfigurationAsString

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

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 - crafter CMS module

path - path of configuration file

environment - environment to use. if empty using default

Returns:

String content of configuration file

getConfigurationAsDocument

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

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 - crafter CMS module

path - path of configuration file

environment - environment to use. if empty using default

Returns:

DOM document representing configuration file

Throws:

org.dom4j.DocumentException

IOException

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

getGlobalConfiguration

public String getGlobalConfiguration(String path)

Description copied from interface: ConfigurationService

Get configuration from global repository as String

Specified by:

getGlobalConfiguration in interface ConfigurationService

Parameters:

path - path of configuration file

Returns:

String content of configuration file

writeConfiguration

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

Description copied from interface: ConfigurationService

Write configuration file for given parameters

Specified by:

writeConfiguration in interface ConfigurationService

Parameters:

siteId - site id to use

module - crafter CMS module

path - path where to store configuration file

environment - environment to use. if empty using default

content - content of configuration file

Throws:

ServiceLayerException

getPluginFile

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

Description copied from interface: ConfigurationService

Get a a file from a plugin

Specified by:

getPluginFile in interface ConfigurationService

Parameters:

siteId - the id of site

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

validate

protected InputStream validate(InputStream content,
                               String filename)
                        throws ServiceLayerException

Throws:

ServiceLayerException

getConfigurationHistory

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

Description copied from interface: ConfigurationService

Get configuration history for given parameters

Specified by:

getConfigurationHistory in interface ConfigurationService

Parameters:

siteId - site id to use

module - crafter CMS module

path - path of configuration file

environment - environment to use. if empty using default

Returns:

configuration history

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

setContentService

public void setContentService(ContentService contentService)

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

getAuditServiceInternal

public AuditServiceInternal getAuditServiceInternal()

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

getSiteService

public SiteService getSiteService()

setSiteService

public void setSiteService(SiteService siteService)

getSecurityService

public SecurityService getSecurityService()

setSecurityService

public void setSecurityService(SecurityService securityService)

getObjectMetadataManager

public ObjectMetadataManager getObjectMetadataManager()

setObjectMetadataManager

public void setObjectMetadataManager(ObjectMetadataManager objectMetadataManager)

getObjectStateService

public ObjectStateService getObjectStateService()

setObjectStateService

public void setObjectStateService(ObjectStateService objectStateService)

setEventService

public void setEventService(EventService eventService)

setConfigurationCache

public void setConfigurationCache(net.sf.ehcache.Cache configurationCache)

setConfigurationReader

public void setConfigurationReader(org.craftercms.commons.config.EncryptionAwareConfigurationReader configurationReader)