v0.5 - Refactoring Experience (#100)

* Updating to 0.4

* Updatng to v0.5

* Fixing parsing bug

* Updating type safety

* Cleaning up based upon comments

* Updating typings

* Updating for v0.5

Author: mpodwysocki

NotificationHubs/pom.xml

@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.windowsazure</groupId>
 	<artifactId>Notification-Hubs-java-sdk</artifactId>
-	<version>0.4.2</version>
+	<version>0.5.0</version>
 	<name>Windows Azure Notification Hubs Java SDK</name>
   <url>https://github.com/Azure/azure-notificationhubs-java-backend</url>
   <description>Azure Notification Hubs Java SDK for interacting with the data and management plane operations.</description>

NotificationHubs/src/com/windowsazure/messaging/AdmCredential.java

@@ -8,41 +8,60 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * This class represents Amazon PNS credentials.
+ */
 public final class AdmCredential extends PnsCredential {
     private String clientId;
     private String clientSecret;
 
+    /**
+     * Creates a new instance of the AdmCredential class.
+     */
     public AdmCredential() {
-        this(null, null);
+        super();
     }
 
+    /**
+     * Creates a new instance of the AdmCredential class.
+     * @param clientId The Amazon client ID.
+     * @param clientSecret The Amazon client secret.
+     */
     public AdmCredential(String clientId, String clientSecret) {
         super();
         this.setClientId(clientId);
         this.setClientSecret(clientSecret);
     }
 
-    public String getClientId() {
-        return clientId;
-    }
+    /**
+     * Gets the Amazon client ID.
+     * @return The Amazon client ID.
+     */
+    public String getClientId() { return clientId; }
 
-    public void setClientId(String clientId) {
-        this.clientId = clientId;
-    }
+    /**
+     * Gets the Amazon client ID.
+     * @param value THe Amazon client ID to set.
+     */
+    public void setClientId(String value) { clientId = value; }
 
-    public String getClientSecret() {
-        return clientSecret;
-    }
+    /**
+     * Gets the Amazon client secret.
+     * @return The Amazon client secret.
+     */
+    public String getClientSecret() { return clientSecret; }
 
-    public void setClientSecret(String clientSecret) {
-        this.clientSecret = clientSecret;
-    }
+    /**
+     * Sets the Amazon client secret.
+     * @param value The Amazon client secret to set.
+     */
+    public void setClientSecret(String value) { clientSecret = value; }
 
     @Override
     public List<SimpleEntry<String, String>> getProperties() {
         ArrayList<SimpleEntry<String, String>> result = new ArrayList<>();
-        result.add(new SimpleEntry<>("ClientId", getClientId()));
-        result.add(new SimpleEntry<>("ClientSecret", getClientSecret()));
+        result.add(new SimpleEntry<>("ClientId", clientId));
+        result.add(new SimpleEntry<>("ClientSecret", clientSecret));
         return result;
     }
 

NotificationHubs/src/com/windowsazure/messaging/AdmInstallation.java

@@ -0,0 +1,45 @@
+package com.windowsazure.messaging;
+
+/**
+ * This class represents an Amazon Device
+ */
+public class AdmInstallation extends Installation {
+
+    /**
+     * Creates a new instance of the AdmInstallation class.
+     *
+     * @param installationId The ID for the installation.
+     */
+    public AdmInstallation(String installationId) {
+        super(installationId, NotificationPlatform.Adm, null, null);
+    }
+
+    /**
+     * Creates a new instance of the AdmInstallation class.
+     *
+     * @param installationId The ID for the installation.
+     * @param tags           The tags for the installation.
+     */
+    public AdmInstallation(String installationId, String... tags) {
+        super(installationId, NotificationPlatform.Adm, null, tags);
+    }
+
+    /**
+     * Creates a new instance of the AdmInstallation class.
+     *
+     * @param installationId The ID for the installation.
+     */
+    public AdmInstallation(String installationId, String pushChannel) {
+        super(installationId, NotificationPlatform.Adm, pushChannel, (String[]) null);
+    }
+
+    /**
+     * Creates a new instance of the AdmInstallation class.
+     * @param installationId The ID for the installation.
+     * @param pushChannel The device specific push channel for the installation.
+     * @param tags The tags for the installation.
+     */
+    public AdmInstallation(String installationId, String pushChannel, String... tags) {
+        super(installationId, NotificationPlatform.Adm, pushChannel, tags);
+    }
+}

NotificationHubs/src/com/windowsazure/messaging/AdmNotification.java

@@ -0,0 +1,20 @@
+package com.windowsazure.messaging;
+
+import org.apache.http.entity.ContentType;
+
+/**
+ * This class represents a notification to the Amazon PNS.
+ */
+public class AdmNotification extends Notification {
+
+    /**
+     * Creates a new instance of the AdmNotification class.
+     * @param body The JSON body for the Amazon PNS.
+     */
+    public AdmNotification(String body) {
+        this.body = body;
+        this.contentType = ContentType.APPLICATION_JSON;
+
+        this.headers.put("ServiceBusNotification-Format", "adm");
+    }
+}

NotificationHubs/src/com/windowsazure/messaging/AdmRegistration.java

@@ -4,66 +4,79 @@
 
 package com.windowsazure.messaging;
 
+import java.util.Objects;
+
+/**
+ * This class represents an Amazon device registration.
+ */
 public class AdmRegistration extends Registration {
     private static final String ADM_NATIVE_REGISTRATION1 = "<?xml version=\"1.0\" encoding=\"utf-8\"?><entry xmlns=\"http://www.w3.org/2005/Atom\"><content type=\"application/xml\"><AdmRegistrationDescription xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.microsoft.com/netservices/2010/10/servicebus/connect\">";
     private static final String ADM_NATIVE_REGISTRATION2 = "<AdmRegistrationId>";
     private static final String ADM_NATIVE_REGISTRATION3 = "</AdmRegistrationId></AdmRegistrationDescription></content></entry>";
 
     protected String admRegistrationId;
 
+    /**
+     * Creates a new instance of the AdmRegistration class.
+     */
     public AdmRegistration() {
         super();
     }
 
+    /**
+     * Creates a new instance of the AdmRegistration class.
+     * @param registrationId The Azure Notification Hubs registration ID for the device.
+     * @param admRegistrationId The Amazon device registration ID.
+     */
     public AdmRegistration(String registrationId, String admRegistrationId) {
         super(registrationId);
         this.admRegistrationId = admRegistrationId;
     }
 
+    /**
+     * Creates a new instance of the AdmRegistration class.
+     * @param admRegistrationId The Amazon device registration ID.
+     */
     public AdmRegistration(String admRegistrationId) {
         super();
         this.admRegistrationId = admRegistrationId;
     }
 
+    /**
+     * Gets the Amazon registration ID for the device.
+     * @return The Amazon registration ID for the device.
+     */
     public String getAdmRegistrationId() {
         return admRegistrationId;
     }
 
-    public void setAdmRegistrationId(String admRegistrationId) {
-        this.admRegistrationId = admRegistrationId;
+    /**
+     * Sets the Amazon registration ID for the device.
+     * @param value The Amazon registration ID for the device to set.
+     */
+    public void setAdmRegistrationId(String value) {
+        admRegistrationId = value;
     }
 
+    /**
+     * Gets the PNS handle for getting devices by channel.
+     * @return The PNS handle for getting devices by channel.
+     */
     @Override
-    public String getPnsHandle() {
-        return admRegistrationId;
-    }
+    public String getPnsHandle() { return admRegistrationId; }
 
     @Override
-    public int hashCode() {
-        final int prime = 31;
-        int result = super.hashCode();
-        result = prime
-            * result
-            + ((admRegistrationId == null) ? 0 : admRegistrationId
-            .hashCode());
-        return result;
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        if (!super.equals(o)) return false;
+        AdmRegistration that = (AdmRegistration) o;
+        return Objects.equals(getAdmRegistrationId(), that.getAdmRegistrationId());
     }
 
     @Override
-    public boolean equals(Object obj) {
-        if (this == obj)
-            return true;
-        if (!super.equals(obj))
-            return false;
-        if (getClass() != obj.getClass())
-            return false;
-        AdmRegistration other = (AdmRegistration) obj;
-        if (admRegistrationId == null) {
-            if (other.admRegistrationId != null)
-                return false;
-        } else if (!admRegistrationId.equals(other.admRegistrationId))
-            return false;
-        return true;
+    public int hashCode() {
+        return Objects.hash(super.hashCode(), getAdmRegistrationId());
     }
 
     @Override

NotificationHubs/src/com/windowsazure/messaging/AdmTemplateRegistration.java

@@ -4,36 +4,62 @@
 
 package com.windowsazure.messaging;
 
-public class AdmTemplateRegistration extends AdmRegistration {
+/**
+ * This class represents an Amazon device template registration.
+ */
+public class AdmTemplateRegistration extends AdmRegistration implements TemplateRegistration {
     private static final String ADM_TEMPLATE_REGISTRATION1 = "<?xml version=\"1.0\" encoding=\"utf-8\"?><entry xmlns=\"http://www.w3.org/2005/Atom\"><content type=\"application/xml\"><AdmTemplateRegistrationDescription xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.microsoft.com/netservices/2010/10/servicebus/connect\">";
     private static final String ADM_TEMPLATE_REGISTRATION2 = "<AdmRegistrationId>";
     private static final String ADM_TEMPLATE_REGISTRATION3 = "</AdmRegistrationId><BodyTemplate><![CDATA[";
     private static final String ADM_TEMPLATE_REGISTRATION4 = "]]></BodyTemplate></AdmTemplateRegistrationDescription></content></entry>";
 
     private String bodyTemplate;
 
+    /**
+     * Creates a new instance of the AdmTemplateRegistration class.
+     */
     public AdmTemplateRegistration() {
         super();
     }
 
-    public AdmTemplateRegistration(String registrationId,
-                                   String admRegistrationId, String bodyTemplate) {
+    /**
+     * Creates a new instance of the AdmTemplateRegistration class.
+     * @param registrationId The Azure Notification Hubs registration ID.
+     * @param admRegistrationId The Amazon device registration ID.
+     * @param bodyTemplate The template body.
+     */
+    public AdmTemplateRegistration(
+        String registrationId,
+        String admRegistrationId,
+        String bodyTemplate
+    ) {
         super(registrationId, admRegistrationId);
         this.bodyTemplate = bodyTemplate;
     }
 
+    /**
+     * Creates a new instance of the AdmTemplateRegistration class.
+     * @param admRegistrationId The Amazon device registration ID.
+     * @param bodyTemplate The template body.
+     */
     public AdmTemplateRegistration(String admRegistrationId, String bodyTemplate) {
         super(admRegistrationId);
         this.bodyTemplate = bodyTemplate;
     }
 
-    public String getBodyTemplate() {
-        return bodyTemplate;
-    }
+    /**
+     * Gets the registration template body.
+     * @return The registration template body.
+     */
+    @Override
+    public String getBodyTemplate() { return bodyTemplate; }
 
-    public void setBodyTemplate(String bodyTemplate) {
-        this.bodyTemplate = bodyTemplate;
-    }
+    /**
+     * Sets the registration template body.
+     * @param value The registration template body to set.
+     */
+    @Override
+    public void setBodyTemplate(String value) { this.bodyTemplate = value; }
 
     @Override
     public int hashCode() {
@@ -66,7 +92,7 @@ public String getXml() {
         return ADM_TEMPLATE_REGISTRATION1 +
             getTagsXml() +
             ADM_TEMPLATE_REGISTRATION2 +
-            admRegistrationId +
+            getAdmRegistrationId() +
             ADM_TEMPLATE_REGISTRATION3 +
             bodyTemplate +
             ADM_TEMPLATE_REGISTRATION4;