refactor: die REST-Methoden schicker gemacht

Thomas Ziemer
1 parent 2392615c
Showing 4 changed files with 71 additions and 24 deletions
src/main/java/net/ziemers/swxercise/db/dao/GenericDao.java
src/main/java/net/ziemers/swxercise/lg/user/service/UserService.java
src/main/java/net/ziemers/swxercise/ui/UserViewController.java
src/test/java/net/ziemers/swxercise/ui/RestViewControllerTest.java → src/test/java/net/ziemers/swxercise/ui/UserViewControllerTest.java
@@ -35,6 +35,13 @@ public class GenericDao {
         return entityManager.merge(entity);
     }
  
+    public <T extends BaseEntity> T remove(Class<T> entityType, Long primaryKey) {
+        final T entity = findById(entityType, primaryKey);
+
+        entityManager.remove(entity);
+        return entity;
+    }
+
     /**
      * @param entityType Entity-Typ.
      * @param primaryKey Id
@@ -5,7 +5,6 @@ import java.util.Collection;
 import javax.ejb.Stateless;
 import javax.inject.Inject;
  
-import net.ziemers.swxercise.db.dao.GenericDao;
 import net.ziemers.swxercise.db.dao.user.UserDao;
 import net.ziemers.swxercise.lg.model.user.Profile;
 import net.ziemers.swxercise.lg.model.user.User;
@@ -25,7 +24,7 @@ public class UserService {
         return dao.findAll(User.class);
     }
  
-    public Long saveUser(final UserDto userDto) {
+    public Long createUser(final UserDto userDto) {
         final Profile profile = new Profile(userDto.getUsername(), userDto.getPassword());
  
         // wir füllen das User-Objekt mit Method Chaining
@@ -35,4 +34,8 @@ public class UserService {
         return dao.save(user);
     }
  
+    public void deleteUser(final Long id) {
+        dao.remove(User.class, id);
+    }
+
 }
@@ -21,25 +21,25 @@ public class UserViewController {
     private UserService userService;
  
     /**
-     * Schickt eine Hello-Nachricht zum Aufrufer zurück.
+     * Liefert alle User-Objekte zurück.
      *
-     * @param name der Name, der in der Hallo-Nachricht angegeben wird
-     * @return eine Hallo-Nachricht
+     * @return die User-Objekte.
      */
     @GET
-    @Path("/hello/{name}")
-    @Produces(MediaType.TEXT_PLAIN)
-    public String helloPath(@PathParam("name") String name) {
-        return String.format("Hello %s", name);
-    }
-
-    @GET
-    @Path("/all")
     @Produces(MediaType.APPLICATION_JSON)
     public Collection<User> getAllUsers() {
         return userService.findAllUsers();
     }
  
+    /**
+     * Liefert das User-Objekt mit der gewünschten Id zurück.
+     *
+     * Aufruf:
+     * GET http://localhost:8080/swxercise/rest/users/42
+     *
+     * @param id die Id des gewünschten User-Objekts
+     * @return das User-Objekt.
+     */
     @GET
     @Path("{id}")
     @Produces(MediaType.APPLICATION_JSON)
@@ -47,12 +47,54 @@ public class UserViewController {
         return userService.findUser(id);
     }
  
+    /**
+     * Erstellt ein neues User-Objekt mit den gewünschten Eigenschaften, welche mittels {@link UserDto} definiert werden.
+     *
+     * Aufruf:
+     * POST http://localhost:8080/swxercise/rest/users
+     *
+     * @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link UserDto}
+     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
+     * @throws Exception wirft eine Exception, wenn das Erstellen des UserDto fehlschlug
+     */
+    @POST
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Produces({MediaType.TEXT_PLAIN})
+    public String createUser(UserDto dto) throws Exception {
+        userService.createUser(dto);
+        return "Ok";
+    }
+
+    /**
+     * Aktualisiert das User-Objekt mit der gewünschten Id mit den Eigenschaften, welche mittels {@link UserDto} definiert werden.
+     *
+     * Aufruf:
+     * PUT http://localhost:8080/swxercise/rest/users/42
+     *
+     * @param id die Id des gewünschten User-Objekts
+     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
+     * @throws Exception wirft eine Exception, wenn das Erstellen des UserDto fehlschlug
+     */
     @PUT
-    @Path("/user")
+    @Path("{id}")
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces({MediaType.TEXT_PLAIN})
-    public String postUser(UserDto userDto) throws Exception {
-        userService.saveUser(userDto);
+    public String updateUser(@PathParam("id") Long id) throws Exception {
+        // TODO noch zu implementieren
+        return "Ok";
+    }
+
+    /**
+     * Löscht das User-Objekt mit der gewünschten Id.
+     *
+     * @param id die Id des gewünschten User-Objekts
+     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
+     */
+    @DELETE
+    @Path("{id}")
+    @Produces({MediaType.TEXT_PLAIN})
+    public String deleteUser(@PathParam("id") Long id) {
+        userService.deleteUser(id);
         return "Ok";
     }
  
@@ -7,19 +7,14 @@ import org.mockito.InjectMocks;
 import org.mockito.junit.MockitoJUnitRunner;
  
 @RunWith(MockitoJUnitRunner.class)
-public class RestViewControllerTest {
-    
+public class UserViewControllerTest {
+
     @InjectMocks
     private UserViewController underTest;
  
     @Test
     public void test() {
-        final String name = "Tom";
-        final String expected = "Hello " + name;
-        String actual;
-
-        actual = underTest.helloPath(name);
-        Assert.assertEquals(expected, actual);
+        // TODO noch zu implementieren
     }
  
 }