feature: UserViewController und UserService optimiert

Thomas Ziemer
1 parent 86ec838e
Showing 6 changed files with 77 additions and 34 deletions
pom.xml
src/main/java/net/ziemers/swxercise/lg/user/service/UserService.java
src/main/java/net/ziemers/swxercise/ui/OtherViewController.java
src/main/java/net/ziemers/swxercise/ui/RestResponse.java
src/main/java/net/ziemers/swxercise/ui/UserViewController.java
src/main/java/net/ziemers/swxercise/ui/enums/ResponseState.java
@@ -43,6 +43,7 @@
 			<groupId>javax.ws.rs</groupId>
 			<artifactId>javax.ws.rs-api</artifactId>
 			<version>${jaxrs-version}</version>
+			<scope>provided</scope>
 		</dependency>
 		<dependency>
 			<groupId>junit</groupId>
@@ -81,6 +82,7 @@
 			<groupId>mysql</groupId>
 			<artifactId>mysql-connector-java</artifactId>
 			<version>${mysql-version}</version>
+			<scope>provided</scope>
 		</dependency>
         <dependency>
             <groupId>org.jglue.cdi-unit</groupId>
@@ -58,11 +58,10 @@ public class UserService {
     }
     public boolean deleteUser() {
+        // ist zurzeit ein Benutzer angemeldet, können wir ihn löschen
         final User user = sessionContext.getUser();
-
         if (user != null) {
-            dao.remove(User.class, user.getId());
-            return true;
+            return dao.remove(User.class, user.getId()) != null;
         }
         return false;
     }
+package net.ziemers.swxercise.ui;
+
+import javax.faces.bean.ApplicationScoped;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+
+/**
+ * REST-Methoden, die nirgendwo besser hinpassen.
+ */
+@ApplicationScoped
+@Path(UserViewController.webContextPath)
+public class OtherViewController {
+
+    static final String webContextPath = "/";
+
+    @GET
+    @Path("/v1/ping")
+    @Produces(MediaType.TEXT_PLAIN)
+    public String ping() {
+        return "pong";
+    }
+
+}
@@ -6,6 +6,8 @@ public class RestResponse {
     private ResponseState responseState;
+    private String message;
+
     public RestResponse() {
         this(ResponseState.SUCCESS);
     }
@@ -14,6 +16,11 @@ public class RestResponse {
         this.responseState = responseState;        
     }
+    public RestResponse(final ResponseState responseState, final String message) {
+        this(responseState);
+        this.message = message;
+    }
+
     public int getResponseCode() {
         return responseState.getResponseCode();
     }
@@ -22,6 +29,8 @@ public class RestResponse {
         return responseState.getResponseText();
     }
+    public String getMessage() { return message; }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
@@ -20,7 +20,7 @@ import net.ziemers.swxercise.ui.enums.ResponseState;
 @Path(UserViewController.webContextPath)
 public class UserViewController {
-    static final String webContextPath = "/users";
+    static final String webContextPath = "/";
     @Inject
     private UserService userService;
@@ -29,11 +29,12 @@ public class UserViewController {
      * Liefert alle User-Objekte zurück.
      *
      * Aufruf:
-     * GET http://localhost:8080/swxercise/rest/users
+     * GET http://localhost:8080/swxercise/rest/v1/users
      *
-     * @return die User-Objekte.
+     * @return die User-Objekte, oder ein leeres JSON-Array, falls keine existieren.
      */
     @GET
+    @Path("v1/users")
     @Produces(MediaType.APPLICATION_JSON)
     public Collection<User> getAllUsers() {
         return userService.findAllUsers();
@@ -43,13 +44,13 @@ public class UserViewController {
      * Liefert das User-Objekt mit der gewünschten Id zurück.
      *
      * Aufruf:
-     * GET http://localhost:8080/swxercise/rest/users/42
+     * GET http://localhost:8080/swxercise/rest/v1/user/42
      *
      * @param id die Id des gewünschten User-Objekts
-     * @return das User-Objekt.
+     * @return das User-Objekt als JSON, oder <code>null</code>, falls keines existiert.
      */
     @GET
-    @Path("{id}")
+    @Path("v1/user/{id}")
     @Produces(MediaType.APPLICATION_JSON)
     public User getById(@PathParam("id") Long id) {
         return userService.findUser(id);
@@ -59,35 +60,41 @@ public class UserViewController {
      * Erstellt ein neues User-Objekt mit den gewünschten Eigenschaften, welche mittels {@link UserDto} definiert werden.
      *
      * Aufruf:
-     * POST http://localhost:8080/swxercise/rest/users
+     * POST http://localhost:8080/swxercise/rest/v1/user
      *
      * @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
+     * @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
+
      */
     @POST
+    @Path("v1/user")
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces(MediaType.APPLICATION_JSON)
-    public RestResponse createUser(UserDto dto) throws Exception {
-        userService.createUser(dto);
-        return new RestResponse();
+    public RestResponse createUser(UserDto dto) {
+        final Long id = userService.createUser(dto);
+        if (id != null) {
+            return new RestResponse(ResponseState.SUCCESS, String.valueOf(id));
+        }
+        return new RestResponse(ResponseState.ALREADY_EXISTING);
     }
     /**
-     * Aktualisiert das User-Objekt mit der gewünschten Id mit den Eigenschaften, welche mittels {@link UserDto} definiert werden.
+     * Aktualisiert das User-Objekt mit der gewünschten Id mit den Eigenschaften,
+     * welche mittels {@link UserDto} definiert werden. Der Pfadparameter wird
+     * als erstes ge'marshal't, das DTO im Post-Content danach (REST-Konvention).
      *
      * Aufruf:
-     * PUT http://localhost:8080/swxercise/rest/users/42
+     * PUT http://localhost:8080/swxercise/rest/v1/user/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
+     * @param id die Id des zu aktualisierenden User-Objekts
+     * @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link UserDto}
+     * @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
      */
     @PUT
-    @Path("{id}")
+    @Path("v1/user/{id}")
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces(MediaType.APPLICATION_JSON)
-    public RestResponse updateUser(@PathParam("id") Long id) throws Exception {
+    public RestResponse updateUser(@PathParam("id") Long id, UserDto dto) {
         // TODO noch zu implementieren
         return new RestResponse(ResponseState.FAILED);
     }
@@ -96,13 +103,13 @@ public class UserViewController {
      * Löscht das User-Objekt mit der gewünschten Id.
      *
      * Aufruf:
-     * DELETE http://localhost:8080/swxercise/rest/users/42
+     * DELETE http://localhost:8080/swxercise/rest/v1/user/42
      *
      * @param id die Id des gewünschten User-Objekts
-     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
+     * @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
      */
     @DELETE
-    @Path("{id}")
+    @Path("v1/user/{id}")
     @Produces(MediaType.APPLICATION_JSON)
     public RestResponse deleteUser(@PathParam("id") Long id) {
         userService.deleteUser(id);
@@ -113,11 +120,12 @@ public class UserViewController {
      * Löscht das User-Objekt des zurzeit angemeldeten Benutzers.
      *
      * Aufruf:
-     * DELETE http://localhost:8080/swxercise/rest/users
+     * DELETE http://localhost:8080/swxercise/rest/v1/user
      *
-     * @return "Ok", wenn das Löschen des User-Objekts erfolgreich war.
+     * @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
      */
     @DELETE
+    @Path("v1/user")
     @Produces(MediaType.APPLICATION_JSON)
     public RestResponse deleteUser() {
         if (userService.deleteUser()) {
@@ -130,13 +138,13 @@ public class UserViewController {
      * Meldet einen Benutzer durch übergebenen username und password mit einem neuen User-{@link SessionContext} an.
      *
      * Aufruf:
-     * POST http://localhost:8080/swxercise/rest/users/login
+     * POST http://localhost:8080/swxercise/rest/v1/user/login
      *
      * @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.
+     * @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
      */
     @POST
-    @Path("/login")
+    @Path("v1/user/login")
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces(MediaType.APPLICATION_JSON)
     public RestResponse loginUser(UserDto dto) {
@@ -150,13 +158,12 @@ public class UserViewController {
      * Meldet den angemeldeten Benutzer von seinem User-{@link SessionContext} ab.
      *
      * Aufruf:
-     * POST http://localhost:8080/swxercise/rest/users/logout
+     * POST http://localhost:8080/swxercise/rest/v1/user/logout
      *
-     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
+     * @return ein {@link ResponseState}-Objekt mit den Ergebnisinformationen des Aufrufs.
      */
     @POST
-    @Path("/logout")
-    @Consumes(MediaType.APPLICATION_JSON)
+    @Path("v1/user/logout")
     @Produces(MediaType.APPLICATION_JSON)
     public RestResponse logoutUser() {
         if (userService.logoutUser()) {
@@ -4,6 +4,7 @@ public enum ResponseState {
     SUCCESS(0, "Success"),
     FAILED(1, "Failed"),
+    ALREADY_EXISTING(2, "Already existing"),
     ;
     private final int responseCode;