feature: SLF4J-Logging hinzugefügt, und ein paar Refactorings

Thomas Ziemer
1 parent 6ea89b5f
Showing 7 changed files with 48 additions and 4 deletions
src/main/java/net/ziemers/swxercise/lg/utils/LoggerProducer.java
src/main/java/net/ziemers/swxercise/ui/RoleViewController.java
src/main/java/net/ziemers/swxercise/ui/UserViewController.java
src/main/java/net/ziemers/swxercise/ui/RestApplication.java → src/main/java/net/ziemers/swxercise/ui/utils/RestApplication.java
src/main/java/net/ziemers/swxercise/ui/RestResponse.java → src/main/java/net/ziemers/swxercise/ui/utils/RestResponse.java
src/main/java/net/ziemers/swxercise/ui/SecurityInterceptor.java → src/main/java/net/ziemers/swxercise/ui/utils/SecurityInterceptor.java
src/test/java/net/ziemers/swxercise/ui/UserViewControllerTest.java
+package net.ziemers.swxercise.lg.utils;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.enterprise.inject.Produces;
+import javax.enterprise.inject.spi.InjectionPoint;
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+/**
+ * Dependendy Injection mit dem SLF4J-Logger
+ * Quelle: http://www.pavel.cool/jee-tips/Injecting-Logger/
+ */
+@Named
+@Singleton
+public class LoggerProducer {
+
+    @Produces
+    public Logger produceLogger(InjectionPoint injectionPoint) {
+        return LoggerFactory.getLogger(injectionPoint.getBean().getBeanClass());
+    }
+
+}
 \ No newline at end of file
@@ -5,6 +5,7 @@ import net.ziemers.swxercise.lg.user.dto.RoleDto;
 import net.ziemers.swxercise.lg.user.enums.RightState;
 import net.ziemers.swxercise.lg.user.service.RoleService;
 import net.ziemers.swxercise.ui.enums.ResponseState;
+import net.ziemers.swxercise.ui.utils.RestResponse;
  
 import javax.annotation.security.RolesAllowed;
 import javax.enterprise.context.ApplicationScoped;
@@ -14,6 +14,8 @@ import net.ziemers.swxercise.lg.model.user.User;
 import net.ziemers.swxercise.lg.user.dto.UserDto;
 import net.ziemers.swxercise.lg.user.service.UserService;
 import net.ziemers.swxercise.ui.enums.ResponseState;
+import net.ziemers.swxercise.ui.utils.RestResponse;
+import org.slf4j.Logger;
  
 /**
  * REST-Methoden für die Benutzerverwaltung.
@@ -24,6 +26,13 @@ public class UserViewController {
  
     static final String webContextPath = "/";
  
+    /*
+     * SLF4J: "Simple Logging Facade for Java"
+     * Dependency Injection erfolgt mit dem {@link net.ziemers.swxercise.lg.utils.LoggerProducer}
+     */
+    @Inject
+    private Logger logger;
+
     @Inject
     private UserService userService;
  
@@ -72,7 +81,9 @@ public class UserViewController {
     @Path("v1/user")
     @Produces(MediaType.APPLICATION_JSON)
     @RolesAllowed(RightState.Constants.LOGGED_IN)
-    public User getUser() { return userService.findUser(); }
+    public User getUser() {
+        logger.info("Trying to get user's profile info.");
+        return userService.findUser(); }
  
     /**
      * Erstellt ein neues User-Objekt mit den gewünschten Eigenschaften, welche mittels {@link UserDto} definiert werden.
@@ -197,6 +208,7 @@ public class UserViewController {
     @Produces(MediaType.APPLICATION_JSON)
     @RolesAllowed(RightState.Constants.NOT_LOGGED_IN)
     public RestResponse loginUser(UserDto dto) {
+        logger.info("Trying to log-in user '{}'.", dto.getUsername());
         if (userService.loginUser(dto)) {
             return new RestResponse();
         }
@@ -216,6 +228,7 @@ public class UserViewController {
     @Produces(MediaType.APPLICATION_JSON)
     @RolesAllowed(RightState.Constants.LOGGED_IN)
     public RestResponse logoutUser() {
+        logger.info("Trying to log-out user.");
         if (userService.logoutUser()) {
             return new RestResponse();
         }
-package net.ziemers.swxercise.ui;
+package net.ziemers.swxercise.ui.utils;
  
 import javax.ws.rs.ApplicationPath;
 import javax.ws.rs.core.Application;
-package net.ziemers.swxercise.ui;
+package net.ziemers.swxercise.ui.utils;
  
 import net.ziemers.swxercise.ui.enums.ResponseState;
  
-package net.ziemers.swxercise.ui;
+package net.ziemers.swxercise.ui.utils;
  
 import javax.annotation.PostConstruct;
 import javax.annotation.security.DenyAll;
@@ -9,11 +9,13 @@ import net.ziemers.swxercise.lg.user.dto.UserDto;
 import net.ziemers.swxercise.lg.user.service.UserService;
 import net.ziemers.swxercise.ui.enums.ResponseState;
  
+import net.ziemers.swxercise.ui.utils.RestResponse;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
+import org.slf4j.Logger;
  
 import static org.junit.Assert.*;
 import static org.mockito.Mockito.*;
@@ -31,6 +33,10 @@ public class UserViewControllerTest {
     @InjectMocks
     private UserViewController underTest;
  
+    // das Logging interessiert uns nicht; deshalb mocken wir es weg
+    @Mock
+    private Logger logger;
+
     /*
      * Mockito allows to configure the return values of its mocks via a fluent API.
      * Unspecified method calls return "empty" values