org.cyclos.security.users

Class UserServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<UserDTO,User,UserData,UserDataParams>

org.cyclos.security.users.UserServiceSecurity

All Implemented Interfaces:

CRUDService<UserDTO,UserData,UserDataParams>, CRUDWithConfirmationPasswordService<UserDTO,UserData,UserDataParams>, Service, UserService

@Security
public class UserServiceSecurity
extends CRUDServiceSecurity<UserDTO,User,UserData,UserDataParams>
implements UserService

Security layer for UserService

Author:

luis

Field Summary

Fields inherited from class org.cyclos.security.CRUDServiceSecurity

entityClass

Fields inherited from interface org.cyclos.services.users.UserService

SELF

Constructor Summary

Constructors

Constructor and Description
UserServiceSecurity()

Method Summary

Modifier and Type	Method and Description
boolean	addContact(UserLocatorVO owner, UserLocatorVO contact) Adds the given contact to the given user (or logged user if null)'s contact list, returning whether the list has changed
boolean	canPerformOperation(User user, CRUDOperation operation) Returns whether the logged user can perform the given operation over the given entity
protected void	checkCreateNew(UserDataParams params) Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
boolean	checkQuery(AbstractUserQuery query)
boolean	doHasManageAccess(User user) Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(User user) Should be implemented in order to return whether the caller is allowed to view the given entity.
SerializableInputStream	exportToCSV(UserQuery params) Generates a CSV with the query result
ActiveConfigurationData	getActiveConfiguration(UserLocatorVO locator) Returns the ActiveConfigurationData, containing all the actual configuration for the user matching the given locator
UserWithRolesVO	getCurrentUser() Returns the current user logged in
protected UserServiceLocal	getImplementation() Should be implemented in order to return the actual implementation of the service
PublicRegistrationData	getPublicRegistrationData(InitialGroupVO group) Returns data for registering an user from the public registration
java.util.List<InitialGroupVO>	getPublicRegistrationGroups() Return the list of groups guests user can register
UserSearchData	getSearchData(UserSearchContext context) Gets data used on the search page, according to the given search type
java.util.List<GroupVO>	getUserRegistrationGroups() Return the list of groups the logged user can register new users for
ViewProfileData	getViewProfileData(UserLocatorVO locator) Return a ViewProfileData for the user matching the given locator
boolean	isAccessible(SessionData sessionData, User entity) Must be implemented in order to determine whether the given entity is accessible for the given session data.
UserDetailedVO	locate(UserLocatorVO locator) Locates an user by a customizable key.
protected void	onBeforeSave(UserDTO dto, User user)
SerializableInputStream	printUsers(UserQuery query) Generates the PDF content for an user listing
UserRegistrationResult	publicRegister(PublicRegistrationDTO dto) Registers an user from a public registration
UserRegistrationResult	register(UserRegistrationDTO dto) Registers an user
boolean	removeContact(UserLocatorVO owner, UserLocatorVO contact) Removes the given contact to the given user (or logged user if null)'s contact list, returning whether the list has changed
Page<UserWithFieldsVO>	search(UserQuery query) Search users according to the specified query parameters.
void	updateUserActivity(UserActivityType type) Updates user information status according to the given activity

Methods inherited from class org.cyclos.security.CRUDServiceSecurity

canViewHistoryLog, checkManageAccess, checkOperation, 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, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getAccountHandler, getAuthHandler, getBaseEntityManagerHandler, getChannelConfiguration, getConfiguration, getConversionHandler, getCustomFieldValueHandler, getEntityManagerHandler, getGroupsHandler, getLoggedBasicUser, getLoggedUser, getProducts, getProductsHandler, getReportHandler, getTranslatedName, getTranslatedValue, getUserLocatorHandler, getValidationResult, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, 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, getConfigurationHandler, getDataTranslationHandler, getFormatter, getFormatter, getFormatter, getLogger, getNotificationHandler, getProfileFieldHandler, getRemoteAddress, getSessionData, getTransactionHandler, getTranslationHandler, message, message, persist, processBatch, refresh, remove, 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.CRUDWithConfirmationPasswordService

getConfirmationPasswordInputForRemove, removeAllWithConfirmationPassword, removeWithConfirmationPassword, saveWithConfirmationPassword

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Constructor Detail

UserServiceSecurity

public UserServiceSecurity()

Method Detail

addContact

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

Description copied from interface: UserService

Adds the given contact to the given user (or logged user if null)'s contact list, returning whether the list has changed

Specified by:

addContact in interface UserService

Throws:

FrameworkException

canPerformOperation

public boolean canPerformOperation(User user,
                                   CRUDOperation operation)

Description copied from class: CRUDServiceSecurity

Returns whether the logged user can perform the given operation over the given entity

Overrides:

canPerformOperation in class CRUDServiceSecurity<UserDTO,User,UserData,UserDataParams>

checkQuery

public boolean checkQuery(AbstractUserQuery query)

doHasManageAccess

public boolean doHasManageAccess(User user)

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<UserDTO,User,UserData,UserDataParams>

doHasViewAccess

public boolean doHasViewAccess(User user)

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<UserDTO,User,UserData,UserDataParams>

exportToCSV

public SerializableInputStream exportToCSV(UserQuery params)

Description copied from interface: UserService

Generates a CSV with the query result

Specified by:

exportToCSV in interface UserService

getActiveConfiguration

public ActiveConfigurationData getActiveConfiguration(UserLocatorVO locator)
                                               throws EntityNotFoundException

Description copied from interface: UserService

Returns the ActiveConfigurationData, containing all the actual configuration for the user matching the given locator

Specified by:

getActiveConfiguration in interface UserService

Throws:

EntityNotFoundException

getCurrentUser

public UserWithRolesVO getCurrentUser()
                               throws FrameworkException

Description copied from interface: UserService

Returns the current user logged in

Specified by:

getCurrentUser in interface UserService

Throws:

FrameworkException

getPublicRegistrationData

public PublicRegistrationData getPublicRegistrationData(InitialGroupVO group)
                                                 throws FrameworkException

Description copied from interface: UserService

Returns data for registering an user from the public registration

Specified by:

getPublicRegistrationData in interface UserService

Throws:

FrameworkException

getPublicRegistrationGroups

public java.util.List<InitialGroupVO> getPublicRegistrationGroups()
                                                           throws FrameworkException

Description copied from interface: UserService

Return the list of groups guests user can register

Specified by:

getPublicRegistrationGroups in interface UserService

Throws:

FrameworkException

getSearchData

public UserSearchData getSearchData(UserSearchContext context)
                             throws FrameworkException

Description copied from interface: UserService

Gets data used on the search page, according to the given search type

Specified by:

getSearchData in interface UserService

Throws:

FrameworkException

getUserRegistrationGroups

public java.util.List<GroupVO> getUserRegistrationGroups()

Description copied from interface: UserService

Return the list of groups the logged user can register new users for

Specified by:

getUserRegistrationGroups in interface UserService

getViewProfileData

public ViewProfileData getViewProfileData(UserLocatorVO locator)

Description copied from interface: UserService

Return a ViewProfileData for the user matching the given locator

Specified by:

getViewProfileData in interface UserService

isAccessible

public boolean isAccessible(SessionData sessionData,
                            User 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<UserDTO,User,UserData,UserDataParams>

locate

public UserDetailedVO locate(UserLocatorVO locator)
                      throws FrameworkException

Description copied from interface: UserService

Locates an user by a customizable key. Fields are attempted in the following order (only the first non-blank field will be used for the search):

• Id
• Username
• E-mail
• Field value with field's id
• Field value with field's internal name
• Mobile phone

Specified by:

locate in interface UserService

Throws:

FrameworkException

printUsers

public SerializableInputStream printUsers(UserQuery query)

Description copied from interface: UserService

Generates the PDF content for an user listing

Specified by:

printUsers in interface UserService

publicRegister

public UserRegistrationResult publicRegister(PublicRegistrationDTO dto)
                                      throws FrameworkException

Description copied from interface: UserService

Registers an user from a public registration

Specified by:

publicRegister in interface UserService

Throws:

FrameworkException

register

public UserRegistrationResult register(UserRegistrationDTO dto)
                                throws ValidationException,
                                       PasswordException

Description copied from interface: UserService

Registers an user

Specified by:

register in interface UserService

Throws:

ValidationException

PasswordException

removeContact

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

Description copied from interface: UserService

Removes the given contact to the given user (or logged user if null)'s contact list, returning whether the list has changed

Specified by:

removeContact in interface UserService

Throws:

FrameworkException

search

public Page<UserWithFieldsVO> search(UserQuery query)
                              throws QueryParseException

Description copied from interface: UserService

Search users according to the specified query parameters. The returned objects will either contain the BasicUserVO.DISPLAY and BasicUserVO.SHORT_DISPLAY properties filled in or specific profile fields, depending on the products (permissions) of the viewing user. If there are profile fields marked to be returned, display and short display are not returned, as in most cases it would mean repeated information.

Specified by:

search in interface UserService

Throws:

QueryParseException

updateUserActivity

public void updateUserActivity(UserActivityType type)

Description copied from interface: UserService

Updates user information status according to the given activity

Specified by:

updateUserActivity in interface UserService

checkCreateNew

protected void checkCreateNew(UserDataParams 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<UserDTO,User,UserData,UserDataParams>

getImplementation

protected UserServiceLocal 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<UserDTO,User,UserData,UserDataParams>

onBeforeSave

protected void onBeforeSave(UserDTO dto,
                            User user)

Overrides:

onBeforeSave in class CRUDServiceSecurity<UserDTO,User,UserData,UserDataParams>