Package org.cyclos.services.users
Interface BasicUserService
-
- All Superinterfaces:
Service
- All Known Subinterfaces:
BasicUserServiceLocal
public interface BasicUserService extends Service
Service interface for validating a user/operator and search access logs
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Page<BasicUserVO>autocomplete(@NotNull UserQuery query)Try to locate a user with the keyword given in the query and returns it if finds any, otherwise returnsUserService.search(UserQuery).AccessLogSearchDatagetAccessLogSearchData()Return the data to search the access logsAccessLogVOloadAccessLog(@NotNull Long id)Loads anAccessLogVOby idvoidmanuallyValidateEmailChange(@NotNull UserLocatorVO locator)Makes a pending e-mail change as doneUserValidationResultmanuallyValidateRegistration(@NotNull UserLocatorVO locator)Makes a pending user to be activevoidresendEmailChangeMail(@NotNull UserLocatorVO locator)Re-sends the e-mail change e-mail to a uservoidresendRegistrationValidationMail(@NotNull UserLocatorVO locator)Re-sends the validation mail to a pending userPage<AccessLogResult>searchAccessLogs(@NotNull AccessLogQuery query)Search access logs according to the specified query parameters.voidupdateUserActivity(@NotNull UserActivityType type)Updates user information status according to the given activityLongvalidateEmailChange(@NotNull String validationKey)Validate an e-mail change for the given validation key, returning the affected user identifierUserValidationResultvalidateRegistration(@NotNull String validationKey)Validate user registration which was pending e-mail verification, via a provided key
-
-
-
Method Detail
-
autocomplete
Page<BasicUserVO> autocomplete(@NotNull @NotNull UserQuery query)
Try to locate a user with the keyword given in the query and returns it if finds any, otherwise returnsUserService.search(UserQuery).
-
getAccessLogSearchData
AccessLogSearchData getAccessLogSearchData()
Return the data to search the access logs
-
loadAccessLog
AccessLogVO loadAccessLog(@NotNull @NotNull Long id)
Loads anAccessLogVOby id
-
manuallyValidateEmailChange
void manuallyValidateEmailChange(@NotNull @NotNull UserLocatorVO locator) throws FrameworkExceptionMakes a pending e-mail change as done- Throws:
FrameworkException
-
manuallyValidateRegistration
UserValidationResult manuallyValidateRegistration(@NotNull @NotNull UserLocatorVO locator) throws FrameworkException
Makes a pending user to be active- Throws:
FrameworkException
-
resendEmailChangeMail
void resendEmailChangeMail(@NotNull @NotNull UserLocatorVO locator) throws FrameworkExceptionRe-sends the e-mail change e-mail to a user- Throws:
FrameworkException
-
resendRegistrationValidationMail
void resendRegistrationValidationMail(@NotNull @NotNull UserLocatorVO locator) throws FrameworkExceptionRe-sends the validation mail to a pending user- Throws:
FrameworkException
-
searchAccessLogs
Page<AccessLogResult> searchAccessLogs(@NotNull @NotNull AccessLogQuery query) throws FrameworkException
Search access logs according to the specified query parameters.- Throws:
FrameworkException
-
updateUserActivity
void updateUserActivity(@NotNull @NotNull UserActivityType type) throws FrameworkExceptionUpdates user information status according to the given activity- Throws:
FrameworkException
-
validateEmailChange
Long validateEmailChange(@NotNull @NotNull String validationKey) throws FrameworkException
Validate an e-mail change for the given validation key, returning the affected user identifier- Throws:
FrameworkException
-
validateRegistration
UserValidationResult validateRegistration(@NotNull @NotNull String validationKey) throws FrameworkException
Validate user registration which was pending e-mail verification, via a provided key- Throws:
FrameworkException
-
-