Package org.cyclos.security.users

Class GeneralReferenceServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<GeneralReferenceDTO,GeneralReference,GeneralReferenceData,GeneralReferenceDataParams>

org.cyclos.security.users.GeneralReferenceServiceSecurity

All Implemented Interfaces:

CRUDService<GeneralReferenceDTO,GeneralReferenceData,GeneralReferenceDataParams>, CRUDWithConfirmationPasswordService<GeneralReferenceDTO,GeneralReferenceData,GeneralReferenceDataParams>, Service, GeneralReferenceService

@Security
public class GeneralReferenceServiceSecurity
extends CRUDServiceSecurity<GeneralReferenceDTO,GeneralReference,GeneralReferenceData,GeneralReferenceDataParams>
implements GeneralReferenceService

Security for GeneralReferenceService

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

Method Summary

Modifier and Type	Method	Description
protected void	check(User fromUser, User toUser)
protected void	checkCreateNew(GeneralReferenceDataParams params)	Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
boolean	doHasManageAccess(GeneralReference entity)	Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(GeneralReference entity)	Should be implemented in order to return whether the caller is allowed to view the given entity.
protected GeneralReferenceServiceLocal	getImplementation()	Should be implemented in order to return the actual implementation of the service
GeneralReferenceSearchData	getSearchData(UserLocatorVO locator)	Returns data used for search general references over the given user
ReferenceStatisticsVO	getStatistics(@NotNull ReferenceStatisticsParams params)	Returns reference statistics for the given user.
boolean	isAccessible(SessionData sessionData, GeneralReference entity)	Must be implemented in order to determine whether the given entity is accessible for the given session data.
protected void	onBeforeSave(GeneralReferenceDTO dto, GeneralReference entity)
Page<GeneralReferenceEntryVO>	search(GeneralReferenceQuery query)	Searches for references for a given owner, according to the specified query parameters

Methods inherited from class org.cyclos.security.CRUDServiceSecurity

canPerformOperation, canViewData, checkManageAccess, checkOperation, checkSave, checkViewAccess, customizeData, find, getConfirmationPasswordInputForRemove, getData, getDataForNew, getEntityClass, hasManageAccess, hasViewAccess, load, 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

GeneralReferenceServiceSecurity

public GeneralReferenceServiceSecurity()

Method Detail

doHasManageAccess

public boolean doHasManageAccess(GeneralReference 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<GeneralReferenceDTO,GeneralReference,GeneralReferenceData,GeneralReferenceDataParams>

doHasViewAccess

public boolean doHasViewAccess(GeneralReference 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<GeneralReferenceDTO,GeneralReference,GeneralReferenceData,GeneralReferenceDataParams>

getSearchData

public GeneralReferenceSearchData getSearchData(UserLocatorVO locator)
                                         throws FrameworkException

Description copied from interface: GeneralReferenceService

Returns data used for search general references over the given user

Specified by:

getSearchData in interface GeneralReferenceService

Throws:

FrameworkException

getStatistics

public ReferenceStatisticsVO getStatistics(@NotNull
                                           @NotNull ReferenceStatisticsParams params)
                                    throws FrameworkException

Description copied from interface: GeneralReferenceService

Returns reference statistics for the given user. The params allows periods. The order of the resulting periods is the same as the order of the input periods. If no periods are specified, 3 statistics are returned: all time and last 30 days. The maximum allowed number of periods is 5.

Specified by:

getStatistics in interface GeneralReferenceService

Throws:

FrameworkException

isAccessible

public boolean isAccessible(SessionData sessionData,
                            GeneralReference 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<GeneralReferenceDTO,GeneralReference,GeneralReferenceData,GeneralReferenceDataParams>

search

public Page<GeneralReferenceEntryVO> search(GeneralReferenceQuery query)

Description copied from interface: GeneralReferenceService

Searches for references for a given owner, according to the specified query parameters

Specified by:

search in interface GeneralReferenceService

check

protected void check(User fromUser,
                     User toUser)

checkCreateNew

protected void checkCreateNew(GeneralReferenceDataParams 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<GeneralReferenceDTO,GeneralReference,GeneralReferenceData,GeneralReferenceDataParams>

getImplementation

protected GeneralReferenceServiceLocal 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<GeneralReferenceDTO,GeneralReference,GeneralReferenceData,GeneralReferenceDataParams>

onBeforeSave

protected void onBeforeSave(GeneralReferenceDTO dto,
                            GeneralReference entity)

Overrides:

onBeforeSave in class CRUDServiceSecurity<GeneralReferenceDTO,GeneralReference,GeneralReferenceData,GeneralReferenceDataParams>