+ [ all classes ]
+ [ com.lambdaschool.usermodel.controllers ]
+
+
+Coverage Summary for Class: RolesController (com.lambdaschool.usermodel.controllers)
+ +| Class | ++ Class, % + | ++ Method, % + | ++ Line, % + | +
|---|---|---|---|
| RolesController | ++ + 0% + + + (0/ 1) + + | ++ + 0% + + + (0/ 6) + + | ++ + 0% + + + (0/ 18) + + | +
+
+ + +
1 package com.lambdaschool.usermodel.controllers;
+2
+3 import com.lambdaschool.usermodel.models.Role;
+4 import com.lambdaschool.usermodel.services.RoleService;
+5 import org.springframework.beans.factory.annotation.Autowired;
+6 import org.springframework.http.HttpHeaders;
+7 import org.springframework.http.HttpStatus;
+8 import org.springframework.http.ResponseEntity;
+9 import org.springframework.web.bind.annotation.GetMapping;
+10 import org.springframework.web.bind.annotation.PathVariable;
+11 import org.springframework.web.bind.annotation.PostMapping;
+12 import org.springframework.web.bind.annotation.PutMapping;
+13 import org.springframework.web.bind.annotation.RequestBody;
+14 import org.springframework.web.bind.annotation.RequestMapping;
+15 import org.springframework.web.bind.annotation.RestController;
+16 import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
+17
+18 import javax.validation.Valid;
+19 import java.net.URI;
+20 import java.util.List;
+21
+22 /**
+23 * The entry point for clients to access role data
+24 * <p>
+25 * Note: we cannot update a role
+26 * we cannot update a role
+27 * working with the "non-owner" object in a many to many relationship is messy
+28 * we will be fixing that!
+29 */
+30 @RestController
+31 @RequestMapping("/roles")
+32 public class RolesController
+33 {
+34 /**
+35 * Using the Role service to process Role data
+36 */
+37 @Autowired
+38 RoleService roleService;
+39
+40 /**
+41 * List of all roles
+42 * <br>Example: <a href="http://localhost:2019/roles/roles">http://localhost:2019/roles/roles</a>
+43 *
+44 * @return JSON List of all the roles and their associated users
+45 * @see RoleService#findAll() RoleService.findAll()
+46 */
+47 @GetMapping(value = "/roles",
+48 produces = "application/json")
+49 public ResponseEntity<?> listRoles()
+50 {
+51 List<Role> allRoles = roleService.findAll();
+52 return new ResponseEntity<>(allRoles,
+53 HttpStatus.OK);
+54 }
+55
+56 /**
+57 * The Role referenced by the given primary key
+58 * <br>Example: <a href="http://localhost:2019/roles/role/3">http://localhost:2019/roles/role/3</a>
+59 *
+60 * @param roleId The primary key (long) of the role you seek
+61 * @return JSON object of the role you seek
+62 * @see RoleService#findRoleById(long) RoleService.findRoleById(long)
+63 */
+64 @GetMapping(value = "/role/{roleId}",
+65 produces = "application/json")
+66 public ResponseEntity<?> getRoleById(
+67 @PathVariable
+68 Long roleId)
+69 {
+70 Role r = roleService.findRoleById(roleId);
+71 return new ResponseEntity<>(r,
+72 HttpStatus.OK);
+73 }
+74
+75 /**
+76 * The Role with the given name
+77 * <br>Example: <a href="http://localhost:2019/roles/role/name/data">http://localhost:2019/roles/role/name/data</a>
+78 *
+79 * @param roleName The name of the role you seek
+80 * @return JSON object of the role you seek
+81 * @see RoleService#findByName(String) RoleService.findByName(String)
+82 */
+83 @GetMapping(value = "/role/name/{roleName}",
+84 produces = "application/json")
+85 public ResponseEntity<?> getRoleByName(
+86 @PathVariable
+87 String roleName)
+88 {
+89 Role r = roleService.findByName(roleName);
+90 return new ResponseEntity<>(r,
+91 HttpStatus.OK);
+92 }
+93
+94 /**
+95 * Given a complete Role object, create a new Role record
+96 * <br>Example: <a href="http://localhost:2019/roles/role">http://localhost:2019/roles/role</a>
+97 *
+98 * @param newRole A complete new Role object
+99 * @return A location header with the URI to the newly created role and a status of CREATED
+100 * @see RoleService#save(Role) RoleService.save(Role)
+101 */
+102 @PostMapping(value = "/role",
+103 consumes = "application/json")
+104 public ResponseEntity<?> addNewRole(
+105 @Valid
+106 @RequestBody
+107 Role newRole)
+108 {
+109 // ids are not recognized by the Post method
+110 newRole.setRoleid(0);
+111 newRole = roleService.save(newRole);
+112
+113 // set the location header for the newly created resource
+114 HttpHeaders responseHeaders = new HttpHeaders();
+115 URI newRoleURI = ServletUriComponentsBuilder.fromCurrentRequest()
+116 .path("/{roleid}")
+117 .buildAndExpand(newRole.getRoleid())
+118 .toUri();
+119 responseHeaders.setLocation(newRoleURI);
+120
+121 return new ResponseEntity<>(null,
+122 responseHeaders,
+123 HttpStatus.CREATED);
+124 }
+125
+126 /**
+127 * The process allows you to update a role name only!
+128 * <br>Example: <a href="http://localhost:2019/roles/role/3">http://localhost:2019/roles/role/3</a>
+129 *
+130 * @param roleid The primary key (long) of the role you wish to update
+131 * @param newRole The new name (String) for the role
+132 * @return Status of OK
+133 */
+134 @PutMapping(value = "/role/{roleid}",
+135 consumes = {"application/json"})
+136 public ResponseEntity<?> putUpdateRole(
+137 @PathVariable
+138 long roleid,
+139 @Valid
+140 @RequestBody
+141 Role newRole)
+142 {
+143 newRole = roleService.update(roleid,
+144 newRole);
+145 return new ResponseEntity<>(HttpStatus.OK);
+146 }
+147 }
+
+