Package com.brihaspathee.zeus.web.resource.interfaces

Interface RoleAPI

All Known Implementing Classes:
RoleAPIImpl
@RequestMapping("/api/v1/zeus/security/role") @Validated public interface RoleAPI
Created in Intellij IDEA User: Balaji Varadharajan Date: 05, July 2022 Time: 4:03 PM Project: Zeus Package Name: com.brihaspathee.zeus.web.resource.interfaces To change this template use File | Settings | File and Code Template

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleDto>>
    createRole(com.brihaspathee.zeus.security.model.RoleDto roleDto)
    Create a new Role
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleList>>
    getAllRoles()
    Get all the roles that are present in the system
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleList>>
    getRoleById(UUID roleId)
    Get Role by role id
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleList>>
    getRoleByRoleName(String roleName)
    Get Role by role name
    org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleDto>>
    updateRole(UUID roleId, com.brihaspathee.zeus.security.model.RoleDto roleDto)
    Update an existing Role

  • Method Details

    • getAllRoles

      @GetMapping org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleList>> getAllRoles()
      Get all the roles that are present in the system
      Returns:

    • getRoleById

      @GetMapping("/role-id/{roleId}") org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleList>> getRoleById(@PathVariable UUID roleId)
      Get Role by role id
      Parameters:
      roleId -
      Returns:

    • getRoleByRoleName

      @GetMapping("/role-name/{roleName}") org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleList>> getRoleByRoleName(@PathVariable String roleName)
      Get Role by role name
      Parameters:
      roleName -
      Returns:

    • createRole

      @PostMapping org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleDto>> createRole(@RequestBody com.brihaspathee.zeus.security.model.RoleDto roleDto)
      Create a new Role
      Returns:

    • updateRole

      @PutMapping("/{roleId}") org.springframework.http.ResponseEntity<com.brihaspathee.zeus.web.response.ZeusApiResponse<com.brihaspathee.zeus.security.model.RoleDto>> updateRole(@PathVariable UUID roleId, @RequestBody com.brihaspathee.zeus.security.model.RoleDto roleDto)
      Update an existing Role
      Returns: