org.cyclos.impl.users

Interface UserServiceLocal

All Superinterfaces:

CRUDService<UserDTO,UserData,UserDataParams>, org.cyclos.impl.CRUDServiceLocal<User,UserDTO,UserData,UserDataParams>, CRUDWithConfirmationPasswordService<UserDTO,UserData,UserDataParams>, Service, UserService

public interface UserServiceLocal
extends UserService, org.cyclos.impl.CRUDServiceLocal<User,UserDTO,UserData,UserDataParams>

Local interface for UserService

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
void	activateUserIfNeeded(User user) It activates the user's accounts, create a password (if needed) and send the activation email only if the user's group is an active one.
boolean	canAddToContacts(User user) Returns true if the logged user can add the given user to his contacts list
int	countTotalUsers() Returns the total number of users (not admins) which are not removed
boolean	existsUserWithEmail(java.lang.String email) Returns true if there exists a user with the given email.
boolean	existsUserWithMobilePhone(java.lang.String normalizedMobilePhone) Returns true if there exists a user with the given normalized mobile phone.
void	fill(AbstractUserSearchData data, boolean searchOverBrokeredUsers) Fills-in the common fields of an AbstractUserSearchData
java.lang.String	generateNewUsername(ConfigurationAccessor configurationAccessor) Generates an username for the given configuration.
GroupVisibility	getGroupVisibility(boolean brokered) Returns the GroupVisibility for the current user, optionally over brokered users
java.util.Date	getLastLogin() Returns the last login date of the logged user, or null if never logged in before, or not logged-in
org.cyclos.impl.utils.validation.Validator	getValidator(Group group, UserDTO userDTO, UserRegistration registration) Returns a user validator
UserRegistrationResult	importUser(UserRegistrationDTO dto) Imports an user
boolean	isContact(User user) Returns whether the given user is a contact of the logged user
com.mysema.commons.lang.CloseableIterator<User>	iterateByGroups(java.util.Collection<? extends Group> groups) Iterates all users on the given groups
com.mysema.commons.lang.CloseableIterator<java.lang.Long>	iterateIds(UserQuery query) Iterates users according to the specified query parameters
void	onRegistrationValidation(User user, boolean generatePasswordEvenIfManual, boolean sendActivationEmail) Performs additional actions when an user registration is validated
User	registerByPopulator(UserRegistrationDTO params) Registers an user via a populator, like setup or network with data
org.cyclos.impl.users.RegisterUserBySmsResult	registerBySms(org.cyclos.impl.users.RegisterUserBySmsParams params) Registers an user via SMS
void	validate(UserDTO dto, UserRegistration registration) Validates the user information according to the registration context

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

addContact, exportToCSV, getActiveConfiguration, getCurrentUser, getPublicRegistrationData, getPublicRegistrationGroups, getSearchData, getUserRegistrationGroups, getViewProfileData, locate, printUsers, publicRegister, register, removeContact, search, updateUserActivity

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

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, toDTO, toEntity, validate

Method Detail

activateUserIfNeeded

void activateUserIfNeeded(User user)
                          throws FrameworkException

It activates the user's accounts, create a password (if needed) and send the activation email only if the user's group is an active one.

Throws:

FrameworkException

canAddToContacts

boolean canAddToContacts(User user)
                         throws FrameworkException

Returns true if the logged user can add the given user to his contacts list

Throws:

FrameworkException

countTotalUsers

int countTotalUsers()

Returns the total number of users (not admins) which are not removed

existsUserWithEmail

boolean existsUserWithEmail(java.lang.String email)

Returns true if there exists a user with the given email.

existsUserWithMobilePhone

boolean existsUserWithMobilePhone(java.lang.String normalizedMobilePhone)

Returns true if there exists a user with the given normalized mobile phone.

fill

void fill(AbstractUserSearchData data,
        boolean searchOverBrokeredUsers)
          throws FrameworkException

Fills-in the common fields of an AbstractUserSearchData

Throws:

FrameworkException

generateNewUsername

java.lang.String generateNewUsername(ConfigurationAccessor configurationAccessor)
                                     throws FrameworkException

Generates an username for the given configuration. It is guaranteed that the username is unique for the configuration's network.

Throws:

FrameworkException

getGroupVisibility

GroupVisibility getGroupVisibility(boolean brokered)
                                   throws FrameworkException

Returns the GroupVisibility for the current user, optionally over brokered users

Throws:

FrameworkException

getLastLogin

java.util.Date getLastLogin()
                            throws FrameworkException

Returns the last login date of the logged user, or null if never logged in before, or not logged-in

Throws:

FrameworkException

getValidator

org.cyclos.impl.utils.validation.Validator getValidator(Group group,
                                                      UserDTO userDTO,
                                                      UserRegistration registration)
                                                        throws FrameworkException

Returns a user validator

Throws:

FrameworkException

importUser

UserRegistrationResult importUser(UserRegistrationDTO dto)

Imports an user

isContact

boolean isContact(User user)
                  throws FrameworkException

Returns whether the given user is a contact of the logged user

Throws:

FrameworkException

iterateByGroups

com.mysema.commons.lang.CloseableIterator<User> iterateByGroups(java.util.Collection<? extends Group> groups)
                                                                throws FrameworkException

Iterates all users on the given groups

Throws:

FrameworkException

iterateIds

com.mysema.commons.lang.CloseableIterator<java.lang.Long> iterateIds(UserQuery query)
                                                                     throws FrameworkException,
                                                                            QueryParseException

Iterates users according to the specified query parameters

Throws:

FrameworkException

QueryParseException

onRegistrationValidation

void onRegistrationValidation(User user,
                            boolean generatePasswordEvenIfManual,
                            boolean sendActivationEmail)
                              throws FrameworkException

Performs additional actions when an user registration is validated

Throws:

FrameworkException

registerByPopulator

User registerByPopulator(UserRegistrationDTO params)
                         throws FrameworkException

Registers an user via a populator, like setup or network with data

Throws:

FrameworkException

registerBySms

org.cyclos.impl.users.RegisterUserBySmsResult registerBySms(org.cyclos.impl.users.RegisterUserBySmsParams params)
                                                            throws FrameworkException

Registers an user via SMS

Throws:

FrameworkException

validate

void validate(UserDTO dto,
            UserRegistration registration)

Validates the user information according to the registration context