Class BackofficeController

java.lang.Object
es.kukenan.smartfi.microservice.onboarding.controller.BackofficeController

@RestController public class BackofficeController extends Object
Rest service exposed for backoffice.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Authority (role) required in order to be able to invoke greeting API.
    static final String
    REST API onboarding resources for backoffice base path.
    static final String
    REST API onboarding resources base path.
    static final String
    REST API onboarding resources base path.
    static final String
    REST API base path.
    static final String
    REST API find user by document id path.
    static final String
    REST API onboarding user list path.
    (package private) BackofficeService
    Backoffice service.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.dto.backoffice.UserDetailBackofficeDTO>>
    getUser(es.kukenan.smartfi.dto.backoffice.UserBackofficeRequestDTO userBackofficeRequest)
    Find if user exist by Document Id.
    org.springframework.http.ResponseEntity<Object>
    getUsers(Integer pageNumber, Integer pageSize, String sortedBy, es.kukenan.smartfi.dto.backoffice.UserBackofficeRequestDTO userBackofficeRequest)
    Get list of onboarding Users.
    org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.microservice.backoffice.dtos.core.contract.Contract>>
    saveAdvanceUser(es.kukenan.smartfi.dto.backoffice.user.CreateAdvanceUserDto createAdvanceUserDto, String userIp, String userAgent)
    Post onboarding user from backoffice microservice.
    org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.microservice.backoffice.dtos.core.contract.Contract>>
    saveCreditUser(es.kukenan.smartfi.dto.backoffice.user.CreateCreditUserDto createCreditUserDto, String userIp, String userAgent)
    Post onboarding user from backoffice microservice.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • API_PATH

      public static final String API_PATH
      REST API base path.
      See Also:
    • API_BACKOFFICE_PATH

      public static final String API_BACKOFFICE_PATH
      REST API onboarding resources for backoffice base path.
      See Also:
    • API_USERS_PATH

      public static final String API_USERS_PATH
      REST API onboarding user list path.
      See Also:
    • API_USER_PATH

      public static final String API_USER_PATH
      REST API find user by document id path.
      See Also:
    • API_ONBOARDING_CREDIT_PATH

      public static final String API_ONBOARDING_CREDIT_PATH
      REST API onboarding resources base path.
      See Also:
    • API_ONBOARDING_ADVANCE_PATH

      public static final String API_ONBOARDING_ADVANCE_PATH
      REST API onboarding resources base path.
      See Also:
    • API_AUTHORITIES

      public static final String API_AUTHORITIES
      Authority (role) required in order to be able to invoke greeting API.
      See Also:
    • backofficeService

      @Autowired BackofficeService backofficeService
      Backoffice service.
  • Constructor Details

    • BackofficeController

      public BackofficeController()
  • Method Details

    • getUsers

      @PreAuthorize("(hasRole(\'ROLE_ACCESS_USER\') or hasRole(\'ROLE_ACCESS_AGENT\') or hasRole(\'ROLE_ACCESS_SUPERVISOR\')) and (hasRole(\'ROLE_LEVEL_USER_PWD\') or hasRole(\'ROLE_LEVEL_USER_SCA\'))") @PostMapping(path="/api/v1/backoffice/users", produces="application/json", consumes="application/json") public org.springframework.http.ResponseEntity<Object> getUsers(@RequestParam(name="pageNumber",required=false) Integer pageNumber, @RequestParam(name="pageSize",required=false) Integer pageSize, @RequestParam(name="sortedBy",required=false) String sortedBy, @RequestBody es.kukenan.smartfi.dto.backoffice.UserBackofficeRequestDTO userBackofficeRequest)
      Get list of onboarding Users.
      Parameters:
      pageNumber - page number for search
      pageSize - size of each page
      sortedBy - parameter to be sorted
      userBackofficeRequest - filtered request fields
      Returns:
      User data
    • getUser

      @PreAuthorize("(hasRole(\'ROLE_ACCESS_USER\') or hasRole(\'ROLE_ACCESS_AGENT\') or hasRole(\'ROLE_ACCESS_SUPERVISOR\')) and (hasRole(\'ROLE_LEVEL_USER_PWD\') or hasRole(\'ROLE_LEVEL_USER_SCA\'))") @PostMapping(path="/api/v1/backoffice/user", produces="application/json", consumes="application/json") public org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.dto.backoffice.UserDetailBackofficeDTO>> getUser(@RequestBody es.kukenan.smartfi.dto.backoffice.UserBackofficeRequestDTO userBackofficeRequest)
      Find if user exist by Document Id.
      Parameters:
      userBackofficeRequest - filtered request fields
      Returns:
      User data
    • saveCreditUser

      @PostMapping(path="/api/v1/backoffice/user/credit", consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.microservice.backoffice.dtos.core.contract.Contract>> saveCreditUser(@RequestBody es.kukenan.smartfi.dto.backoffice.user.CreateCreditUserDto createCreditUserDto, @RequestHeader(name="X-SKYLINE-USER-IP",defaultValue="N/A") String userIp, @RequestHeader(name="X-USER-AGENT",defaultValue="N/A") String userAgent)
      Post onboarding user from backoffice microservice.
      Parameters:
      createCreditUserDto - CreateCreditUserDto
      userIp - user real ip
      userAgent - user-agent header
      Returns:
      Http status and userid. If user information is correct return user id. if user information is incorrect then show define error message.
    • saveAdvanceUser

      @PostMapping(path="/api/v1/backoffice/user/advance", consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.microservice.backoffice.dtos.core.contract.Contract>> saveAdvanceUser(@RequestBody es.kukenan.smartfi.dto.backoffice.user.CreateAdvanceUserDto createAdvanceUserDto, @RequestHeader(name="X-SKYLINE-USER-IP",defaultValue="N/A") String userIp, @RequestHeader(name="X-USER-AGENT",defaultValue="N/A") String userAgent)
      Post onboarding user from backoffice microservice.
      Parameters:
      createAdvanceUserDto - CreateAdvanceUserDto
      userIp - user real ip
      userAgent - user-agent header
      Returns:
      Http status and userid. If user information is correct return user id. if user information is incorrect then show define error message.