Improve notifier Spring support

- Add Spring boot example app.
- Add Spring boot web based example app.
- Add `close` method to Bugsnag to ensure it tears down connections (this is automatically called by Spring when tearing down the bean).
- Change the simple example to use `close` rather than `Shutdown`.

Author: foygl

examples/simple/src/main/java/com/bugsnag/example/simple/ExampleApp.java

@@ -6,7 +6,7 @@
 import java.util.Date;
 
 public class ExampleApp {
-    public static void main(String[] args) {
+    public static void main(String[] args) throws InterruptedException {
         // Create a Bugsnag client
         Bugsnag bugsnag = new Bugsnag("YOUR-API-KEY");
 
@@ -55,11 +55,16 @@ public static void main(String[] args) {
 
         // Test an unhanded exception from a different thread as shutdown hooks
         // won't be called if executed from this thread
-        (new Thread() {
+        Thread thread = new Thread() {
             @Override
             public void run() {
                 throw new RuntimeException("Unhandled exception");
             }
-        }).start();
+        };
+
+        thread.start();
+
+        // Wait for unhandled exception thread to finish before exiting
+        thread.join();
     }
 }

examples/spring-web/README.md

@@ -0,0 +1,13 @@
+# Bugsnag Spring web Java Example
+
+A Spring Boot example application to show how to use Bugsnag in a Spring web based Java application.
+
+- Start the web server
+
+    ```shell
+    ../../gradlew clean bootRun
+    ```
+
+- Cause a crash
+
+    http://localhost:8080/

examples/spring-web/build.gradle

@@ -0,0 +1,23 @@
+apply plugin: 'spring-boot'
+
+buildscript {
+    ext {
+        springBootVersion = '1.4.1.RELEASE'
+    }
+    repositories {
+        jcenter()
+    }
+    dependencies {
+        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
+    }
+}
+
+repositories {
+    jcenter()
+}
+
+dependencies {
+    compile("org.springframework.boot:spring-boot-starter-web")
+
+    compile rootProject
+}

examples/spring-web/src/main/java/com/bugsnag/example/spring/web/Application.java

@@ -0,0 +1,20 @@
+package com.bugsnag.example.spring.web;
+
+import org.apache.log4j.Logger;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * Kicks off the Spring Boot application.
+ */
+@SpringBootApplication
+public class Application {
+
+    private static final Logger LOGGER = Logger.getLogger(Application.class);
+
+    public static void main(String[] args) throws Exception {
+        SpringApplication.run(Application.class, args);
+
+        LOGGER.info("Now visit http://localhost:8080 in your web browser");
+    }
+}

examples/spring-web/src/main/java/com/bugsnag/example/spring/web/ApplicationRestController.java

@@ -0,0 +1,102 @@
+package com.bugsnag.example.spring.web;
+
+import com.bugsnag.Bugsnag;
+import com.bugsnag.Severity;
+import org.apache.log4j.Logger;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.SpringApplication;
+import org.springframework.context.ApplicationContext;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class ApplicationRestController {
+
+    private static final Logger LOGGER = Logger.getLogger(ApplicationRestController.class);
+
+    // Inject the bugsnag notifier bean defined in Config.java
+    @Autowired
+    private Bugsnag bugsnag;
+
+    @Autowired
+    private ApplicationContext applicationContext;
+
+    private final String links =
+            "<a href=\"/send-handled-exception\">Send a handled exception to Bugsnag</a><br/>"
+            + "<a href=\"/send-handled-exception-info\">Send a handled exception to Bugsnag with INFO severity</a><br/>"
+            + "<a href=\"/send-handled-exception-with-metadata\">Send a handled exception to Bugsnag with custom MetaData</a><br/>"
+            + "<a href=\"/send-unhandled-exception\">Send an unhandled exception to Bugsnag</a><br/>"
+            + "<a href=\"/shutdown\">Shutdown the application</a><br/>";
+
+    @RequestMapping("/")
+    public String index() {
+        return links;
+    }
+
+    @RequestMapping("/send-handled-exception")
+    public String sendHandledException() {
+        LOGGER.info("Sending a handled exception to Bugsnag");
+        try {
+            throw new RuntimeException("Handled exception - default severity");
+        } catch (RuntimeException e) {
+            bugsnag.notify(e);
+        }
+
+        return links + "<br/>Sent a handled exception to Bugsnag";
+    }
+
+    @RequestMapping("/send-handled-exception-info")
+    public String sendHandledExceptionInfo() {
+        LOGGER.info("Sending a handled exception to Bugsnag with INFO severity");
+        try {
+            throw new RuntimeException("Handled exception - INFO severity");
+        } catch (RuntimeException e) {
+            bugsnag.notify(e, Severity.INFO);
+        }
+
+        return links + "<br/>Sent a handled exception to Bugsnag with INFO severity";
+    }
+
+    @RequestMapping("/send-handled-exception-with-metadata")
+    public String sendHandledExceptionWithMetadata() {
+        LOGGER.info("Sending a handled exception to Bugsnag with custom MetaData");
+        try {
+            throw new RuntimeException("Handled exception - custom metadata");
+        } catch (RuntimeException e) {
+            bugsnag.notify(e, (report) -> {
+                report.setSeverity(Severity.WARNING);
+                report.addToTab("report", "something", "that happened");
+                report.setContext("the context");
+            });
+        }
+
+        return links + "<br/>Sent a handled exception to Bugsnag with custom MetaData";
+    }
+
+    @RequestMapping("/send-unhandled-exception")
+    public String sendUnhandledException() throws InterruptedException {
+        // Test an unhanded exception from a different thread as shutdown hooks
+        // won't be called if executed from this thread
+        LOGGER.info("Sending an unhandled exception to Bugsnag");
+        Thread thread = new Thread() {
+            @Override
+            public void run() {
+                throw new RuntimeException("Unhandled exception");
+            }
+        };
+
+        thread.start();
+
+        // Wait for unhandled exception thread to finish
+        thread.join();
+
+        return links + "<br/>Sent an unhandled exception to Bugsnag";
+    }
+
+    @RequestMapping("/shutdown")
+    public void shutdown() throws InterruptedException {
+        LOGGER.info("Shutting down application");
+
+        SpringApplication.exit(applicationContext);
+    }
+}

examples/spring-web/src/main/java/com/bugsnag/example/spring/web/Config.java

@@ -0,0 +1,38 @@
+package com.bugsnag.example.spring.web;
+
+import com.bugsnag.Bugsnag;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.util.Date;
+
+@Configuration
+public class Config {
+
+    // Define singleton bean "bugsnag" which can be injected into any Spring managed class with @Autowired.
+    @Bean
+    public Bugsnag bugsnag() {
+        // Create a Bugsnag client
+        Bugsnag bugsnag = new Bugsnag("YOUR-API-KEY");
+
+        // Set some diagnostic data which will not change during the
+        // lifecycle of the application
+        bugsnag.setReleaseStage("staging");
+        bugsnag.setAppVersion("1.0.1");
+
+        // Create and attach a simple Bugsnag callback.
+        // Use Callbacks to send custom diagnostic data which changes during
+        // the lifecyle of your application
+        bugsnag.addCallback((report) -> {
+            report.addToTab("diagnostics", "timestamp", new Date());
+            report.addToTab("customer", "name", "acme-inc");
+            report.addToTab("customer", "paying", true);
+            report.addToTab("customer", "spent", 1234);
+            report.setUserName("User Name");
+            report.setUserEmail("[email protected]");
+            report.setUserId("12345");
+        });
+
+        return bugsnag;
+    }
+}

examples/spring-web/src/main/resources/application.properties

@@ -0,0 +1 @@
+logging.level.com.bugsnag=DEBUG

examples/spring/README.md

@@ -0,0 +1,9 @@
+# Bugsnag Spring Java Example
+
+A Spring Boot example application to show how to use Bugsnag in a Spring based Java application.
+
+- Run the app
+
+    ```shell
+    ../../gradlew clean bootRun
+    ```

examples/spring/build.gradle

@@ -0,0 +1,23 @@
+apply plugin: 'spring-boot'
+
+buildscript {
+    ext {
+        springBootVersion = '1.4.1.RELEASE'
+    }
+    repositories {
+        jcenter()
+    }
+    dependencies {
+        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
+    }
+}
+
+repositories {
+    jcenter()
+}
+
+dependencies {
+    compile("org.springframework.boot:spring-boot-starter")
+
+    compile rootProject
+}

examples/spring/src/main/java/com/bugsnag/example/spring/cli/Application.java

@@ -0,0 +1,15 @@
+package com.bugsnag.example.spring.cli;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * Kicks off the Spring Boot application.
+ */
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) throws Exception {
+        SpringApplication.run(Application.class, args);
+    }
+}