Package tr.com.havelsan.javarch.oauth.authz.cloud.client.module.user.service

Interface HvlAuthzUserOperationalRestService

All Known Implementing Classes:
HvlAuthzUserRestController
@Validated @HvlPrivateFeignRestService @FeignClient(name="userPrivateRestService", path="${hvl.oauth.authz.service.user.path:/users}", url="${hvl.oauth.authz.service.user.url:${hvl.oauth.authz.service.url}}") public interface HvlAuthzUserOperationalRestService
A restful service which provides specific operational methods for user.

  • Method Details

    • save

      @PostMapping(consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> save(@NotNull @Valid @RequestBody @NotNull @Valid HvlOAuthUserModel userModel)
      Save user.
      Parameters:
      userModel - the user model
      Returns:
      the hvl response

    • saveWithPredefinedValues

      @PostMapping(path="/default-create", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> saveWithPredefinedValues(@NotNull @Valid @RequestBody @NotNull @Valid HvlOAuthUserModel userModel)
      saveWithPredefinedValues is a method which is used to add new user data with predefined values which can be defined by administrator. For example, If there is a record for user type of user trying to be added matching with predefined role, system would create a profile authorized with this predefined roles for this user.
      Parameters:
      userModel - the user model
      Returns:
      hvl response

    • update

      @Validated(tr.com.havelsan.javarch.data.commons.validation.HvlConstraintGroups.ModifyingOperation.class) @PutMapping(consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> update(@NotNull @Valid @RequestBody @NotNull @Valid HvlOAuthUserModel userModel)
      Update user.
      Parameters:
      userModel - the user model
      Returns:
      the hvl response

    • deleteByUuid

      @DeleteMapping(path="/by-uuid/{uuid}", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> deleteByUuid(@NotBlank @Size(min=36,max=36) @PathVariable("uuid") @NotBlank @Size(min=36,max=36) String uuid)
      Delete user by uuid.
      Parameters:
      uuid - the uuid
      Returns:
      the hvl response

    • changePasswordByAdmin

      @PutMapping(path="/password-by-admin", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> changePasswordByAdmin(@NotNull @Valid @RequestBody @NotNull @Valid HvlOAuthUserChangePasswordByAdminModel userChangePasswordByAdminModel)
      Change password by admin.
      Parameters:
      userChangePasswordByAdminModel - the user change password by admin model
      Returns:
      the hvl response

    • changePassword

      @PutMapping(path="/password", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> changePassword(@NotNull @Valid @RequestBody @NotNull @Valid HvlOAuthUserChangePasswordModel userChangePasswordModel)
      Change password by user.
      Parameters:
      userChangePasswordModel - the user change password model
      Returns:
      the hvl response

    • changePasswordUsingVerification

      @PutMapping(path="/password-with-verification", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> changePasswordUsingVerification(@NotNull @Valid @RequestBody @NotNull @Valid HvlOAuthUserChangePasswordWithVerificationModel userChangePasswordWithVerificationModel)
      changePasswordUsingVerification is a method which is used to change user password using verification way.
      Parameters:
      userChangePasswordWithVerificationModel - the user change password with verification model
      Returns:
      the hvl response

    • lock

      @PutMapping(path="/lock", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> lock(@NotNull @Valid @RequestBody @NotNull @Valid HvlOAuthUserLockModel userLockModel)
      Lock user.
      Parameters:
      userLockModel - the userLockModel
      Returns:
      the hvl response

    • unlock

      @GetMapping(path="/unlock/by-uuid/{uuid}", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> unlock(@NotBlank @Size(min=36,max=36) @PathVariable("uuid") @NotBlank @Size(min=36,max=36) String uuid)
      Unlock user.
      Parameters:
      uuid - the uuid
      Returns:
      the hvl response

    • saveLdapEntry

      @PostMapping(path="/ldap", consumes="application/json", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<HvlOAuthUserLdapResultModel> saveLdapEntry(@NotNull @Valid @RequestBody @NotNull @Valid HvlOAuthUserLdapPersistModel persistLdapModel)
      Save ldap entry hvl response.
      Parameters:
      persistLdapModel - the persist ldap model
      Returns:
      the hvl response