Package org.cyclos.security.contentmanagement

Class StaticContentServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<BaseStaticContentDTO,BaseStaticContent,StaticContentData,StaticContentDataParams>

org.cyclos.security.contentmanagement.StaticContentServiceSecurity

All Implemented Interfaces:

StaticContentService, CRUDService<BaseStaticContentDTO,StaticContentData,StaticContentDataParams>, CRUDWithConfirmationPasswordService<BaseStaticContentDTO,StaticContentData,StaticContentDataParams>, Service

@Security
public class StaticContentServiceSecurity
extends CRUDServiceSecurity<BaseStaticContentDTO,BaseStaticContent,StaticContentData,StaticContentDataParams>
implements StaticContentService

Security for static contents.

Field Summary

Fields inherited from class org.cyclos.security.CRUDServiceSecurity

entityClass

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
StaticContentServiceSecurity()

Method Summary

Modifier and Type	Method	Description
protected void	checkCreateNew(StaticContentDataParams params)	Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
protected void	customizeData(StaticContentData data)	Can be overridden in order to process the returned data object for the given entity
protected boolean	doHasManageAccess(BaseStaticContent entity)	Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(BaseStaticContent entity)	Should be implemented in order to return whether the caller is allowed to view the given entity.
String	getHelpContent(Role role)
protected StaticContentServiceLocal	getImplementation()	Should be implemented in order to return the actual implementation of the service
StaticContentListData	getListData(ConfigurationVO configurationVO)	Returns data to list the static contents of a given configuration
String	getSmsHelpContent(Role role)
boolean	isAccessible(SessionData sessionData, BaseStaticContent entity)	Must be implemented in order to determine whether the given entity is accessible for the given session data.
List<StaticContentVO>	list(ConfigurationVO configurationVO)	Lists the static contents of a given configuration
String	previewEMail(PreviewEmailTemplateParams params)	Previews the e-mail content by applying the given template to the given user

Methods inherited from class org.cyclos.security.CRUDServiceSecurity

canPerformOperation, canViewData, checkManageAccess, checkOperation, checkSave, checkViewAccess, find, getConfirmationPasswordInputForRemove, getData, getDataForNew, getEntityClass, hasManageAccess, hasViewAccess, load, onBeforeSave, remove, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveEntityCheck, save, saveWithConfirmationPassword

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

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

Constructor Detail

StaticContentServiceSecurity

public StaticContentServiceSecurity()

Method Detail

doHasViewAccess

public boolean doHasViewAccess(BaseStaticContent entity)

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return whether the caller is allowed to view the given entity.

Specified by:

doHasViewAccess in class CRUDServiceSecurity<BaseStaticContentDTO,BaseStaticContent,StaticContentData,StaticContentDataParams>

getHelpContent

public String getHelpContent(Role role)

Specified by:

getHelpContent in interface StaticContentService

Returns:

the help content according to the specified Role

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)
                         throws FrameworkException

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.

Throws:

FrameworkException

isAccessible

public boolean isAccessible(SessionData sessionData,
                            BaseStaticContent entity)

Description copied from class: CRUDServiceSecurity

Must be implemented in order to determine whether the given entity is accessible for the given session data. This method shouldn't check the same condition as CRUDServiceSecurity.hasViewAccess(BaseEntity). If the only condition for an entity is CRUDServiceSecurity.hasViewAccess(BaseEntity), this method should return false.

Specified by:

isAccessible in class CRUDServiceSecurity<BaseStaticContentDTO,BaseStaticContent,StaticContentData,StaticContentDataParams>

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

previewEMail

public String previewEMail(PreviewEmailTemplateParams params)
                    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

checkCreateNew

protected void checkCreateNew(StaticContentDataParams params)

Description copied from class: CRUDServiceSecurity

Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not

Specified by:

checkCreateNew in class CRUDServiceSecurity<BaseStaticContentDTO,BaseStaticContent,StaticContentData,StaticContentDataParams>

customizeData

protected void customizeData(StaticContentData data)

Description copied from class: CRUDServiceSecurity

Can be overridden in order to process the returned data object for the given entity

Overrides:

customizeData in class CRUDServiceSecurity<BaseStaticContentDTO,BaseStaticContent,StaticContentData,StaticContentDataParams>

doHasManageAccess

protected boolean doHasManageAccess(BaseStaticContent entity)

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation

Specified by:

doHasManageAccess in class CRUDServiceSecurity<BaseStaticContentDTO,BaseStaticContent,StaticContentData,StaticContentDataParams>

getImplementation

protected StaticContentServiceLocal getImplementation()

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return the actual implementation of the service

Specified by:

getImplementation in class CRUDServiceSecurity<BaseStaticContentDTO,BaseStaticContent,StaticContentData,StaticContentDataParams>