Package org.cyclos.impl.contentmanagement

Class ThemeServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>

org.cyclos.impl.contentmanagement.ThemeServiceImpl

All Implemented Interfaces:

ApplicationUpgradeInitializationListener, BaseApplicationInitializationListener, ThemeServiceLocal, CRUDServiceLocal<Theme,ThemeDTO,ThemeData,ThemeDataParams>, ThemeService, CRUDService<ThemeDTO,ThemeData,ThemeDataParams>, CRUDWithConfirmationPasswordService<ThemeDTO,ThemeData,ThemeDataParams>, Service

@Service
public class ThemeServiceImpl
extends CRUDServiceImpl<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>
implements ThemeServiceLocal, ApplicationUpgradeInitializationListener

implementation for ThemeService

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.BaseApplicationInitializationListener

MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ThemeServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	applyThemes(ApplyThemesDTO params)	Applies the given themes to the given configuration: logged user, guests, mobile and pay application.
FileInfo	export(Long id)	Exports the given theme
String	getCSS(Long id)	Returns the CSS corresponding to the theme with the given id
String	getCSS(Theme theme)	Returns the css content for the given Theme
protected ThemeData	getData(Theme theme)	Returns details data for the given entity
String	getDefinition(Theme theme, ThemeDefinition definition)	Returns the theme definition value for the given theme, or the default value if not set.
String	getDefinitionsAsString(Theme theme)	Returns the (base) definitions as a String containing the LESS variables for the given Theme
protected String[]	getExcludedPropertiesToDTO(Theme entity)	May be overridden in order to exclude properties when converting the given entity to DTO
String	getFallbackCSS(ThemeType type)	Returns a default CSS corresponding to the theme type.
ThemesListData	getListData(ConfigurationVO configurationVO)	Returns data to list themes in a configuration
ThemeVO	getTheme(ThemeType type)	Returns the theme for the given type.
ThemeVO	getVO(Long id)	Returns the ThemeVO with the given id.
List<Theme>	importBuiltin()	Imports all built-in themes, updating those already imported
Long	importNew(ConfigurationVO configurationVO, String fileName, SerializableInputStream in)	Import the theme definitions from file, creating it on the given configuration, returning the new theme id
void	initialize()
boolean	isBuiltin(Theme theme)	Returns whether a theme is builtin
List<ThemeVO>	list(ConfigurationVO configurationVO)	Returns a list with visible themes on the given configuration sorted by theme type (first main web themes)
List<Theme>	listAll()	Lists all themes
Theme	newEntity(ThemeDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(Theme theme, Theme currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
void	onApplicationUpgradeInitialization()	Invoked when the application service is initialized
protected void	onBeforeRemove(Theme theme)	May be overridden in order to perform custom logic before removing an entity
protected Object	onBeforeSave(Theme theme, Theme currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(ThemeDTO dto)
ThemeDTO	toDTO(Theme entity)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, toEntity, 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, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, 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.impl.BaseApplicationInitializationListener

applicationInitializationPriority, getInitializationId

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, toEntity, validate

Constructor Detail

ThemeServiceImpl

public ThemeServiceImpl()

Method Detail

applyThemes

public void applyThemes(ApplyThemesDTO params)
                 throws FrameworkException

Description copied from interface: ThemeService

Applies the given themes to the given configuration: logged user, guests, mobile and pay application. Passing null means the theme will be inherited from parent configurations, but is not possible for the system default configuration. The themes must be defined within that configuration or in any of it's ancestors.

Specified by:

applyThemes in interface ThemeService

Throws:

FrameworkException

export

public FileInfo export(Long id)

Description copied from interface: ThemeService

Exports the given theme

Specified by:

export in interface ThemeService

getCSS

public String getCSS(Long id)

Description copied from interface: ThemeService

Returns the CSS corresponding to the theme with the given id

Specified by:

getCSS in interface ThemeService

getCSS

public String getCSS(Theme theme)

Description copied from interface: ThemeServiceLocal

Returns the css content for the given Theme

Specified by:

getCSS in interface ThemeServiceLocal

getDefinition

public String getDefinition(Theme theme,
                            ThemeDefinition definition)

Description copied from interface: ThemeServiceLocal

Returns the theme definition value for the given theme, or the default value if not set.

Specified by:

getDefinition in interface ThemeServiceLocal

getDefinitionsAsString

public String getDefinitionsAsString(Theme theme)

Description copied from interface: ThemeServiceLocal

Returns the (base) definitions as a String containing the LESS variables for the given Theme

Specified by:

getDefinitionsAsString in interface ThemeServiceLocal

getFallbackCSS

public String getFallbackCSS(ThemeType type)

Description copied from interface: ThemeService

Returns a default CSS corresponding to the theme type. It's used only in case the selected theme fails to compile.

Specified by:

getFallbackCSS in interface ThemeService

getListData

public ThemesListData getListData(ConfigurationVO configurationVO)
                           throws FrameworkException

Description copied from interface: ThemeService

Returns data to list themes in a configuration

Specified by:

getListData in interface ThemeService

Throws:

FrameworkException

getTheme

public ThemeVO getTheme(ThemeType type)
                 throws FrameworkException

Description copied from interface: ThemeService

Returns the theme for the given type. In case of ThemeType.MAIN_WEB the returned theme depends on if there is a logged user or not.

Specified by:

getTheme in interface ThemeService

Throws:

FrameworkException

getVO

public ThemeVO getVO(Long id)
              throws EntityNotFoundException

Description copied from interface: ThemeService

Returns the ThemeVO with the given id.

Specified by:

getVO in interface ThemeService

Throws:

EntityNotFoundException

importBuiltin

public List<Theme> importBuiltin()

Description copied from interface: ThemeServiceLocal

Imports all built-in themes, updating those already imported

Specified by:

importBuiltin in interface ThemeServiceLocal

importNew

public Long importNew(ConfigurationVO configurationVO,
                      String fileName,
                      SerializableInputStream in)
               throws FileParsingException

Description copied from interface: ThemeService

Import the theme definitions from file, creating it on the given configuration, returning the new theme id

Specified by:

importNew in interface ThemeService

Throws:

FileParsingException

initialize

@PostConstruct
public void initialize()
                throws IOException

Throws:

IOException

isBuiltin

public boolean isBuiltin(Theme theme)

Description copied from interface: ThemeServiceLocal

Returns whether a theme is builtin

Specified by:

isBuiltin in interface ThemeServiceLocal

list

public List<ThemeVO> list(ConfigurationVO configurationVO)

Description copied from interface: ThemeService

Returns a list with visible themes on the given configuration sorted by theme type (first main web themes)

Specified by:

list in interface ThemeService

listAll

public List<Theme> listAll()

Description copied from interface: ThemeServiceLocal

Lists all themes

Specified by:

listAll in interface ThemeServiceLocal

newEntity

public Theme newEntity(ThemeDataParams params)

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<Theme,ThemeDTO,ThemeData,ThemeDataParams>

Specified by:

newEntity in class CRUDServiceImpl<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>

onApplicationUpgradeInitialization

public void onApplicationUpgradeInitialization()

Description copied from interface: ApplicationUpgradeInitializationListener

Invoked when the application service is initialized

Specified by:

onApplicationUpgradeInitialization in interface ApplicationUpgradeInitializationListener

toDTO

public ThemeDTO toDTO(Theme entity)

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<Theme,ThemeDTO,ThemeData,ThemeDataParams>

Overrides:

toDTO in class CRUDServiceImpl<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>

getData

protected ThemeData getData(Theme theme)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>

getExcludedPropertiesToDTO

protected String[] getExcludedPropertiesToDTO(Theme entity)

Description copied from class: CRUDServiceImpl

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

Overrides:

getExcludedPropertiesToDTO in class CRUDServiceImpl<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>

onAfterSave

protected void onAfterSave(Theme theme,
                           Theme 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<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>

onBeforeRemove

protected void onBeforeRemove(Theme theme)

Description copied from class: CRUDServiceImpl

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

Overrides:

onBeforeRemove in class CRUDServiceImpl<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>

onBeforeSave

protected Object onBeforeSave(Theme theme,
                              Theme 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<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>

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(ThemeDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Theme,QTheme,ThemeDTO,ThemeData,ThemeDataParams>