feature: Standard-Rechteverwaltung begonnen (WIP)

Thomas Ziemer
1 parent 3e533eef
Showing 3 changed files with 180 additions and 31 deletions
src/main/java/net/ziemers/swxercise/lg/user/enums/RightState.java
src/main/java/net/ziemers/swxercise/lg/user/service/UserService.java
src/main/java/net/ziemers/swxercise/ui/UserViewController.java
+package net.ziemers.swxercise.lg.user.enums;
+
+/**
+ * Stellt grundsätzliche Rechte zur Verfügung, die so mit hoher Wahrscheinlichkeit
+ * in vielen Anwendungen verwendet werden möchten.
+ */
+public enum RightState {
+
+    NOT_LOGGED_IN(Constants.NOT_LOGGED_IN),
+    LOGGED_IN(Constants.LOGGED_IN),
+    ADMIN(Constants.ADMIN),
+    SUPERADMIN(Constants.SUPERADMIN),
+    ;
+
+    private String name;
+
+    RightState(final String name) {
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    private void setName(String name) {
+        this.name = name;
+    }
+
+    /*
+     * Diese Klasse wird verwendet, damit wir innerhalb von Annotationen auf die Namen zugreifen können.
+     */
+    public static class Constants {
+        public static final String NOT_LOGGED_IN = "NOT_LOGGED_IN";
+        public static final String LOGGED_IN = "LOGGED_IN";
+        public static final String ADMIN = "ADMIN";
+        public static final String SUPERADMIN = "SUPERADMIN";
+    }
+
+}
@@ -10,6 +10,7 @@ import net.ziemers.swxercise.db.dao.user.UserDao;
 import net.ziemers.swxercise.lg.model.user.Profile;
 import net.ziemers.swxercise.lg.model.user.User;
 import net.ziemers.swxercise.lg.user.dto.UserDto;
+import net.ziemers.swxercise.lg.user.enums.RightState;
 /**
  * Diese Klasse stellt alle Dienste im Kontext einer Benutzerverwaltung zur Verfügung.
@@ -54,7 +55,21 @@ public class UserService {
     }
     /**
+     * Findet den zurzeit angemeldeten Benutzer.
+     *
+     * @return den gesuchten Benutzer, oder <code>null</code>, falls ein solcher nicht existiert.
+     */
+    public User findUser() {
+        final User user = sessionContext.getUser();
+        if (user != null) {
+            return dao.findById(user.getId());
+        }
+        return null;
+    }
+
+    /**
      * Findet alle existierenden Benutzer.
+     *
      * @return alle Benutzer, oder eine leere Collection, falls keine existieren.
      */
     public Collection<User> findAllUsers() {
@@ -64,16 +79,16 @@ public class UserService {
     /**
      * Erstellt einen neuen Benutzer, sofern noch keiner mit dem selben Benutzernamen existiert.
      *
-     * @param userDto das {@link UserDto} enthält die Eigenschaften des zu erstellenden Benutzers
+     * @param dto das {@link UserDto} enthält die Eigenschaften des zu erstellenden Benutzers
      * @return die Id des neuen Benutzers, wenn die Erstellung erfolgreich war.
      */
-    public Long createUser(final UserDto userDto) {
-        User user = dao.findByUsername(userDto.getUsername());
+    public Long createUser(final UserDto dto) {
+        User user = dao.findByUsername(dto.getUsername());
         if (user == null) {
-            final Profile profile = new Profile(userDto.getUsername(), userDto.getPassword());
+            final Profile profile = new Profile(dto.getUsername(), dto.getPassword());
             // wir füllen das User-Objekt mit Method Chaining
-            user = new User(userDto.getFirstname(), userDto.getLastname())
+            user = new User(dto.getFirstname(), dto.getLastname())
                     .withProfile(profile);
             return dao.save(user);
@@ -82,6 +97,38 @@ public class UserService {
     }
     /**
+     * Aktualisiert den Benutzer mit der übergebenen Id.
+     *
+     * @param id  die Id des zu aktualisierenden Benutzers
+     * @param dto das {@link UserDto} enthält die Eigenschaften des zu aktualisierenden Benutzers
+     * @return <code>true</code>, wenn das Aktualisieren des Benutzers erfolgreich war.
+     */
+    public boolean updateUser(final Long id, final UserDto dto) {
+        final User user = dao.findById(id);
+        if (user != null) {
+            // TODO noch zu implementieren
+            return false;
+        }
+        return false;
+    }
+
+    /**
+     * Aktualisiert den zurzeit angemeldeten Benutzer.
+     *
+     * @param dto das {@link UserDto} enthält die Eigenschaften des zu aktualisierenden Benutzers
+     * @return <code>true</code>, wenn das Aktualisieren des Benutzers erfolgreich war.
+     */
+    public boolean updateUser(final UserDto dto) {
+        // ist zurzeit ein Benutzer angemeldet, können wir ihn aktualisieren
+        final User user = sessionContext.getUser();
+        if (user != null) {
+            // TODO noch zu implementieren
+            return false;
+        }
+        return false;
+    }
+
+    /**
      * Löscht den Benutzer mit der übergebenen Id.
      *
      * @param id die Id des zu löschenden Benutzers
@@ -102,26 +149,44 @@ public class UserService {
     }
     /**
-     * Liefert das {@link User}-Objekt des zurzeit angemeldeten Benutzers zurück.
+     * Liefert das {@link User}-Objekt des zurzeit angemeldeten Benutzers zurück. Das ist derjenige
+     * Benutzer, der im {@link SessionContext}-Objekt hinterlegt ist.
+     *
      * @return das User-Objekt des zurzeit angemeldeten Benutzers.
      */
-    public User getSessionUser() {
+    public User getSessionContextUser() {
         return sessionContext.getUser();
     }
     /**
-     * Prüft, ob der zurzeit angemeldete Benutzer eine Rolle aus der Liste der übergebenen Rollen besitzt.
+     * Prüft, ob der Benutzer des {@link SessionContext}s ein Recht aus der Liste der übergebenen Rechte besitzt.
      *
-     * @param rolesSet die Rollenliste
-     * @return <code>true</code>, falls der zurzeit angemeldete Benutzer eine der übergebenen Rollen besitzt.
+     * @param rightsSet die Rechteliste
+     * @return <code>true</code>, falls der Benutzer eines der übergebenen Rechte besitzt.
      */
-    public boolean isUserAllowed(final Set<String> rolesSet) {
-        final User user = getSessionUser();
+    public boolean isUserAllowed(final Set<String> rightsSet) {
+        final User user = getSessionContextUser();
-        // ist überhaupt ein Benutzer angemeldet?
-        if (user != null) {
-            // TODO muss noch implementiert werden
-            return true;
+        // Rechte, die nur ein nicht-angemeldeter Benutzer besitzen kann
+        if (user == null) {
+            if (rightsSet.contains(RightState.Constants.NOT_LOGGED_IN)) {
+                return true;
+            }
+        }
+
+        // Rechte, die nur ein angemeldeter Benutzer besitzen kann
+        else {
+            if (rightsSet.contains(RightState.Constants.LOGGED_IN)) {
+                return true;
+            }
+            if (rightsSet.contains(RightState.Constants.ADMIN)) {
+                // TODO muss noch implementiert werden
+                return true;
+            }
+            if (rightsSet.contains(RightState.Constants.SUPERADMIN)) {
+                // TODO muss noch implementiert werden
+                return true;
+            }
         }
         return false;
     }
@@ -8,6 +8,7 @@ import javax.inject.Inject;
 import javax.ws.rs.*;
 import javax.ws.rs.core.MediaType;
+import net.ziemers.swxercise.lg.user.enums.RightState;
 import net.ziemers.swxercise.lg.user.service.SessionContext;
 import net.ziemers.swxercise.lg.model.user.User;
 import net.ziemers.swxercise.lg.user.dto.UserDto;
@@ -28,7 +29,7 @@ public class UserViewController {
     /**
      * Liefert alle User-Objekte zurück.
-     *
+     * <p>
      * Aufruf:
      * GET http://localhost:8080/swxercise/rest/v1/users
      *
@@ -37,13 +38,14 @@ public class UserViewController {
     @GET
     @Path("v1/users")
     @Produces(MediaType.APPLICATION_JSON)
+    @RolesAllowed(RightState.Constants.SUPERADMIN)
     public Collection<User> getAllUsers() {
         return userService.findAllUsers();
     }
     /**
      * Liefert das User-Objekt mit der gewünschten Id zurück.
-     *
+     * <p>
      * Aufruf:
      * GET http://localhost:8080/swxercise/rest/v1/user/42
      *
@@ -53,25 +55,39 @@ public class UserViewController {
     @GET
     @Path("v1/user/{id}")
     @Produces(MediaType.APPLICATION_JSON)
-    public User getById(@PathParam("id") Long id) {
+    @RolesAllowed(RightState.Constants.SUPERADMIN)
+    public User getUser(@PathParam("id") Long id) {
         return userService.findUser(id);
     }
     /**
-     * Erstellt ein neues User-Objekt mit den gewünschten Eigenschaften, welche mittels {@link UserDto} definiert werden.
+     * Liefert das User-Objekt des zurzeit angemeldeten Benutzers zurück.
+     * <p>
+     * Aufruf:
+     * GET http://localhost:8080/swxercise/rest/v1/user
      *
+     * @return das User-Objekt als JSON, oder <code>null</code>, falls keines existiert.
+     */
+    @GET
+    @Path("v1/user")
+    @Produces(MediaType.APPLICATION_JSON)
+    @RolesAllowed(RightState.Constants.LOGGED_IN)
+    public User getUser() { return userService.findUser(); }
+
+    /**
+     * Erstellt ein neues User-Objekt mit den gewünschten Eigenschaften, welche mittels {@link UserDto} definiert werden.
+     * <p>
      * Aufruf:
      * POST http://localhost:8080/swxercise/rest/v1/user
      *
      * @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.
-
      */
     @POST
     @Path("v1/user")
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces(MediaType.APPLICATION_JSON)
-    @RolesAllowed("ADMIN")
+    @RolesAllowed(RightState.Constants.ADMIN)
     public RestResponse createUser(UserDto dto) {
         final Long id = userService.createUser(dto);
         if (id != null) {
@@ -84,11 +100,11 @@ public class UserViewController {
      * 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).
-     *
+     * <p>
      * Aufruf:
      * PUT http://localhost:8080/swxercise/rest/v1/user/42
      *
-     * @param id die Id des zu aktualisierenden User-Objekts
+     * @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.
      */
@@ -96,15 +112,41 @@ public class UserViewController {
     @Path("v1/user/{id}")
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces(MediaType.APPLICATION_JSON)
-    @RolesAllowed("ADMIN")
+    @RolesAllowed(RightState.Constants.ADMIN)
     public RestResponse updateUser(@PathParam("id") Long id, UserDto dto) {
-        // TODO noch zu implementieren
+        if (userService.updateUser(id, dto)) {
+            return new RestResponse();
+        }
         return new RestResponse(ResponseState.FAILED);
     }
     /**
-     * Löscht das User-Objekt mit der gewünschten Id.
+     * Aktualisiert das User-Objekt des zurzeit angemeldeten Benutzers 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).
+     * <p>
+     * Aufruf:
+     * PUT http://localhost:8080/swxercise/rest/v1/user
      *
+     * @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("v1/user")
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Produces(MediaType.APPLICATION_JSON)
+    @RolesAllowed(RightState.Constants.LOGGED_IN)
+    public RestResponse updateUser(UserDto dto) {
+        if (userService.updateUser(dto)) {
+            return new RestResponse();
+        }
+        return new RestResponse(ResponseState.FAILED);
+    }
+
+    /**
+     * Löscht das User-Objekt mit der gewünschten Id.
+     * <p>
      * Aufruf:
      * DELETE http://localhost:8080/swxercise/rest/v1/user/42
      *
@@ -114,7 +156,7 @@ public class UserViewController {
     @DELETE
     @Path("v1/user/{id}")
     @Produces(MediaType.APPLICATION_JSON)
-    @RolesAllowed("ADMIN")
+    @RolesAllowed(RightState.Constants.ADMIN)
     public RestResponse deleteUser(@PathParam("id") Long id) {
         userService.deleteUser(id);
         return new RestResponse();
@@ -122,7 +164,7 @@ public class UserViewController {
     /**
      * Löscht das User-Objekt des zurzeit angemeldeten Benutzers.
-     *
+     * <p>
      * Aufruf:
      * DELETE http://localhost:8080/swxercise/rest/v1/user
      *
@@ -131,6 +173,7 @@ public class UserViewController {
     @DELETE
     @Path("v1/user")
     @Produces(MediaType.APPLICATION_JSON)
+    @RolesAllowed(RightState.Constants.LOGGED_IN)
     public RestResponse deleteUser() {
         if (userService.deleteUser()) {
             return new RestResponse();
@@ -140,7 +183,7 @@ public class UserViewController {
     /**
      * Meldet einen Benutzer durch übergebenen username und password mit einem neuen User-{@link SessionContext} an.
-     *
+     * <p>
      * Aufruf:
      * POST http://localhost:8080/swxercise/rest/v1/user/login
      *
@@ -151,6 +194,7 @@ public class UserViewController {
     @Path("v1/user/login")
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces(MediaType.APPLICATION_JSON)
+    @RolesAllowed(RightState.Constants.NOT_LOGGED_IN)
     public RestResponse loginUser(UserDto dto) {
         if (userService.loginUser(dto)) {
             return new RestResponse();
@@ -160,7 +204,7 @@ public class UserViewController {
     /**
      * Meldet den angemeldeten Benutzer von seinem User-{@link SessionContext} ab.
-     *
+     * <p>
      * Aufruf:
      * POST http://localhost:8080/swxercise/rest/v1/user/logout
      *
@@ -169,6 +213,7 @@ public class UserViewController {
     @POST
     @Path("v1/user/logout")
     @Produces(MediaType.APPLICATION_JSON)
+    @RolesAllowed(RightState.Constants.LOGGED_IN)
     public RestResponse logoutUser() {
         if (userService.logoutUser()) {
             return new RestResponse();