Partial Idea inspection cleanup

Author: Frohwalt Egerer

CHANGELOG

@@ -6,21 +6,21 @@ Version 0.2.4.build-SNAPSHOT - (in progress)
 Version 0.2.3 - Mar 30, 2013
   - return back to com.notnoop.apns group id (#91)
 
-  - Add NOOP delegate adapter and ability to build service with keystore (#93)
+  - Add no operation delegate adapter and ability to build service with keystore (#93)
   - Proxy support for Feedback connection (#92)
   - Make APNS class final    
   - Batch APNS (#14)
   - Update dependencies (#85 #84)
 
 Version 0.2.2 - Jan 20, 2013
   - ApnsConnection resend unsent notifications after error
-  - Do not stop QueuedApnsService on unsuccessfull attempt to submit a message
+  - Do not stop QueuedApnsService on unsuccessful attempt to submit a message
   - Continuous integration builds on travis ci
   - Support Proxy.Type.HTTP.
   - Do not log error messages for retries when sending a message, rather
     log one when we can't send a message at all.
   - When there is an error (error packet or exception in parsing error packet)
-    close the socket instead of wating for APNS to close it.
+    close the socket instead of waiting for APNS to close it.
   - java-apns now is an osgi bundle
   - Have ApnsService.push return sent messages
   - Add changelog

README.markdown

@@ -30,7 +30,7 @@ Features:
   *  Easy to use, high performance APNS Service API
   *  Supports Apple Feedback service
   *  Support Enhanced Apple Push Notification
-  *  Support MDM and Newstand Notifications
+  *  Support MDM and Newsstand Notifications
   *  Easy to use with Apple certificates
   *  Easy to extend and reuse
   *  Easy to integrate with dependency injection frameworks

docs/cachedNotification_queue.md

@@ -4,7 +4,7 @@ java-apns maintains a per-connection sent queue (cachedNotifications) like descr
 
    * java-apns queue is bounded (cacheNotification() will poll notifications out of the queue when the queue gets too big.)
 
-   * It does not regularily check whether sent messages have been sent a few seconds ago to remove them from the sent queue. 
+   * It does not regularly check whether sent messages have been sent a few seconds ago to remove them from the sent queue.
 
 So if we send a lot of notifications without failure the old notifications will fall off the queue. This is typically ok (since they are "older" and probably have been sent successfully). The queue only serves to cache all the messages sent in between the client sending a bad notification and the APNS server replying.
 

src/main/java/com/notnoop/apns/ApnsDelegate.java

@@ -43,7 +43,7 @@ public interface ApnsDelegate {
      * Called when message was successfully sent to the Apple servers
      *
      * @param message the notification that was sent
-     * @param resent whether the notfication was resent after an error
+     * @param resent whether the notification was resent after an error
      */
     public void messageSent(ApnsNotification message, boolean resent);
 
@@ -86,7 +86,7 @@ public interface ApnsDelegate {
     public void notificationsResent(int resendCount);
 
     /**
-     * A NOOP delegate that does nothing!
+     * A no operation delegate that does nothing!
      */
     public final static ApnsDelegate EMPTY = new ApnsDelegateAdapter();
 }

src/main/java/com/notnoop/apns/ApnsDelegateAdapter.java

@@ -1,7 +1,7 @@
 package com.notnoop.apns;
 
 /**
- * A NOOP delegate that does nothing!
+ * A no operation delegate that does nothing!
  */
 public class ApnsDelegateAdapter implements ApnsDelegate {
 

src/main/java/com/notnoop/apns/ApnsService.java

@@ -60,7 +60,7 @@ public interface ApnsService {
      *
      * @param deviceToken   the destination iPhone device token
      * @param payload       The payload message
-     * @throws NetworkIOException if a network error occured while
+     * @throws NetworkIOException if a network error occurred while
      *      attempting to send the message
      */
     ApnsNotification push(String deviceToken, String payload) throws NetworkIOException;
@@ -119,7 +119,7 @@ public interface ApnsService {
     /**
      * Sends the provided notification {@code message} to the desired
      * destination.
-     * @throws NetworkIOException if a network error occured while
+     * @throws NetworkIOException if a network error occurred while
      *      attempting to send the message
      */
     void push(ApnsNotification message) throws NetworkIOException;
@@ -128,7 +128,7 @@ public interface ApnsService {
      * Starts the service.
      *
      * The underlying implementation may prepare its connections or
-     * datastructures to be able to send the messages.
+     * data structures to be able to send the messages.
      *
      * This method is a blocking call, even if the service represents
      * a Non-blocking push service.  Once the service is returned, it is ready

src/main/java/com/notnoop/apns/ApnsServiceBuilder.java

@@ -78,7 +78,7 @@ public class ApnsServiceBuilder {
     private int connectTimeout = 0;
 
     private String gatewayHost;
-    private int gatewaPort = -1;
+    private int gatewayPort = -1;
 
     private String feedbackHost;
     private int feedbackPort;
@@ -121,7 +121,7 @@ public class ApnsServiceBuilder {
      * This library does not support password-less p12 certificates, due to a
      * Oracle Java library <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6415637">
      * Bug 6415637</a>.  There are three workarounds: use a password-protected
-     * certificate, use a different boot Java SDK implementation, or constract
+     * certificate, use a different boot Java SDK implementation, or construct
      * the `SSLContext` yourself!  Needless to say, the password-protected
      * certificate is most recommended option.
      *
@@ -184,7 +184,7 @@ public ApnsServiceBuilder withCert(InputStream stream, String password)
      * This library does not support password-less p12 certificates, due to a
      * Oracle Java library <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6415637">
      * Bug 6415637</a>.  There are three workarounds: use a password-protected
-     * certificate, use a different boot Java SDK implementation, or constract
+     * certificate, use a different boot Java SDK implementation, or construct
      * the `SSLContext` yourself!  Needless to say, the password-protected
      * certificate is most recommended option.
      *
@@ -227,7 +227,7 @@ public ApnsServiceBuilder withSSLContext(SSLContext sslContext) {
 
     /**
      * Specify the timeout value to be set in new setSoTimeout in created
-     * sockets, for both feedback and push connections, in msecs.
+     * sockets, for both feedback and push connections, in milliseconds.
      * @param readTimeout timeout value to be set in new setSoTimeout
      * @return this
      */
@@ -238,7 +238,7 @@ public ApnsServiceBuilder withReadTimeout(int readTimeout) {
 
     /**
      * Specify the timeout value to use for connectionTimeout in created
-     * sockets, for both feedback and push connections, in msecs.
+     * sockets, for both feedback and push connections, in milliseconds.
      * @param connectTimeout timeout value to use for connectionTimeout
      * @return this
      */
@@ -261,7 +261,7 @@ public ApnsServiceBuilder withConnectTimeout(int connectTimeout) {
      */
     public ApnsServiceBuilder withGatewayDestination(String host, int port) {
         this.gatewayHost = host;
-        this.gatewaPort = port;
+        this.gatewayPort = port;
         return this;
     }
 
@@ -422,7 +422,7 @@ public ApnsServiceBuilder withProxy(Proxy proxy) {
     }
 
     /**
-     * Specity the number of notifications to cache for error purposes.
+     * Specify the number of notifications to cache for error purposes.
      * Default is 100
      * 
      * @param cacheLength  Number of notifications to cache for error purposes
@@ -614,8 +614,8 @@ public ApnsService build() {
         SSLSocketFactory sslFactory = sslContext.getSocketFactory();
         ApnsFeedbackConnection feedback = new ApnsFeedbackConnection(sslFactory, feedbackHost, feedbackPort, proxy, readTimeout, connectTimeout, proxyUsername, proxyPassword);
 
-        ApnsConnection conn = new ApnsConnectionImpl(sslFactory, gatewayHost, 
-                gatewaPort, proxy, proxyUsername, proxyPassword, reconnectPolicy, 
+        ApnsConnection conn = new ApnsConnectionImpl(sslFactory, gatewayHost,
+            gatewayPort, proxy, proxyUsername, proxyPassword, reconnectPolicy,
                 delegate, errorDetection, errorDetectionThreadFactory, cacheLength,
                 autoAdjustCacheLength, readTimeout, connectTimeout);
         if (pooledMax != 1) {
@@ -642,7 +642,7 @@ private void checkInitialization() {
             throw new IllegalStateException(
                     "SSL Certificates and attribute are not initialized\n"
                     + "Use .withCert() methods.");
-        if (gatewayHost == null || gatewaPort == -1)
+        if (gatewayHost == null || gatewayPort == -1)
             throw new IllegalStateException(
                     "The Destination APNS server is not stated\n"
                     + "Use .withDestination(), withSandboxDestination(), "

src/main/java/com/notnoop/apns/SimpleApnsNotification.java

@@ -41,14 +41,15 @@
  * and should not be used in new development.
  * https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/LegacyFormat.html
  *
- * This SimpleApnsNotification also only has limited error handly (by the APNS closing the connection
+ * This SimpleApnsNotification also only has limited error handling (by the APNS closing the connection
  * when a bad message was received) This prevents us from location the malformed notification.
  *
  * As push messages sent after a malformed notification are discarded by APNS messages will get lost
  * and not be delivered with the SimpleApnsNotification.
  *
  * @deprecated use EnhancedApnsNotification instead.
  */
+@SuppressWarnings("deprecation")
 @Deprecated
 public class SimpleApnsNotification implements ApnsNotification {
 

src/main/java/com/notnoop/apns/internal/AbstractApnsService.java

@@ -82,9 +82,9 @@ public Collection<EnhancedApnsNotification> push(Collection<String> deviceTokens
         byte[] messageBytes = Utilities.toUTF8Bytes(payload);
         List<EnhancedApnsNotification> notifications = new ArrayList<EnhancedApnsNotification>(deviceTokens.size());
         for (String deviceToken : deviceTokens) {
-            byte[] dtbytes = Utilities.decodeHex(deviceToken);
+            byte[] dtBytes = Utilities.decodeHex(deviceToken);
             EnhancedApnsNotification notification =
-                new EnhancedApnsNotification(c.incrementAndGet(), EnhancedApnsNotification.MAXIMUM_EXPIRY, dtbytes, messageBytes);
+                new EnhancedApnsNotification(c.incrementAndGet(), EnhancedApnsNotification.MAXIMUM_EXPIRY, dtBytes, messageBytes);
             notifications.add(notification);
             push(notification);
         }
@@ -95,9 +95,9 @@ public Collection<EnhancedApnsNotification> push(Collection<String> deviceTokens
         byte[] messageBytes = Utilities.toUTF8Bytes(payload);
         List<EnhancedApnsNotification> notifications = new ArrayList<EnhancedApnsNotification>(deviceTokens.size());
         for (String deviceToken : deviceTokens) {
-            byte[] dtbytes = Utilities.decodeHex(deviceToken);
+            byte[] dtBytes = Utilities.decodeHex(deviceToken);
             EnhancedApnsNotification notification =
-                new EnhancedApnsNotification(c.incrementAndGet(), (int)(expiry.getTime() / 1000), dtbytes, messageBytes);
+                new EnhancedApnsNotification(c.incrementAndGet(), (int)(expiry.getTime() / 1000), dtBytes, messageBytes);
             notifications.add(notification);
             push(notification);
         }

src/main/java/com/notnoop/apns/internal/ApnsFeedbackConnection.java

@@ -84,7 +84,7 @@ public Map<String, Date> getInactiveDevices() throws NetworkIOException {
                 attempts = 0;
                 return result;
             } catch (final Exception e) {
-                logger.warn("Failed to retreive invalid devices", e);
+                logger.warn("Failed to retrieve invalid devices", e);
                 if (attempts >= RETRIES) {
                     logger.error("Couldn't get feedback connection", e);
                     Utilities.wrapAndThrowAsRuntimeException(e);

src/main/java/com/notnoop/apns/internal/BatchApnsService.java

@@ -41,7 +41,7 @@ public class BatchApnsService extends AbstractApnsService {
 	private ScheduledExecutorService scheduleService;
 	private ScheduledFuture<?> taskFuture;
 
-	private Runnable batchRunner = new SendMessagessBatch();
+	private Runnable batchRunner = new SendMessagesBatch();
 
 	public BatchApnsService(ApnsConnection prototype, ApnsFeedbackConnection feedback, int batchWaitTimeInSec, int maxBachWaitTimeInSec, ThreadFactory tf) {
 		super(feedback);
@@ -73,9 +73,9 @@ public void push(ApnsNotification message) throws NetworkIOException {
 			firstMessageArrivedTime = System.nanoTime();
 		}
 
-		long sincFirstMessageSec = (System.nanoTime() - firstMessageArrivedTime) / 1000 / 1000 / 1000;
+		long sinceFirstMessageSec = (System.nanoTime() - firstMessageArrivedTime) / 1000 / 1000 / 1000;
 
-		if (taskFuture != null && sincFirstMessageSec < maxBatchWaitTimeInSec) {
+		if (taskFuture != null && sinceFirstMessageSec < maxBatchWaitTimeInSec) {
 			taskFuture.cancel(false);
 		}
 
@@ -86,7 +86,7 @@ public void push(ApnsNotification message) throws NetworkIOException {
 		}
 	}
 
-	class SendMessagessBatch implements Runnable {
+	class SendMessagesBatch implements Runnable {
 		public void run() {
 			ApnsConnection newConnection = prototype.copy();
 			try {

src/main/java/com/notnoop/apns/internal/TlsTunnelBuilder.java

@@ -79,14 +79,14 @@ public Socket build(SSLSocketFactory factory, Proxy proxy, String proxyUsername,
     }
 
     @SuppressFBWarnings(value = "VA_FORMAT_STRING_USES_NEWLINE",
-            justification = "use <CR><LF> as according to RFC, not platform-linfeed")
+            justification = "use <CR><LF> as according to RFC, not platform-linefeed")
     Socket makeTunnel(String host, int port, String proxyUsername, 
             String proxyPassword, InetSocketAddress proxyAddress) throws IOException {
         if(host == null || port < 0 || host.isEmpty() || proxyAddress == null){
             throw new ProtocolException("Incorrect parameters to build tunnel.");   
         }
         logger.debug("Creating socket for Proxy : " + proxyAddress.getAddress() + ":" + proxyAddress.getPort());
-        Socket socket = null;
+        Socket socket;
         try {
             ProxyClient client = new ProxyClient();
             client.getParams().setParameter("http.useragent", "java-apns");
@@ -100,7 +100,7 @@ Socket makeTunnel(String host, int port, String proxyUsername,
             if (socket == null) {
                 ConnectMethod method = response.getConnectMethod();
                 // Read the proxy's HTTP response.
-                if(method.getStatusLine().toString().matches("HTTP\\/1\\.\\d 407 Proxy Authentication Required")) {
+                if(method.getStatusLine().toString().matches("HTTP/1\\.\\d 407 Proxy Authentication Required")) {
                     // Proxy server returned 407. We will now try to connect with auth Header
                     if(proxyUsername != null && proxyPassword != null) {
                         socket = AuthenticateProxy(method, client,proxyHost, proxyAddress.getPort(),
@@ -114,7 +114,9 @@ Socket makeTunnel(String host, int port, String proxyUsername,
         } catch (Exception e) {
             throw new ProtocolException("Error occurred while creating proxy socket : " + e.toString());
         }
-        logger.debug("Socket for proxy created successfully : " + socket.getRemoteSocketAddress().toString());
+        if (socket != null) {
+            logger.debug("Socket for proxy created successfully : " + socket.getRemoteSocketAddress().toString());
+        }
         return socket;
     }
 

src/main/java/com/notnoop/apns/internal/Utilities.java

@@ -103,9 +103,9 @@ public static SSLContext newSSLContext(final KeyStore ks, final String password,
                tmf.init((KeyStore)null);
 
                // Get the SSLContext to help create SSLSocketFactory
-               final SSLContext sslc = SSLContext.getInstance("TLS");
-               sslc.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null);
-               return sslc;
+               final SSLContext sslContext = SSLContext.getInstance("TLS");
+               sslContext.init(kmf.getKeyManagers(), tmf.getTrustManagers(), null);
+               return sslContext;
            } catch (final GeneralSecurityException e) {
                throw new InvalidSSLConfig(e);
            }
@@ -117,12 +117,12 @@ public static byte[] decodeHex(final String deviceToken) {
 
         final byte[] bts = new byte[hex.length() / 2];
         for (int i = 0; i < bts.length; i++) {
-            bts[i] = (byte) (charval(hex.charAt(2*i)) * 16 + charval(hex.charAt(2*i + 1)));
+            bts[i] = (byte) (charVal(hex.charAt(2 * i)) * 16 + charVal(hex.charAt(2 * i + 1)));
         }
         return bts;
     }
 
-    private static int charval(final char a) {
+    private static int charVal(final char a) {
         if ('0' <= a && a <= '9') {
             return (a - '0');
         } else if ('a' <= a && a <= 'f') {

src/test/java/com/notnoop/apns/ApnsGatewayServerSocket.java

@@ -63,7 +63,7 @@ void handleSocket(Socket socket) throws IOException {
 			} catch (IOException ioe) {
 				writeResponse(socket, identifier, 8, 1);
 				break;
-			} catch (Exception expt) {
+			} catch (Exception e) {
 				writeResponse(socket, identifier, 8, 1);
 				break;
 			}
@@ -88,7 +88,8 @@ private void writeResponse(Socket socket, int identifier, int command,
 	private byte[] toArray(InputStream inputStream, int size)
 			throws IOException {
 		byte[] bytes = new byte[size];
-		inputStream.read(bytes);
+        final DataInputStream dis = new DataInputStream(inputStream);
+        dis.readFully(bytes);
 		return bytes;
 	}
 }

src/test/java/com/notnoop/apns/ApnsServerSocketBuilder.java

@@ -91,7 +91,7 @@ public ApnsServerSocketBuilder() {
 	 * Oracle Java library <a
 	 * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6415637"> Bug
 	 * 6415637</a>. There are three workarounds: use a password-protected
-	 * certificate, use a different boot Java SDK implementation, or constract
+	 * certificate, use a different boot Java SDK implementation, or construct
 	 * the `SSLContext` yourself! Needless to say, the password-protected
 	 * certificate is most recommended option.
 	 * 
@@ -130,7 +130,7 @@ public ApnsServerSocketBuilder withCert(String fileName, String password)
 	 * Oracle Java library <a
 	 * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6415637"> Bug
 	 * 6415637</a>. There are three workarounds: use a password-protected
-	 * certificate, use a different boot Java SDK implementation, or constract
+	 * certificate, use a different boot Java SDK implementation, or construct
 	 * the `SSLContext` yourself! Needless to say, the password-protected
 	 * certificate is most recommended option.
 	 * 
@@ -158,7 +158,7 @@ public ApnsServerSocketBuilder withCert(InputStream stream, String password)
 	 * Oracle Java library <a
 	 * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6415637"> Bug
 	 * 6415637</a>. There are three workarounds: use a password-protected
-	 * certificate, use a different boot Java SDK implementation, or constract
+	 * certificate, use a different boot Java SDK implementation, or construct
 	 * the `SSLContext` yourself! Needless to say, the password-protected
 	 * certificate is most recommended option.
 	 * 

src/test/java/com/notnoop/apns/MainClass.java

@@ -10,7 +10,7 @@
 public class MainClass {
 
     /**
-     * @param args
+     * @param args Program arguments
      * @throws FileNotFoundException
      * @throws InvalidSSLConfig
      */

src/test/java/com/notnoop/apns/integration/ApnsSimulatorTest.java

@@ -89,8 +89,8 @@ public void testClientDoesNotResendMessagesWhenServerClosesSocketWithoutErrorPac
 
     @Ignore
     @Test
-    public void Racecondition() {
-        // TODO implement test & decide if fix is neccessary afterwards.
+    public void RaceCondition() {
+        // TODO implement test & decide if fix is necessary afterwards.
         Assert.fail("Assumption: monitoring thread crashes in read() when the sender thread closes the connection first.");
         // Thus the last feedback message gets lost, thus we lose messages.
     }