style: JavaDocs und Checkstyle

Thomas Ziemer
1 parent 6fbb49a3
Showing 13 changed files with 69 additions and 12 deletions
src/main/java/net/ziemers/swxercise/db/BaseEntity.java
src/main/java/net/ziemers/swxercise/db/dao/GenericDao.java
src/main/java/net/ziemers/swxercise/db/dao/user/UserDao.java
src/main/java/net/ziemers/swxercise/db/utils/JpaTestUtils.java
src/main/java/net/ziemers/swxercise/lg/model/user/Address.java
src/main/java/net/ziemers/swxercise/lg/model/user/Profile.java
src/main/java/net/ziemers/swxercise/lg/model/user/Session.java
src/main/java/net/ziemers/swxercise/lg/model/user/User.java
src/main/java/net/ziemers/swxercise/lg/user/dto/UserDto.java
src/main/java/net/ziemers/swxercise/lg/user/enums/PasswordHashAlgorithm.java
src/main/java/net/ziemers/swxercise/lg/user/service/UserService.java
src/main/java/net/ziemers/swxercise/ui/RestApplication.java
src/main/java/net/ziemers/swxercise/ui/UserViewController.java
@@ -4,6 +4,9 @@ import javax.persistence.GeneratedValue;
 import javax.persistence.Id;
 import javax.persistence.MappedSuperclass;
  
+/**
+ * Diese Basisklasse wird von allen Entitäten verwendet.
+ */
 @MappedSuperclass
 public class BaseEntity {
  
@@ -12,6 +12,10 @@ import javax.persistence.criteria.Root;
  
 import net.ziemers.swxercise.db.BaseEntity;
  
+/**
+ * Stellt generische Persistenz-Funktionalität zur Verfügung. Wird normalerweise von den
+ * spazialisierten Data Access Objects geerbt.
+ */
 @Stateless
 public class GenericDao {
  
@@ -5,29 +5,49 @@ import net.ziemers.swxercise.lg.model.user.User;
  
 import javax.ejb.Stateless;
  
+/**
+ * Stellt Persistenz-Funktionalität im Kontext der Benutzerverwaltung
+ * zur Verfügung.
+ */
 @Stateless
 public class UserDao extends GenericDao {
  
+    /**
+     * Findet einen {@link User} aufgrund seiner Id.
+     *
+     * @param id die Id des gewünschten Users
+     * @return den User oder null, falls es keinen gibt.
+     */
     public User findById(final Long id) {
         User user = null;
  
         try {
-            // ermittelt den ersten Datensatz mit der gesuchten Id, auch wenn er sich nicht im Persistence Context befindet
-            user = (User) entityManager.createNamedQuery("User.findById").setParameter("id", id).getSingleResult();
-        } catch(Exception e) {
-			/* nix */
+            // ermittelt den ersten Datensatz mit der gesuchten Id, auch wenn
+            // er sich nicht im Persistence Context befindet
+            user = (User) entityManager.createNamedQuery("User.findById")
+                    .setParameter("id", id).getSingleResult();
+        } catch (Exception e) {
+            /* nix */
         }
         return user;
     }
  
+    /**
+     * Findet einen {@link User} aufgrund seiner Id.
+     *
+     * @param username der username des gewünschten Users
+     * @return den User oder null, falls es keinen gibt.
+     */
     public User findByUsername(final String username) {
         User user = null;
  
         try {
-            // ermittelt den ersten Datensatz mit dem gesuchten Benutzernamen, auch wenn er sich nicht im Persistence Context befindet
-            user = (User) entityManager.createNamedQuery("User.findByUsername").setParameter("username", username).getSingleResult();
-        } catch(Exception e) {
-			/* nix */
+            // ermittelt den ersten Datensatz mit dem gesuchten Benutzernamen,
+            // auch wenn er sich nicht im Persistence Context befindet
+            user = (User) entityManager.createNamedQuery("User.findByUsername")
+                    .setParameter("username", username).getSingleResult();
+        } catch (Exception e) {
+            /* nix */
         }
         return user;
     }
@@ -30,11 +30,14 @@ import org.hibernate.internal.SessionImpl;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
  
+/**
+ * Stellt nützliche Funktionalität für JUnit-Tests zur Verfügung.
+ */
 public class JpaTestUtils {
  
     private static final Logger logger = LoggerFactory.getLogger(JpaTestUtils.class.getName());
  
-    private static final String PERSISTENCE_UNIT_TEST = "swxercise_test";
+    private static final String PERSISTENCE_UNIT_TEST = "swXerciseTestPU";
  
     private static final String NET_ZIEMERS_SWXERCISE_PKG = "net/ziemers/swxercise/";
  
@@ -4,6 +4,9 @@ import javax.persistence.Entity;
  
 import net.ziemers.swxercise.db.BaseEntity;
  
+/**
+ * Verwaltet die Adressdaten eines Benutzers.
+ */
 @Entity
 public class Address extends BaseEntity {
  
@@ -13,6 +13,10 @@ import java.security.MessageDigest;
 import java.security.SecureRandom;
 import java.util.Random;
  
+/**
+ * Verwaltet die Anmeldedaten eines anmeldefähigen Benutzers. Das Kennwort wird niemals im Klartext
+ * gespeichert, sondern stets nur in seiner verhashten Form.
+ */
 @Entity
 public class Profile extends BaseEntity {
  
@@ -2,6 +2,9 @@ package net.ziemers.swxercise.lg.model.user;
  
 import javax.enterprise.context.SessionScoped;
  
+/**
+ * Verwaltet die Session des zurzeit angemeldeten Benutzers.
+ */
 @SessionScoped
 public class Session implements java.io.Serializable {
  
@@ -5,6 +5,9 @@ import javax.validation.constraints.NotNull;
  
 import net.ziemers.swxercise.db.BaseEntity;
  
+/**
+ *  Stellt die Stammdaten eines Benutzers zur Verfügung. Nutzt hierbei verschiedene Subklassen.
+ */
 @Entity
 @NamedQueries({
         @NamedQuery(name = "User.findById", query = "SELECT u FROM User u WHERE u.id = :id"),
@@ -2,6 +2,10 @@ package net.ziemers.swxercise.lg.user.dto;
  
 import javax.validation.constraints.NotNull;
  
+/**
+ * Das Data Transfer Object im Kontext der Benutzerverwaltung. Es wird unter anderem auch aus einem
+ * JSON-Objekt des {@link net.ziemers.swxercise.ui.UserViewController}s gefüllt.
+ */
 public class UserDto {
  
     @NotNull
@@ -20,9 +24,7 @@ public class UserDto {
         return username;
     }
  
-    public String getPassword() {
-        return password;
-    }
+    public String getPassword() { return password; }
  
     public String getFirstname() {
         return firstname;
 package net.ziemers.swxercise.lg.user.enums;
  
+/**
+ * Eine Enumeration aller jemals verwendeten Algorithmen zum Verhashen des Kennworts.
+ */
 public enum PasswordHashAlgorithm {
  
     SHA512("SHA-512"),
@@ -11,6 +11,9 @@ import net.ziemers.swxercise.lg.model.user.Session;
 import net.ziemers.swxercise.lg.model.user.User;
 import net.ziemers.swxercise.lg.user.dto.UserDto;
  
+/**
+ * Diese Klasse stellt alle Dienste im Kontext einer Benutzerverwaltung zur Verfügung.
+ */
 @Stateless
 public class UserService {
  
@@ -3,6 +3,9 @@ package net.ziemers.swxercise.ui;
 import javax.ws.rs.ApplicationPath;
 import javax.ws.rs.core.Application;
  
+/**
+ * Basisklasse für alle REST-Methoden.
+ */
 @ApplicationPath(RestApplication.webContextPath)
 public class RestApplication extends Application {
  
@@ -11,6 +11,9 @@ import net.ziemers.swxercise.lg.model.user.User;
 import net.ziemers.swxercise.lg.user.dto.UserDto;
 import net.ziemers.swxercise.lg.user.service.UserService;
  
+/**
+ * REST-Methoden für die Benutzerverwaltung.
+ */
 @ApplicationScoped
 @Path(UserViewController.webContextPath)
 public class UserViewController {