Merge pull request #270 from DevFactory/release/exception-handlers-fix-1

matzew · web-flow · commit a7d1e9fa1546 · 2016-06-28T22:58:39.000+02:00
Code quality fix - Exception handlers should preserve the original exception
diff --git a/src/main/java/com/notnoop/apns/EnhancedApnsNotification.java b/src/main/java/com/notnoop/apns/EnhancedApnsNotification.java
@@ -34,12 +34,16 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import com.notnoop.apns.internal.Utilities;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import java.io.UnsupportedEncodingException;
 
 /**
  * Represents an APNS notification to be sent to Apple service.
  */
 public class EnhancedApnsNotification implements ApnsNotification {
-
+	
+    private static final Logger LOGGER = LoggerFactory.getLogger(EnhancedApnsNotification.class);
     private final static byte COMMAND = 1;
     private static AtomicInteger nextId = new AtomicInteger(0);
     private final int identifier;
@@ -168,7 +172,8 @@ public String toString() {
         String payloadString;
         try {
             payloadString = new String(payload, "UTF-8");
-        } catch (Exception ex) {
+        } catch (UnsupportedEncodingException ex) {
+            LOGGER.debug("UTF-8 charset not found on the JRE", ex);
             payloadString = "???";
         }
         return "Message(Id="+identifier+"; Token="+Utilities.encodeHex(deviceToken)+"; Payload="+payloadString+")";
diff --git a/src/main/java/com/notnoop/apns/SimpleApnsNotification.java b/src/main/java/com/notnoop/apns/SimpleApnsNotification.java
@@ -34,7 +34,9 @@
 
 import com.notnoop.apns.internal.Utilities;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import java.io.UnsupportedEncodingException;
 
 /**
  * Represents an APNS notification to be sent to Apple service. This is for legacy use only
@@ -52,7 +54,8 @@
 @SuppressWarnings("deprecation")
 @Deprecated
 public class SimpleApnsNotification implements ApnsNotification {
-
+	
+    private static final Logger LOGGER = LoggerFactory.getLogger(SimpleApnsNotification.class);
     private final static byte COMMAND = 0;
     private final byte[] deviceToken;
     private final byte[] payload;
@@ -155,7 +158,8 @@ public String toString() {
         String payloadString;
         try {
             payloadString = new String(payload, "UTF-8");
-        } catch (Exception ex) {
+        } catch (UnsupportedEncodingException ex) {
+            LOGGER.debug("UTF-8 charset not found on the JRE", ex);
             payloadString = "???";
         }
         return "Message(Token="+Utilities.encodeHex(deviceToken)+"; Payload="+payloadString+")";
diff --git a/src/main/java/com/notnoop/apns/internal/ApnsConnectionImpl.java b/src/main/java/com/notnoop/apns/internal/ApnsConnectionImpl.java
@@ -147,6 +147,7 @@ public void run() {
                     try {
                         in = socket.getInputStream();
                     } catch (IOException ioe) {
+                        logger.warn("The value of socket is null", ioe);
                         in = null;
                     }
 
diff --git a/src/test/java/com/notnoop/apns/utils/ApnsServerStub.java b/src/test/java/com/notnoop/apns/utils/ApnsServerStub.java
@@ -41,6 +41,8 @@
 import java.nio.ByteBuffer;
 import java.util.concurrent.Semaphore;
 import java.util.concurrent.atomic.AtomicInteger;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class ApnsServerStub {
 
@@ -70,7 +72,8 @@ public static ApnsServerStub prepareAndStartServer() {
         server.start();
         return server;
     }
-
+    
+    private static final Logger LOGGER = LoggerFactory.getLogger(ApnsServerStub.class);
     private final AtomicInteger toWaitBeforeSend = new AtomicInteger(0);
     private final ByteArrayOutputStream received;
     private final ByteArrayOutputStream toSend;
@@ -118,14 +121,14 @@ public void stop() {
                 gatewaySocket.close();
             }
         } catch (IOException e) {
-            e.printStackTrace();
+            LOGGER.warn("Can not close gatewaySocket properly", e);
         }
         try {
             if (feedbackSocket != null) {
                 feedbackSocket.close();
             }
         } catch (IOException e) {
-            e.printStackTrace();
+            LOGGER.warn("Can not close feedbackSocket properly", e);
         }
 
         if (gatewayThread != null) {
@@ -146,7 +149,7 @@ public void sendError(int err, int id) {
             gatewayOutputStream.write(buf.array());
             gatewayOutputStream.flush();
         } catch (Exception ex) {
-            ex.printStackTrace();
+            LOGGER.warn("An error occured with accessing gateway", ex);
         }
     }
 
@@ -227,14 +230,14 @@ public void run() {
                         in.close();
                     }
                 } catch (IOException ioex) {
-                    System.err.println(ioex.toString());
+                    LOGGER.warn("Can not close socket properly", ioex);
                 }
                 try {
                     if (gatewayOutputStream != null) {
                         gatewayOutputStream.close();
                     }
                 } catch (IOException ioex) {
-                    System.err.println(ioex.toString());
+                    LOGGER.warn("Can not close gatewayOutputStream properly", ioex);
                 }
                 messages.release();
             }
diff --git a/src/test/java/com/notnoop/apns/utils/Simulator/ApnsServerSimulator.java b/src/test/java/com/notnoop/apns/utils/Simulator/ApnsServerSimulator.java
@@ -85,14 +85,14 @@ public void stop() {
                 gatewaySocket.close();
             }
         } catch (IOException e) {
-            e.printStackTrace();
+            logger.warn("Can not close gatewaySocket properly", e);
         }
         try {
             if (feedbackSocket != null) {
                 feedbackSocket.close();
             }
         } catch (IOException e) {
-            e.printStackTrace();
+            logger.warn("Can not close feedbackSocket properly", e);
         }
 
         if (gatewayThread != null) {
@@ -141,9 +141,10 @@ public void run() {
                     try {
                         handleGatewayConnection(new InputOutputSocket(gatewaySocket.accept()));
                     } catch (SocketException ex) {
+                        logger.warn("Interruption while handling gateway connection", ex);
                         interrupt();
                     } catch (IOException ioe) {
-                        ioe.printStackTrace();
+                        logger.warn("An error occured while handling gateway connection", ioe);
                     }
                 }
             } finally {
@@ -186,6 +187,7 @@ private void parseNotifications(final InputOutputSocket inputOutputSocket) {
                             break;
                     }
                 } catch (IOException ioe) {
+                	logger.warn("An error occured while reading notification", ioe);
                     Thread.currentThread().interrupt();
                 }
             }
@@ -255,7 +257,7 @@ public void interrupt() {
             try {
                 gatewaySocket.close();
             } catch (IOException e) {
-                e.printStackTrace();
+                logger.warn("Can not close gatewaySocket properly", e);
             }
         }
     }
@@ -310,9 +312,10 @@ public void run() {
                     try {
                         handleFeedbackConnection(new InputOutputSocket(feedbackSocket.accept()));
                     } catch (SocketException ex) {
+                        logger.warn("Interruption while handling feedback connection", ex);
                         interrupt();
                     } catch (IOException ioe) {
-                        ioe.printStackTrace();
+                        logger.warn("An error occured while handling feedback connection", ioe);
                     }
                 }
             } finally {
@@ -331,7 +334,7 @@ public void run() {
                         sendFeedback(inputOutputSocket);
                     } catch (IOException ioe) {
                         // An exception is unexpected here. Close the current connection and bail out.
-                        ioe.printStackTrace();
+                        logger.warn("An error occured while sending feedback", ioe);
                     } finally {
                         inputOutputSocket.close();
                     }
diff --git a/src/test/java/com/notnoop/apns/utils/Simulator/InputOutputSocket.java b/src/test/java/com/notnoop/apns/utils/Simulator/InputOutputSocket.java
@@ -33,11 +33,14 @@
 import java.io.DataOutputStream;
 import java.io.IOException;
 import java.net.Socket;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Wrap some of the boilerplate code using socket, enable passing around a socket together with its streams.
  */
 public class InputOutputSocket {
+    private static final Logger LOGGER = LoggerFactory.getLogger(InputOutputSocket.class);
     private final Socket socket;
     private final ApnsInputStream inputStream;
     private final DataOutputStream outputStream;
@@ -75,19 +78,19 @@ public synchronized void close() {
         try {
             inputStream.close();
         } catch (IOException e) {
-            e.printStackTrace();
+            LOGGER.warn("Can not close inputStream properly", e);
         }
 
         try {
             outputStream.close();
         } catch (IOException e) {
-            e.printStackTrace();
+            LOGGER.warn("Can not close outputStream properly", e);
         }
 
         try {
             socket.close();
         } catch (IOException e) {
-            e.printStackTrace();
+            LOGGER.warn("Can not close socket properly", e);
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -147,6 +147,7 @@ public void run() {`
`147`	`147`	`try {`
`148`	`148`	`in = socket.getInputStream();`
`149`	`149`	`} catch (IOException ioe) {`
	`150`	`+ logger.warn("The value of socket is null", ioe);`
`150`	`151`	`in = null;`
`151`	`152`	`}`
`152`	`153`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,8 @@`
`41`	`41`	`import java.nio.ByteBuffer;`
`42`	`42`	`import java.util.concurrent.Semaphore;`
`43`	`43`	`import java.util.concurrent.atomic.AtomicInteger;`
	`44`	`+import org.slf4j.Logger;`
	`45`	`+import org.slf4j.LoggerFactory;`
`44`	`46`
`45`	`47`	`public class ApnsServerStub {`
`46`	`48`
`@@ -70,7 +72,8 @@ public static ApnsServerStub prepareAndStartServer() {`
`70`	`72`	`server.start();`
`71`	`73`	`return server;`
`72`	`74`	`}`
`73`		`-`
	`75`	`+`
	`76`	`+ private static final Logger LOGGER = LoggerFactory.getLogger(ApnsServerStub.class);`
`74`	`77`	`private final AtomicInteger toWaitBeforeSend = new AtomicInteger(0);`
`75`	`78`	`private final ByteArrayOutputStream received;`
`76`	`79`	`private final ByteArrayOutputStream toSend;`
`@@ -118,14 +121,14 @@ public void stop() {`
`118`	`121`	`gatewaySocket.close();`
`119`	`122`	`}`
`120`	`123`	`} catch (IOException e) {`
`121`		`- e.printStackTrace();`
	`124`	`+ LOGGER.warn("Can not close gatewaySocket properly", e);`
`122`	`125`	`}`
`123`	`126`	`try {`
`124`	`127`	`if (feedbackSocket != null) {`
`125`	`128`	`feedbackSocket.close();`
`126`	`129`	`}`
`127`	`130`	`} catch (IOException e) {`
`128`		`- e.printStackTrace();`
	`131`	`+ LOGGER.warn("Can not close feedbackSocket properly", e);`
`129`	`132`	`}`
`130`	`133`
`131`	`134`	`if (gatewayThread != null) {`
`@@ -146,7 +149,7 @@ public void sendError(int err, int id) {`
`146`	`149`	`gatewayOutputStream.write(buf.array());`
`147`	`150`	`gatewayOutputStream.flush();`
`148`	`151`	`} catch (Exception ex) {`
`149`		`- ex.printStackTrace();`
	`152`	`+ LOGGER.warn("An error occured with accessing gateway", ex);`
`150`	`153`	`}`
`151`	`154`	`}`
`152`	`155`
`@@ -227,14 +230,14 @@ public void run() {`
`227`	`230`	`in.close();`
`228`	`231`	`}`
`229`	`232`	`} catch (IOException ioex) {`
`230`		`- System.err.println(ioex.toString());`
	`233`	`+ LOGGER.warn("Can not close socket properly", ioex);`
`231`	`234`	`}`
`232`	`235`	`try {`
`233`	`236`	`if (gatewayOutputStream != null) {`
`234`	`237`	`gatewayOutputStream.close();`
`235`	`238`	`}`
`236`	`239`	`} catch (IOException ioex) {`
`237`		`- System.err.println(ioex.toString());`
	`240`	`+ LOGGER.warn("Can not close gatewayOutputStream properly", ioex);`
`238`	`241`	`}`
`239`	`242`	`messages.release();`
`240`	`243`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,14 +85,14 @@ public void stop() {`
`85`	`85`	`gatewaySocket.close();`
`86`	`86`	`}`
`87`	`87`	`} catch (IOException e) {`
`88`		`- e.printStackTrace();`
	`88`	`+ logger.warn("Can not close gatewaySocket properly", e);`
`89`	`89`	`}`
`90`	`90`	`try {`
`91`	`91`	`if (feedbackSocket != null) {`
`92`	`92`	`feedbackSocket.close();`
`93`	`93`	`}`
`94`	`94`	`} catch (IOException e) {`
`95`		`- e.printStackTrace();`
	`95`	`+ logger.warn("Can not close feedbackSocket properly", e);`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`if (gatewayThread != null) {`
`@@ -141,9 +141,10 @@ public void run() {`
`141`	`141`	`try {`
`142`	`142`	`handleGatewayConnection(new InputOutputSocket(gatewaySocket.accept()));`
`143`	`143`	`} catch (SocketException ex) {`
	`144`	`+ logger.warn("Interruption while handling gateway connection", ex);`
`144`	`145`	`interrupt();`
`145`	`146`	`} catch (IOException ioe) {`
`146`		`- ioe.printStackTrace();`
	`147`	`+ logger.warn("An error occured while handling gateway connection", ioe);`
`147`	`148`	`}`
`148`	`149`	`}`
`149`	`150`	`} finally {`
`@@ -186,6 +187,7 @@ private void parseNotifications(final InputOutputSocket inputOutputSocket) {`
`186`	`187`	`break;`
`187`	`188`	`}`
`188`	`189`	`} catch (IOException ioe) {`
	`190`	`+ logger.warn("An error occured while reading notification", ioe);`
`189`	`191`	`Thread.currentThread().interrupt();`
`190`	`192`	`}`
`191`	`193`	`}`
`@@ -255,7 +257,7 @@ public void interrupt() {`
`255`	`257`	`try {`
`256`	`258`	`gatewaySocket.close();`
`257`	`259`	`} catch (IOException e) {`
`258`		`- e.printStackTrace();`
	`260`	`+ logger.warn("Can not close gatewaySocket properly", e);`
`259`	`261`	`}`
`260`	`262`	`}`
`261`	`263`	`}`
`@@ -310,9 +312,10 @@ public void run() {`
`310`	`312`	`try {`
`311`	`313`	`handleFeedbackConnection(new InputOutputSocket(feedbackSocket.accept()));`
`312`	`314`	`} catch (SocketException ex) {`
	`315`	`+ logger.warn("Interruption while handling feedback connection", ex);`
`313`	`316`	`interrupt();`
`314`	`317`	`} catch (IOException ioe) {`
`315`		`- ioe.printStackTrace();`
	`318`	`+ logger.warn("An error occured while handling feedback connection", ioe);`
`316`	`319`	`}`
`317`	`320`	`}`
`318`	`321`	`} finally {`
`@@ -331,7 +334,7 @@ public void run() {`
`331`	`334`	`sendFeedback(inputOutputSocket);`
`332`	`335`	`} catch (IOException ioe) {`
`333`	`336`	`// An exception is unexpected here. Close the current connection and bail out.`
`334`		`- ioe.printStackTrace();`
	`337`	`+ logger.warn("An error occured while sending feedback", ioe);`
`335`	`338`	`} finally {`
`336`	`339`	`inputOutputSocket.close();`
`337`	`340`	`}`