Package org.cyclos.impl.system

Class ConfigurationServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

org.cyclos.impl.system.ConfigurationServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<Configuration,ConfigurationDTO,ConfigurationData,ConfigurationVO>, ConfigurationServiceLocal, CRUDService<ConfigurationDTO,ConfigurationData,ConfigurationVO>, CRUDWithConfirmationPasswordService<ConfigurationDTO,ConfigurationData,ConfigurationVO>, Service, ConfigurationService

@Service
public class ConfigurationServiceImpl
extends CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>
implements ConfigurationServiceLocal

implementation for ConfigurationService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.system.ConfigurationServiceLocal

UNACCENT

Constructor Summary

Constructors

Constructor	Description
ConfigurationServiceImpl()

Method Summary

Modifier and Type	Method	Description
Configuration	createDefaultForNetwork(Network network)	Creates the default configuration for the given network
ActiveConfigurationData	getActiveConfiguration(ConfigurationVO configurationVO)	Returns the active configuration for the configuration with the given id
List<Configuration>	getConfigurationTreePath(Configuration configuration)	Returns the configuration tree path for the given configuration If the logged user is global then the global configurations will also be returned.
protected ConfigurationData	getData(Configuration configuration)	Returns details data for the given entity
ConfigurationVO	getDefault()	Returns the default configuration for the current network (or the global default configuration)
protected Object[]	getExcludedPropertiesToEntity(ConfigurationDTO dto)	May be overridden in order to exclude properties when converting the given DTO to entity
ConfigurationSearchData	getSearchData()	Gets data used on the search page
List<ConfigurationDetailedVO>	list()	Returns all visible configurations
List<Configuration>	listAll()	Returns all configurations
List<Configuration>	listByThemeUsage(Theme theme, ThemeUsage usage)	Lists the configurations which uses the given theme under the given usage type
List<Configuration>	listVisible()	Returns the configurations which are visible by the logged administrator
Configuration	newEntity(ConfigurationVO parentVO)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterRemove(Configuration entity)	May be overridden in order to perform custom logic after removing an entity
protected void	onAfterSave(Configuration configuration, Configuration currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(Configuration configuration, Configuration currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	preProcessCurrentCopy(ConfigurationDTO dto, Configuration currentCopy)	This method is invoked before saving the entity and also, if the log is enabled, before removing.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeGroup(Group group)	Removes a group from any configuration; usually done when the group is disabled, and not supposed to show up anymore.
protected Validator	resolveValidator(ConfigurationDTO dto)
Page<ConfigurationDetailedVO>	search(ConfigurationQuery params)	Search configurations according to the specified query parameters
<T> void	setConfiguration(Configuration configuration, com.querydsl.core.types.Path<T> path, T value)	Sets a configuration property and add it on the defined collection
void	setLocalization(Configuration configuration, Language language, String country, String timeZoneId)	Sets the localization options in the given configuration, defining the language, country and time zone, as well as fields derived from the language and coutry, like date and number format.
List<Configuration>	sortByHierarchy(Collection<Configuration> configurations)	Sort the given configurations according to the hierarchy
<T extends ActiveConfigurationData> T	toActiveConfiguration(Class<T> dataType, ConfigurationAccessor accessor)	Converts the given ConfigurationAccessor into an ActiveConfigurationData
AddressConfigurationData	toAddressConfiguration(ConfigurationAccessor accessor)	Converts the given ConfigurationAccessor into an AddressConfigurationData
ConfigurationDTO	toDTO(Configuration configuration)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
Configuration	toEntity(ConfigurationDTO dto)	Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
PhoneConfigurationData	toPhoneConfiguration(ConfigurationAccessor accessor)	Converts the given ConfigurationAccessor into a PhoneConfigurationData
void	updateSitemapLastModified(Configuration configuration)	Marks the configuration's sitemap as modified

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onBeforeRemove, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, validate

Constructor Detail

ConfigurationServiceImpl

public ConfigurationServiceImpl()

Method Detail

createDefaultForNetwork

public Configuration createDefaultForNetwork(Network network)
                                      throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Creates the default configuration for the given network

Specified by:

createDefaultForNetwork in interface ConfigurationServiceLocal

Throws:

FrameworkException

getActiveConfiguration

public ActiveConfigurationData getActiveConfiguration(ConfigurationVO configurationVO)

Description copied from interface: ConfigurationService

Returns the active configuration for the configuration with the given id

Specified by:

getActiveConfiguration in interface ConfigurationService

getConfigurationTreePath

public List<Configuration> getConfigurationTreePath(Configuration configuration)

Description copied from interface: ConfigurationServiceLocal

Returns the configuration tree path for the given configuration If the logged user is global then the global configurations will also be returned.

Specified by:

getConfigurationTreePath in interface ConfigurationServiceLocal

getDefault

public ConfigurationVO getDefault()
                           throws FrameworkException

Description copied from interface: ConfigurationService

Returns the default configuration for the current network (or the global default configuration)

Specified by:

getDefault in interface ConfigurationService

Throws:

FrameworkException

getSearchData

public ConfigurationSearchData getSearchData()

Description copied from interface: ConfigurationService

Gets data used on the search page

Specified by:

getSearchData in interface ConfigurationService

list

public List<ConfigurationDetailedVO> list()
                                   throws FrameworkException

Description copied from interface: ConfigurationService

Returns all visible configurations

Specified by:

list in interface ConfigurationService

Throws:

FrameworkException

listAll

public List<Configuration> listAll()

Description copied from interface: ConfigurationServiceLocal

Returns all configurations

Specified by:

listAll in interface ConfigurationServiceLocal

listByThemeUsage

public List<Configuration> listByThemeUsage(Theme theme,
                                            ThemeUsage usage)
                                     throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Lists the configurations which uses the given theme under the given usage type

Specified by:

listByThemeUsage in interface ConfigurationServiceLocal

Throws:

FrameworkException

listVisible

public List<Configuration> listVisible()
                                throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Returns the configurations which are visible by the logged administrator

Specified by:

listVisible in interface ConfigurationServiceLocal

Throws:

FrameworkException

newEntity

public Configuration newEntity(ConfigurationVO parentVO)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<Configuration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

Specified by:

newEntity in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

removeGroup

public void removeGroup(Group group)

Description copied from interface: ConfigurationServiceLocal

Removes a group from any configuration; usually done when the group is disabled, and not supposed to show up anymore. The group is removed from possibleInitialGroups and from visibleGroups.

Specified by:

removeGroup in interface ConfigurationServiceLocal

search

public Page<ConfigurationDetailedVO> search(ConfigurationQuery params)

Description copied from interface: ConfigurationService

Search configurations according to the specified query parameters

Specified by:

search in interface ConfigurationService

setConfiguration

public <T> void setConfiguration(Configuration configuration,
                                 com.querydsl.core.types.Path<T> path,
                                 T value)

Description copied from interface: ConfigurationServiceLocal

Sets a configuration property and add it on the defined collection

Specified by:

setConfiguration in interface ConfigurationServiceLocal

setLocalization

public void setLocalization(Configuration configuration,
                            Language language,
                            String country,
                            String timeZoneId)
                     throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Sets the localization options in the given configuration, defining the language, country and time zone, as well as fields derived from the language and coutry, like date and number format.

Specified by:

setLocalization in interface ConfigurationServiceLocal

Throws:

FrameworkException

sortByHierarchy

public List<Configuration> sortByHierarchy(Collection<Configuration> configurations)
                                    throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Sort the given configurations according to the hierarchy

Specified by:

sortByHierarchy in interface ConfigurationServiceLocal

Throws:

FrameworkException

toActiveConfiguration

public <T extends ActiveConfigurationData> T toActiveConfiguration(Class<T> dataType,
                                                                   ConfigurationAccessor accessor)
                                                            throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Converts the given ConfigurationAccessor into an ActiveConfigurationData

Specified by:

toActiveConfiguration in interface ConfigurationServiceLocal

Throws:

FrameworkException

toAddressConfiguration

public AddressConfigurationData toAddressConfiguration(ConfigurationAccessor accessor)
                                                throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Converts the given ConfigurationAccessor into an AddressConfigurationData

Specified by:

toAddressConfiguration in interface ConfigurationServiceLocal

Throws:

FrameworkException

toDTO

public ConfigurationDTO toDTO(Configuration configuration)

Description copied from class: CRUDServiceImpl

Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toDTO in interface CRUDServiceLocal<Configuration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

Overrides:

toDTO in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

toEntity

public Configuration toEntity(ConfigurationDTO dto)

Description copied from class: CRUDServiceImpl

Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toEntity in interface CRUDServiceLocal<Configuration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

Overrides:

toEntity in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

toPhoneConfiguration

public PhoneConfigurationData toPhoneConfiguration(ConfigurationAccessor accessor)
                                            throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Converts the given ConfigurationAccessor into a PhoneConfigurationData

Specified by:

toPhoneConfiguration in interface ConfigurationServiceLocal

Throws:

FrameworkException

updateSitemapLastModified

public void updateSitemapLastModified(Configuration configuration)
                               throws FrameworkException

Description copied from interface: ConfigurationServiceLocal

Marks the configuration's sitemap as modified

Specified by:

updateSitemapLastModified in interface ConfigurationServiceLocal

Throws:

FrameworkException

getData

protected ConfigurationData getData(Configuration configuration)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

getExcludedPropertiesToEntity

protected Object[] getExcludedPropertiesToEntity(ConfigurationDTO dto)

Description copied from class: CRUDServiceImpl

May be overridden in order to exclude properties when converting the given DTO to entity

Overrides:

getExcludedPropertiesToEntity in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

onAfterRemove

protected void onAfterRemove(Configuration entity)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after removing an entity

Overrides:

onAfterRemove in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

onAfterSave

protected void onAfterSave(Configuration configuration,
                           Configuration currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

onBeforeSave

protected Object onBeforeSave(Configuration configuration,
                              Configuration currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

preProcessCurrentCopy

protected void preProcessCurrentCopy(ConfigurationDTO dto,
                                     Configuration currentCopy)

Description copied from class: CRUDServiceImpl

This method is invoked before saving the entity and also, if the log is enabled, before removing. Subclasses can override it to fetch lazy relationships, etc as the current copy will be detached. In case of removing (i.e the log is enabled for this entity) the dto parameter will be null.

Overrides:

preProcessCurrentCopy in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(ConfigurationDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Configuration,QConfiguration,ConfigurationDTO,ConfigurationData,ConfigurationVO>