Merge branch 'release/v0.3.0'

pom.xml

@@ -5,19 +5,25 @@
 
   <groupId>com.leanstacks</groupId>
   <artifactId>skeleton-ws-spring-boot</artifactId>
-  <version>0.2.0</version>
+  <version>0.3.0</version>
+  <name>Web Services Project Skeleton</name>
+  <description>Skeleton project for RESTful web services using Spring Boot.</description>
 
   <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
     <version>1.2.1.RELEASE</version>
   </parent>
-
+  
   <dependencies>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-actuator</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-data-jpa</artifactId>
@@ -39,6 +45,13 @@
       <artifactId>guava</artifactId>
       <version>18.0</version>
     </dependency>
+
+    <!-- Dependencies for Unit Testing -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-test</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

src/main/java/com/leanstacks/ws/batch/GreetingBatchBean.java

@@ -5,6 +5,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.metrics.CounterService;
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.stereotype.Component;
 
@@ -22,6 +23,9 @@ public class GreetingBatchBean {
 
     private Logger logger = LoggerFactory.getLogger(this.getClass());
 
+    @Autowired
+    private CounterService counterService;
+
     @Autowired
     private GreetingService greetingService;
 
@@ -38,6 +42,8 @@ public class GreetingBatchBean {
     public void cronJob() {
         logger.info("> cronJob");
 
+        counterService.increment("method.invoked.greetingBatchBean.cronJob");
+
         // Add scheduled logic here
 
         Collection<Greeting> greetings = greetingService.findAll();
@@ -57,6 +63,9 @@ public void cronJob() {
     public void fixedRateJob() {
         logger.info("> fixedRateJob");
 
+        counterService
+                .increment("method.invoked.greetingBatchBean.fixedRateJob");
+
         // Add scheduled logic here
 
         Collection<Greeting> greetings = greetingService.findAll();
@@ -79,6 +88,9 @@ public void fixedRateJob() {
     public void fixedRateJobWithInitialDelay() {
         logger.info("> fixedRateJobWithInitialDelay");
 
+        counterService
+                .increment("method.invoked.greetingBatchBean.fixedRateJobWithInitialDelay");
+
         // Add scheduled logic here
 
         Collection<Greeting> greetings = greetingService.findAll();
@@ -98,6 +110,9 @@ public void fixedRateJobWithInitialDelay() {
     public void fixedDelayJob() {
         logger.info("> fixedDelayJob");
 
+        counterService
+                .increment("method.invoked.greetingBatchBean.fixedDelayJob");
+
         // Add scheduled logic here
 
         Collection<Greeting> greetings = greetingService.findAll();
@@ -120,6 +135,9 @@ public void fixedDelayJob() {
     public void fixedDelayJobWithInitialDelay() {
         logger.info("> fixedDelayJobWithInitialDelay");
 
+        counterService
+                .increment("method.invoked.greetingBatchBean.fixedDelayJobWithInitialDelay");
+
         // Add scheduled logic here
 
         Collection<Greeting> greetings = greetingService.findAll();

src/main/java/com/leanstacks/ws/service/GreetingService.java

@@ -50,4 +50,9 @@ public interface GreetingService {
      */
     void delete(Long id);
 
+    /**
+     * Evicts all members of the "greetings" cache.
+     */
+    void evictCache();
+
 }

src/main/java/com/leanstacks/ws/service/GreetingServiceBean.java

@@ -2,9 +2,13 @@
 
 import java.util.Collection;
 
+import javax.persistence.EntityExistsException;
+import javax.persistence.NoResultException;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.metrics.CounterService;
 import org.springframework.cache.annotation.CacheEvict;
 import org.springframework.cache.annotation.CachePut;
 import org.springframework.cache.annotation.Cacheable;
@@ -25,13 +29,18 @@ public class GreetingServiceBean implements GreetingService {
 
     private Logger logger = LoggerFactory.getLogger(this.getClass());
 
+    @Autowired
+    private CounterService counterService;
+
     @Autowired
     private GreetingRepository greetingRepository;
 
     @Override
     public Collection<Greeting> findAll() {
         logger.info("> findAll");
 
+        counterService.increment("method.invoked.greetingServiceBean.findAll");
+
         Collection<Greeting> greetings = greetingRepository.findAll();
 
         logger.info("< findAll");
@@ -45,6 +54,8 @@ public Collection<Greeting> findAll() {
     public Greeting findOne(Long id) {
         logger.info("> findOne {}", id);
 
+        counterService.increment("method.invoked.greetingServiceBean.findOne");
+
         Greeting greeting = greetingRepository.findOne(id);
 
         logger.info("< findOne {}", id);
@@ -59,13 +70,16 @@ public Greeting findOne(Long id) {
     public Greeting create(Greeting greeting) {
         logger.info("> create");
 
+        counterService.increment("method.invoked.greetingServiceBean.create");
+
         // Ensure the entity object to be created does NOT exist in the
         // repository. Prevent the default behavior of save() which will update
         // an existing entity if the entity matching the supplied id exists.
         if (greeting.getId() != null) {
             logger.error("Attempted to create a Greeting, but id attribute was not null.");
             logger.info("< create");
-            return null;
+            throw new EntityExistsException(
+                    "Cannot create new Greeting with supplied id.  The id attribute must be null to create an entity.");
         }
 
         Greeting savedGreeting = greetingRepository.save(greeting);
@@ -82,14 +96,16 @@ public Greeting create(Greeting greeting) {
     public Greeting update(Greeting greeting) {
         logger.info("> update {}", greeting.getId());
 
+        counterService.increment("method.invoked.greetingServiceBean.update");
+
         // Ensure the entity object to be updated exists in the repository to
         // prevent the default behavior of save() which will persist a new
         // entity if the entity matching the id does not exist
         Greeting greetingToUpdate = findOne(greeting.getId());
         if (greetingToUpdate == null) {
             logger.error("Attempted to update a Greeting, but the entity does not exist.");
             logger.info("< update {}", greeting.getId());
-            return null;
+            throw new NoResultException("Requested Greeting not found.");
         }
 
         Greeting updatedGreeting = greetingRepository.save(greeting);
@@ -106,9 +122,24 @@ public Greeting update(Greeting greeting) {
     public void delete(Long id) {
         logger.info("> delete {}", id);
 
+        counterService.increment("method.invoked.greetingServiceBean.delete");
+
         greetingRepository.delete(id);
 
         logger.info("< delete {}", id);
     }
 
+    @CacheEvict(
+            value = "greetings",
+            allEntries = true)
+    @Override
+    public void evictCache() {
+        logger.info("> evictCache");
+
+        counterService
+                .increment("method.invoked.greetingServiceBean.evictCache");
+
+        logger.info("< evictCache");
+    }
+
 }

src/main/java/com/leanstacks/ws/web/api/BaseController.java

@@ -0,0 +1,33 @@
+package com.leanstacks.ws.web.api;
+
+import javax.persistence.NoResultException;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
+public class BaseController {
+
+    protected Logger logger = LoggerFactory.getLogger(this.getClass());
+
+    @ExceptionHandler(NoResultException.class)
+    public ResponseEntity<Exception> handleNoResultException(
+            NoResultException nre) {
+        logger.error("> handleNoResultException");
+        logger.error("- NoResultException: ", nre);
+        logger.error("< handleNoResultException");
+        return new ResponseEntity<Exception>(HttpStatus.NOT_FOUND);
+    }
+
+    @ExceptionHandler(Exception.class)
+    public ResponseEntity<Exception> handleException(Exception e) {
+        logger.error("> handleException");
+        logger.error("- Exception: ", e);
+        logger.error("< handleException");
+        return new ResponseEntity<Exception>(e,
+                HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+
+}

src/main/java/com/leanstacks/ws/web/api/GreetingController.java

@@ -2,13 +2,10 @@
 
 import java.util.Collection;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -26,22 +23,11 @@
  * @author Matt Warman
  */
 @RestController
-public class GreetingController {
-
-    private Logger logger = LoggerFactory.getLogger(this.getClass());
+public class GreetingController extends BaseController {
 
     @Autowired
     private GreetingService greetingService;
 
-    @ExceptionHandler(Exception.class)
-    public ResponseEntity<Exception> handleException(Exception e) {
-        logger.error("> handleException");
-        logger.error("- Exception: ", e);
-        logger.error("< handleException");
-        return new ResponseEntity<Exception>(e,
-                HttpStatus.INTERNAL_SERVER_ERROR);
-    }
-
     @RequestMapping(
             value = "/api/greetings",
             method = RequestMethod.GET,
@@ -84,11 +70,6 @@ public ResponseEntity<Greeting> createGreeting(
         logger.info("> createGreeting");
 
         Greeting savedGreeting = greetingService.create(greeting);
-        if (savedGreeting == null) {
-            logger.info("< createGreeting");
-            return new ResponseEntity<Greeting>(
-                    HttpStatus.INTERNAL_SERVER_ERROR);
-        }
 
         logger.info("< createGreeting");
         return new ResponseEntity<Greeting>(savedGreeting, HttpStatus.CREATED);
@@ -104,22 +85,16 @@ public ResponseEntity<Greeting> updateGreeting(
         logger.info("> updateGreeting");
 
         Greeting updatedGreeting = greetingService.update(greeting);
-        if (updatedGreeting == null) {
-            logger.info("< updateGreeting");
-            return new ResponseEntity<Greeting>(
-                    HttpStatus.INTERNAL_SERVER_ERROR);
-        }
 
         logger.info("< updateGreeting");
         return new ResponseEntity<Greeting>(updatedGreeting, HttpStatus.OK);
     }
 
     @RequestMapping(
             value = "/api/greetings/{id}",
-            method = RequestMethod.DELETE,
-            consumes = MediaType.APPLICATION_JSON_VALUE)
-    public ResponseEntity<Greeting> deleteGreeting(@PathVariable("id") Long id,
-            @RequestBody Greeting greeting) throws Exception {
+            method = RequestMethod.DELETE)
+    public ResponseEntity<Greeting> deleteGreeting(@PathVariable("id") Long id)
+            throws Exception {
         logger.info("> deleteGreeting");
 
         greetingService.delete(id);

src/main/resources/config/application.properties

@@ -14,6 +14,17 @@ server.port=
 # Initialization
 spring.datasource.data=classpath:/data/hsqldb/data.sql
 
+##
+# Actuator Configuration
+##
+management.context-path=/actuators
+
+info.build.groupId=@project.groupId@
+info.build.artifact=@project.artifactId@
+info.build.name=@project.name@
+info.build.description=@project.description@
+info.build.version=@project.version@
+
 ##
 # Batch Configuration
 ##