Added logging support with a default binding to SLF4J-Simple (prints to command line, like before). Also addressed several warnings in the POM during the build. Closes #2, #3, #4, #5

Author: blorp-goes-the-derp

.gitignore

@@ -0,0 +1,24 @@
+# Filesystem Stuff
+**.DS_Store
+
+# Maven output directory
+**/target
+
+### Maven Plugins ###
+.flattened-pom.xml
+
+### Intellij ###
+**/.idea
+**/*.iml
+
+### react ###
+.DS_*
+*.log
+**logs
+**/*.backup.*
+**/*.back.*
+
+**node_modules
+**bower_components
+
+*.sublime*

README.md

@@ -31,7 +31,7 @@ If you don't want your program to wait for a connection you could alternatively
 ```java
 controller.registerConnectCallback(response -> {
 	GetVersionResponse version = (GetVersionResponse) response;
-	System.out.println(version.getObsStudioVersion());
+	log.debug(version.getObsStudioVersion());
 
 	// Other requests...
 });
@@ -47,7 +47,7 @@ OBSRemoteController controller = new OBSRemoteController("ws://localhost:4444",
 Catch any authentication errors by registering a callback for this:
 ```java
 controller.registerConnectionFailedCallback(message -> {
-    System.err.println("Failed to connect: " + message);
+    log.error("Failed to connect: " + message);
 })
 ```
 
@@ -66,6 +66,36 @@ A description of every request and event can be found in the plugin's [**Protoco
 Examples can be found [**here**](src/test/java/net/twasi/obsremotejava/test/OBSRemoteControllerTest.java). Just uncomment the requests you want to test or copy.
 
 ---
+
+## Logging
+This project ships with SLF4J, and uses the SLF4J-Simple binding by default so logs are printed directly to the console. 
+
+If you wish to override this, for example with Logback, you must exclude SLF4J in your POM and add the dependency to the
+binding you want (depends on the vendor)
+```
+<dependencies>
+    <dependency>
+        <groupId>net.twasi</groupId>
+        <artifactId>obs-websocket-java</artifactId>
+        <version>1.0.6-tinatiel-1-0-0</version>
+        <!-- Exclude the default logging implementation -->
+        <exclusions>
+            <exclusion>
+                <groupId>org.slf4j</groupId>
+                <artifactId>slf4j-simple</artifactId>
+            </exclusion>
+        </exclusions>
+    </dependency>
+    
+    <!-- Add your desired logging implementation -->
+    <dependency>
+        <groupId>ch.qos.logback</groupId>
+        <artifactId>logback-classic</artifactId>
+        <version>1.1.7</version>
+    </dependency>
+</dependencies>
+```
+
 ## Contribution
 
 If you miss an endpoint feel free to make a pull request. Any help is appreciated.

pom.xml

@@ -6,7 +6,7 @@
     <name>obs-websocket-java</name>
     <groupId>net.twasi</groupId>
     <artifactId>obs-websocket-java</artifactId>
-    <version>1.0.6-snapshot</version>
+    <version>1.0.6-tinatiel-1-0-0</version>
 
     <description>Library to connect to the OBS WebSocket interface.</description>
     <url>https://github.com/Twasi/obs-websocket-java</url>
@@ -29,21 +29,27 @@
         </developer>
     </developers>
 
-    <scm>
-        <connection>scm:git:git://github.com/Twasi/obs-websocket-java.git</connection>
-        <developerConnection>scm:git:[email protected]:Twasi/obs-websocket-java.git</developerConnection>
-        <url>https://github.com/Twasi/obs-websocket-java</url>
-        <tag>HEAD</tag>
-    </scm>
+<!--    <scm>-->
+<!--        <connection>scm:git:git://github.com/Twasi/obs-websocket-java.git</connection>-->
+<!--        <developerConnection>scm:git:[email protected]:Twasi/obs-websocket-java.git</developerConnection>-->
+<!--        <url>https://github.com/Twasi/obs-websocket-java</url>-->
+<!--        <tag>HEAD</tag>-->
+<!--    </scm>-->
 
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <java.version>8</java.version>
+        <slf4j.version>1.7.30</slf4j.version>
+    </properties>
     <build>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
                 <configuration>
-                    <source>8</source>
-                    <target>8</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
                 </configuration>
             </plugin>
             <plugin>
@@ -67,13 +73,13 @@
                     <skip>false</skip>
                 </configuration>
                 <executions>
-                    <execution>
-                        <id>sign-artifacts</id>
-                        <phase>verify</phase>
-                        <goals>
-                            <goal>sign</goal>
-                        </goals>
-                    </execution>
+<!--                    <execution>-->
+<!--                        <id>sign-artifacts</id>-->
+<!--                        <phase>verify</phase>-->
+<!--                        <goals>-->
+<!--                            <goal>sign</goal>-->
+<!--                        </goals>-->
+<!--                    </execution>-->
                 </executions>
             </plugin>
             <plugin>
@@ -179,6 +185,16 @@
             <artifactId>gson</artifactId>
             <version>2.8.2</version>
         </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
     </dependencies>
 
 </project>

src/main/java/net/twasi/obsremotejava/OBSCommunicator.java

@@ -80,10 +80,9 @@
 import net.twasi.obsremotejava.requests.TransitionToProgram.TransitionToProgramRequest;
 import net.twasi.obsremotejava.requests.TransitionToProgram.TransitionToProgramResponse;
 import org.eclipse.jetty.websocket.api.Session;
-import org.eclipse.jetty.websocket.api.annotations.OnWebSocketClose;
-import org.eclipse.jetty.websocket.api.annotations.OnWebSocketConnect;
-import org.eclipse.jetty.websocket.api.annotations.OnWebSocketMessage;
-import org.eclipse.jetty.websocket.api.annotations.WebSocket;
+import org.eclipse.jetty.websocket.api.annotations.*;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.nio.charset.StandardCharsets;
 import java.security.MessageDigest;
@@ -97,6 +96,8 @@
 
 @WebSocket(maxIdleTime = 360000000)
 public class OBSCommunicator {
+    Logger log = LoggerFactory.getLogger(this.getClass());
+
     private boolean debug;
     private final String password;
     private final CountDownLatch closeLatch;
@@ -147,7 +148,7 @@ public void await() throws InterruptedException {
 
     @OnWebSocketClose
     public void onClose(int statusCode, String reason) {
-        System.out.printf("Connection closed: %d - %s%n", statusCode, reason);
+        log.info("Connection closed: %d - %s%n", statusCode, reason);
         this.closeLatch.countDown(); // trigger latch
         try {
             this.onDisconnect.run(null);
@@ -171,12 +172,12 @@ public void onConnect(Session session) {
     @OnWebSocketMessage
     public void onMessage(String msg) {
         if (msg == null) {
-            System.out.println("Ignored empty message");
+            log.debug("Ignored empty message");
             return;
         }
 
         if (debug) {
-            System.out.println(msg);
+            log.debug(msg);
         }
 
         try {
@@ -189,7 +190,7 @@ public void onMessage(String msg) {
                 try {
                     processIncomingResponse(responseBase, type);
                 } catch (Throwable t) {
-                    System.err.println("Failed to process response '" + type.getSimpleName() + "' from websocket.");
+                    log.error("Failed to process response '" + type.getSimpleName() + "' from websocket.");
                     t.printStackTrace();
                     runOnError("Failed to process response '" + type.getSimpleName() + "' from websocket", t);
                 }
@@ -207,13 +208,13 @@ public void onMessage(String msg) {
                 try {
                     processIncomingEvent(msg, eventType);
                 } catch (Throwable t) {
-                    System.err.println("Failed to execute callback for event: " + eventType);
+                    log.error("Failed to execute callback for event: " + eventType);
                     t.printStackTrace();
                     runOnError("Failed to execute callback for event: " + eventType, t);
                 }
             }
         } catch (Throwable t) {
-            System.err.println("Failed to process message from websocket.");
+            log.error("Failed to process message from websocket.");
             t.printStackTrace();
             runOnError("Failed to process message from websocket", t);
         }
@@ -223,17 +224,17 @@ private void processIncomingResponse(ResponseBase responseBase, Class type) {
         switch (type.getSimpleName()) {
             case "GetVersionResponse":
                 versionInfo = (GetVersionResponse) responseBase;
-                System.out.printf("Connected to OBS. Websocket Version: %s, Studio Version: %s\n", versionInfo.getObsWebsocketVersion(), versionInfo.getObsStudioVersion());
+                log.info("Connected to OBS. Websocket Version: %s, Studio Version: %s\n", versionInfo.getObsWebsocketVersion(), versionInfo.getObsStudioVersion());
                 session.getRemote().sendStringByFuture(new Gson().toJson(new GetAuthRequiredRequest(this)));
                 break;
 
             case "GetAuthRequiredResponse":
                 GetAuthRequiredResponse authRequiredResponse = (GetAuthRequiredResponse) responseBase;
                 if (authRequiredResponse.isAuthRequired()) {
-                    System.out.println("Authentication is required.");
+                    log.info("Authentication is required.");
                     authenticateWithServer(authRequiredResponse.getChallenge(), authRequiredResponse.getSalt());
                 } else {
-                    System.out.println("Authentication is not required. You're ready to go!");
+                    log.info("Authentication is not required. You're ready to go!");
                     runOnConnect(versionInfo);
                 }
                 break;
@@ -250,15 +251,15 @@ private void processIncomingResponse(ResponseBase responseBase, Class type) {
                 break;
             default:
                 if (!callbacks.containsKey(type)) {
-                    System.out.println("Invalid type received: " + type.getName());
+                    log.warn("Invalid type received: " + type.getName());
                     runOnError("Invalid response type received", new InvalidResponseTypeError(type.getName()));
                     return;
                 }
 
                 try {
                     callbacks.get(type).run(responseBase);
                 } catch (Throwable t) {
-                    System.err.println("Failed to execute callback for response: " + type);
+                    log.error("Failed to execute callback for response: " + type);
                     t.printStackTrace();
                     runOnError("Failed to execute callback for response: " + type, t);
                 }
@@ -324,7 +325,7 @@ private void processIncomingEvent(String msg, EventType eventType) {
 
     private void authenticateWithServer(String challenge, String salt) {
         if (password == null) {
-            System.err.println("Authentication required by server but no password set by client");
+            log.error("Authentication required by server but no password set by client");
             runOnConnectionFailed("Authentication required by server but no password set by client");
             return;
         }
@@ -346,7 +347,7 @@ private String generateAuthenticationResponseString(String challenge, String sal
         try {
             digest = MessageDigest.getInstance("SHA-256");
         } catch (NoSuchAlgorithmException e) {
-            System.err.println("Failed to perform password authentication with server");
+            log.error("Failed to perform password authentication with server");
             e.printStackTrace();
             runOnConnectionFailed("Failed to perform password authentication with server");
             return null;
@@ -443,14 +444,14 @@ public void setCurrentTransition(String transition, Callback callback) {
 
     public void setSourceVisiblity(String scene, String source, boolean visibility, Callback callback) {
         SetSceneItemPropertiesRequest request = new SetSceneItemPropertiesRequest(this, scene, source, visibility);
-        System.out.println(new Gson().toJson(request));
+        log.debug(new Gson().toJson(request));
         session.getRemote().sendStringByFuture(new Gson().toJson(request));
         callbacks.put(SetSceneItemPropertiesResponse.class, callback);
     }
 
     public void getSceneItemProperties(String scene, String source, Callback callback) {
         GetSceneItemPropertiesRequest request = new GetSceneItemPropertiesRequest(this, scene, source);
-        System.out.println(new Gson().toJson(request));
+        log.debug(new Gson().toJson(request));
         session.getRemote().sendStringByFuture(new Gson().toJson(request));
         callbacks.put(SetSceneItemPropertiesResponse.class, callback);
     }
@@ -469,7 +470,7 @@ public void transitionToProgram(String transitionName, int duration, Callback ca
 
     public void getSourceSettings(String sourceName, Callback callback) {
         GetSourceSettingsRequest request = new GetSourceSettingsRequest(this, sourceName);
-        System.out.println(new Gson().toJson(request));
+        log.debug(new Gson().toJson(request));
         session.getRemote().sendStringByFuture(new Gson().toJson(request));
         callbacks.put(GetSourceSettingsResponse.class, callback);
     }
@@ -646,7 +647,7 @@ private void runOnError(String message, Throwable throwable) {
         try {
             onError.run(message, throwable);
         } catch (Throwable t) {
-            System.err.println("Exception during callback execution for 'onError'");
+            log.error("Exception during callback execution for 'onError'");
             t.printStackTrace();
         }
     }
@@ -659,7 +660,7 @@ private void runOnConnectionFailed(String message) {
         try {
             onConnectionFailed.run(message);
         } catch (Throwable t) {
-            System.err.println("Exception during callback execution for 'onConnectionFailed'");
+            log.error("Exception during callback execution for 'onConnectionFailed'");
             t.printStackTrace();
         }
     }
@@ -672,7 +673,7 @@ private void runOnConnect(GetVersionResponse versionInfo) {
         try {
             onConnect.run(versionInfo);
         } catch (Throwable t) {
-            System.err.println("Exception during callback execution for 'onConnect'");
+            log.error("Exception during callback execution for 'onConnect'");
             t.printStackTrace();
         }
     }