style: User-Model in PlantUML modelliert

Thomas Ziemer
1 parent 7a765da2
Showing 2 changed files with 64 additions and 0 deletions
src/main/java/net/ziemers/swxercise/lg/model/user/Model.puml
src/main/java/net/ziemers/swxercise/lg/model/user/Profile.java
+@startuml
+
+class BaseEntity {
+    - Long id
+}
+
+class User {
+    - String firstname
+    - String lastname
+}
+class Profile {
+    - String username
+    - String passwordHash
+    - String salt
+    - PasswordHashAlgorithm hashAlgorithm
+    - String mailaddress
+    + String setPassword(String password)
+    - String getPasswordHash()
+    + boolean isValidPassword(String password)
+    - void setPasswordHash()
+}
+
+class Role {
+    - String name
+    - Collection<RightState> rights
+}
+
+class Address {
+    - String street
+    - String zipcode
+    - String city
+    - String country
+}
+
+enum PasswordHashAlgorithm {
+    SHA512
+}
+
+enum RightState {
+    NOT_LOGGED_IN
+    LOGGED_IN
+    ADMIN
+}
+
+BaseEntity <|-- User : MappedSuperClass
+User "1" --> "0..1" Profile
+User "1" --> "0..1" Address
+Profile "*" --> "1" Role
+Profile ..> "1" PasswordHashAlgorithm
+Role "*" --> "1" Role : parent
+Role ..> "*" RightState
+
+@enduml
 \ No newline at end of file
@@ -145,6 +145,11 @@ public class Profile extends BaseEntity {
         return passwordHash;
     }
  
+    /**
+     * Setzt das im Profil hinterlegte Kennwort. Es wird darin sicher verschlüsselt abgelegt.
+     *
+     * @param password das gewünschte Kennwort
+     */
     public void setPassword(String password) {
         // das Klartextkennwort wird niemals gespeichert!
         this.passwordHash = cryptString(password);
@@ -154,6 +159,12 @@ public class Profile extends BaseEntity {
         this.passwordHash = passwordHash;
     }
  
+    /**
+     * Vergleicht das übergebene Kennwort mit dem im Profil hinterlegten.
+     *
+     * @param password das Klartext-Kennwort, mit dem das im Profil hinterlegte verglichen werden soll
+     * @return <code>true</code>, wenn die Kennwörter identisch sind.
+     */
     public boolean isValidPassword(final String password) {
         final String passwordHash = cryptString(password);