org.cyclos.security.users

Class ContactServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<ContactDTO,Contact,ContactData,ContactDataParams>

org.cyclos.security.users.ContactServiceSecurity

All Implemented Interfaces:

CRUDService<ContactDTO,ContactData,ContactDataParams>, CRUDWithConfirmationPasswordService<ContactDTO,ContactData,ContactDataParams>, Service, ContactService

@Security
public class ContactServiceSecurity
extends CRUDServiceSecurity<ContactDTO,Contact,ContactData,ContactDataParams>
implements ContactService

Security layer for ContactService

Author:

luis

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 and Description
ContactServiceSecurity()

Method Summary

Modifier and Type	Method and Description
protected void	checkCreateNew(ContactDataParams params) Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
protected void	customizeData(ContactData data) Can be overridden in order to process the returned data object for the given entity
protected boolean	doHasManageAccess(Contact contact) Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(Contact contact) Should be implemented in order to return whether the caller is allowed to view the given entity.
protected ContactServiceLocal	getImplementation() Should be implemented in order to return the actual implementation of the service
ContactSearchData	getSearchData(UserLocatorVO ownerVO) Returns data for searching contacts of the given owner.
boolean	isAccessible(SessionData sessionData, Contact entity) Must be implemented in order to determine whether the given entity is accessible for the given session data.
boolean	removeByOwnerAndContact(UserLocatorVO owner, UserLocatorVO contact) Removes the contact, if exists, for the given owner and contact users.
Page<ContactVO>	search(ContactQuery query) Searches the contacts according to the given query.

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, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

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

Constructor Detail

ContactServiceSecurity

public ContactServiceSecurity()

Method Detail

doHasViewAccess

public boolean doHasViewAccess(Contact contact)

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<ContactDTO,Contact,ContactData,ContactDataParams>

getSearchData

public ContactSearchData getSearchData(UserLocatorVO ownerVO)
                                throws FrameworkException

Description copied from interface: ContactService

Returns data for searching contacts of the given owner. If no owner is given, it is assumed the logged user.

Specified by:

getSearchData in interface ContactService

Throws:

FrameworkException

isAccessible

public boolean isAccessible(SessionData sessionData,
                            Contact 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<ContactDTO,Contact,ContactData,ContactDataParams>

removeByOwnerAndContact

public boolean removeByOwnerAndContact(UserLocatorVO owner,
                                       UserLocatorVO contact)
                                throws FrameworkException

Description copied from interface: ContactService

Removes the contact, if exists, for the given owner and contact users. If no owner is given, it is assumed the logged user.

Specified by:

removeByOwnerAndContact in interface ContactService

Returns:

Whether a contact was removed

Throws:

FrameworkException

search

public Page<ContactVO> search(ContactQuery query)
                       throws FrameworkException

Description copied from interface: ContactService

Searches the contacts according to the given query. If the query has no owner it is assumed the logged user.

Specified by:

search in interface ContactService

Throws:

FrameworkException

checkCreateNew

protected void checkCreateNew(ContactDataParams 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<ContactDTO,Contact,ContactData,ContactDataParams>

customizeData

protected void customizeData(ContactData 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<ContactDTO,Contact,ContactData,ContactDataParams>

doHasManageAccess

protected boolean doHasManageAccess(Contact contact)

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<ContactDTO,Contact,ContactData,ContactDataParams>

getImplementation

protected ContactServiceLocal 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<ContactDTO,Contact,ContactData,ContactDataParams>