org.jahia.services.modulemanager.spi

Interface ConfigService

public interface ConfigService

Service to store and restore OSGi configurations to/from JCR

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConfigService.ConfigType Configuration types

Method Summary

Modifier and Type	Method and Description
void	deleteConfig(Config config) Delete the associated configuration
Map<String,ConfigService.ConfigType>	getAllConfigurationTypes() Get all configurations currently deployed
Config	getConfig(String pid) Get the config for the specified PID If it does not exist yet, create a new config
Config	getConfig(String factoryPid, String identifier) Get the settings for the specified factory PID and identifer If it does not exist yet, create a new config
Collection<String>	restoreConfigurationsFromJCR(Collection<ConfigService.ConfigType> types) Restore configurations from JCR
void	setAutoSaveToJCR(boolean autoSave) Auto save configuration on change
Collection<String>	storeAllConfigurationsToJCR() Store configurations into JCR
void	storeConfig(Config config) Persist the changes on the config into the the Configuration Manager storage

Method Detail

getConfig

Config getConfig(String pid)
          throws IOException

Get the config for the specified PID If it does not exist yet, create a new config

Parameters:

pid - The config PID

Returns:

the Config object

Throws:

IOException - exception

getConfig

Config getConfig(String factoryPid,
                 String identifier)
          throws IOException

Get the settings for the specified factory PID and identifer If it does not exist yet, create a new config

Parameters:

factoryPid - The factory PID

identifier - The identifier

Returns:

the Config object

Throws:

IOException - exception

storeConfig

void storeConfig(Config config)
          throws IOException

Persist the changes on the config into the the Configuration Manager storage

Parameters:

config - The config to store

Throws:

IOException - exception

deleteConfig

void deleteConfig(Config config)
           throws IOException

Delete the associated configuration

Parameters:

config - The config to delete

Throws:

IOException - exception

getAllConfigurationTypes

Map<String,ConfigService.ConfigType> getAllConfigurationTypes()

Get all configurations currently deployed

Returns:

the list of configurations files saved along with their type

storeAllConfigurationsToJCR

Collection<String> storeAllConfigurationsToJCR()

Store configurations into JCR

Returns:

the list of configurations files saved

restoreConfigurationsFromJCR

Collection<String> restoreConfigurationsFromJCR(Collection<ConfigService.ConfigType> types)

Restore configurations from JCR

Parameters:

types - The types to store, null for all configurations

Returns:

the list of restored configurations

setAutoSaveToJCR

void setAutoSaveToJCR(boolean autoSave)

Auto save configuration on change