Package org.cyclos.impl.contentmanagement

Class StaticContentServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

org.cyclos.impl.contentmanagement.StaticContentServiceImpl

All Implemented Interfaces:

StaticContentServiceLocal, CRUDServiceLocal<BaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>, StaticContentService, CRUDService<BaseStaticContentDTO,StaticContentData,StaticContentDataParams>, CRUDWithConfirmationPasswordService<BaseStaticContentDTO,StaticContentData,StaticContentDataParams>, Service

@Service
public class StaticContentServiceImpl
extends CRUDServiceImpl<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>
implements StaticContentServiceLocal

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, 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

Constructor Summary

Constructors

Constructor	Description
StaticContentServiceImpl()

Method Summary

Modifier and Type	Method	Description
BaseStaticContent	ensureLastModifiedDate(BaseStaticContent content)	Ensures the cache control works correctly for static contents when changing a configuration image which affects an unchanged content.
StaticContentData	getData(BaseStaticContent staticContent)	Returns details data for the given entity
String	getHelpContent(Role role)
String	getHelpOrOriginalContent(BaseHelpContent helpContent)
StaticContentListData	getListData(ConfigurationVO configurationVO)	Returns data to list the static contents of a given configuration
String	getSmsHelpContent(Role role)
List<StaticContentVO>	list(ConfigurationVO configurationVO)	Lists the static contents of a given configuration
BaseStaticContent	newEntity(StaticContentDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterRemove(BaseStaticContent entity)	May be overridden in order to perform custom logic after removing an entity
protected void	onAfterSave(BaseStaticContent content, BaseStaticContent currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(BaseStaticContent entity, BaseStaticContent currentCopy)	May be overridden in order to perform custom logic before saving an entity.
String	previewEMail(PreviewEmailTemplateParams input)	Previews the e-mail content by applying the given template to the given user
String	readOriginalHelp(StaticContentNature nature)	Returns the original help content for the specified StaticContentNature.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(BaseStaticContentDTO dto)
protected org.apache.commons.collections4.BidiMap<Class<? extends BaseStaticContent>,Class<? extends BaseStaticContentDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.
BaseStaticContentDTO	toDTO(BaseStaticContent 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, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, 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.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

StaticContentServiceImpl

public StaticContentServiceImpl()

Method Detail

ensureLastModifiedDate

public BaseStaticContent ensureLastModifiedDate(BaseStaticContent content)

Description copied from interface: StaticContentServiceLocal

Ensures the cache control works correctly for static contents when changing a configuration image which affects an unchanged content.

Specified by:

ensureLastModifiedDate in interface StaticContentServiceLocal

getData

public StaticContentData getData(BaseStaticContent staticContent)
                          throws FrameworkException

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

Throws:

FrameworkException

getHelpContent

public String getHelpContent(Role role)

Specified by:

getHelpContent in interface StaticContentService

Returns:

the help content according to the specified Role

getHelpOrOriginalContent

public String getHelpOrOriginalContent(BaseHelpContent helpContent)

Specified by:

getHelpOrOriginalContent in interface StaticContentServiceLocal

Returns:

the help's content or the original according to the content definition type.

getListData

public StaticContentListData getListData(ConfigurationVO configurationVO)
                                  throws FrameworkException

Description copied from interface: StaticContentService

Returns data to list the static contents of a given configuration

Specified by:

getListData in interface StaticContentService

Throws:

FrameworkException

getSmsHelpContent

public String getSmsHelpContent(Role role)

Specified by:

getSmsHelpContent in interface StaticContentService

Returns:

the sms help content. Note for version 4.0.3.x: at this moment only the role admin is supported.

list

public List<StaticContentVO> list(ConfigurationVO configurationVO)
                           throws FrameworkException

Description copied from interface: StaticContentService

Lists the static contents of a given configuration

Specified by:

list in interface StaticContentService

Throws:

FrameworkException

newEntity

public BaseStaticContent newEntity(StaticContentDataParams 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<BaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

Specified by:

newEntity in class CRUDServiceImpl<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

previewEMail

public String previewEMail(PreviewEmailTemplateParams input)
                    throws FrameworkException

Description copied from interface: StaticContentService

Previews the e-mail content by applying the given template to the given user

Specified by:

previewEMail in interface StaticContentService

Throws:

FrameworkException

readOriginalHelp

public String readOriginalHelp(StaticContentNature nature)

Description copied from interface: StaticContentServiceLocal

Returns the original help content for the specified StaticContentNature.

Specified by:

readOriginalHelp in interface StaticContentServiceLocal

toDTO

public BaseStaticContentDTO toDTO(BaseStaticContent 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<BaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

Overrides:

toDTO in class CRUDServiceImpl<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

onAfterRemove

protected void onAfterRemove(BaseStaticContent entity)

Description copied from class: CRUDServiceImpl

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

Overrides:

onAfterRemove in class CRUDServiceImpl<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

onAfterSave

protected void onAfterSave(BaseStaticContent content,
                           BaseStaticContent 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<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

onBeforeSave

protected Object onBeforeSave(BaseStaticContent entity,
                              BaseStaticContent 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<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

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

Specified by:

resolveValidator in class CRUDServiceImpl<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends BaseStaticContent>,Class<? extends BaseStaticContentDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<BaseStaticContent,QBaseStaticContent,BaseStaticContentDTO,StaticContentData,StaticContentDataParams>