Added Priority support to the PushPayload, and delegate through to th…

…e GCM implementation Bumped version to v3.0
appfoundry · Jan 25, 2016 · 863366d · 863366d
1 parent a7240d3
commit 863366d
Show file tree

Hide file tree

Showing 9 changed files with 1,026 additions and 9 deletions.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>be.appfoundry.promtius</groupId>
     <artifactId>promtius-parent</artifactId>
-    <version>2.2</version>
+    <version>3.0</version>
     <packaging>pom</packaging>
 
     <properties>

diff --git a/promtius-api/pom.xml b/promtius-api/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>be.appfoundry.promtius</groupId>
         <artifactId>promtius-parent</artifactId>
-        <version>2.2</version>
+        <version>3.0</version>
     </parent>
 
     <artifactId>promtius-api</artifactId>

diff --git a/promtius-api/src/main/java/be/appfoundry/promtius/PushPayload.java b/promtius-api/src/main/java/be/appfoundry/promtius/PushPayload.java
@@ -12,18 +12,22 @@ public class PushPayload {
 
     public static final String DEFAULT_SOUND_VALUE = "default";
     public static final String DEFAULT_DISCRIMINATOR_VALUE = "discriminator";
+    public static final PushPriority DEFAULT_PUSHPRIORITY_VALUE = PushPriority.NORMAL;
     private String message;
     private String sound;
     private String discriminator;
     private Optional<Map<String, ?>> customFields;
     private Optional<Integer> timeToLive;
+    private PushPriority pushPriority;
 
     /**
-     * @deprecated use the {@link be.appfoundry.promtius.PushPayload.Builder} to create new instances instead!
+     * Push priority.
+     * GCM documentation => https://developers.google.com/cloud-messaging/http-server-ref
+     * APNS documentation => https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Appendixes/BinaryProviderAPI.html#//apple_ref/doc/uid/TP40008194-CH106-SW5
      */
-    @Deprecated
-    public PushPayload(final String message) {
-        this.message = message;
+    public enum PushPriority {
+        NORMAL,
+        HIGH
     }
 
     private PushPayload() {
@@ -64,12 +68,20 @@ public String getDiscriminator() {
         return discriminator;
     }
 
+    /**
+     * The priority to be used for this message by the providers.
+     */
+    public PushPriority getPushPriority() {
+        return pushPriority;
+    }
+
     public static class Builder {
         private String message;
         private Optional<String> sound = Optional.absent();
         private Optional<Integer> timeToLive = Optional.absent();
         private Optional<Map<String, ?>> customFields = Optional.absent();
         private Optional<String> discriminator = Optional.absent();
+        private Optional<PushPriority> pushPriority = Optional.absent();
 
         public Builder withMessage(final String message) {
             this.message = message;
@@ -97,6 +109,11 @@ public Builder withDiscriminator(final String discriminator) {
             return this;
         }
 
+        public Builder withPushPriority(final PushPriority pushPriority) {
+            this.pushPriority = Optional.of(pushPriority);
+            return this;
+        }
+
         public PushPayload build() {
             Preconditions.checkState(message != null);
             PushPayload pushPayload = new PushPayload();
@@ -105,6 +122,7 @@ public PushPayload build() {
             pushPayload.timeToLive = this.timeToLive;
             pushPayload.customFields = this.customFields;
             pushPayload.discriminator = this.discriminator.or(DEFAULT_DISCRIMINATOR_VALUE);
+            pushPayload.pushPriority = this.pushPriority.or(DEFAULT_PUSHPRIORITY_VALUE);
             return pushPayload;
         }
     }

diff --git a/promtius-api/src/test/java/be/appfoundry/promtius/PushPayloadTest.java b/promtius-api/src/test/java/be/appfoundry/promtius/PushPayloadTest.java
@@ -81,4 +81,15 @@ public void testCanBuildWithDiscriminator() throws Exception {
     public void testCanBuildWithoutDiscriminator() throws Exception {
         assertThat(payload.getDiscriminator(), is(equalTo(PushPayload.DEFAULT_DISCRIMINATOR_VALUE)));
     }
+
+    @Test
+    public void testCanBuildWithPushPriority() throws Exception {
+        payload = validBuilder.withPushPriority(PushPayload.PushPriority.HIGH).build();
+        assertThat(payload.getPushPriority(), is(PushPayload.PushPriority.HIGH));
+    }
+
+    @Test
+    public void testCanBuildWithoutPushPriority() throws Exception {
+        assertThat(payload.getPushPriority(), is(PushPayload.PushPriority.NORMAL));
+    }
 }
diff --git a/promtius-apns/pom.xml b/promtius-apns/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>be.appfoundry.promtius</groupId>
         <artifactId>promtius-parent</artifactId>
-        <version>2.2</version>
+        <version>3.0</version>
     </parent>
 
     <artifactId>promtius-apns</artifactId>

diff --git a/promtius-gcm/pom.xml b/promtius-gcm/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>be.appfoundry.promtius</groupId>
         <artifactId>promtius-parent</artifactId>
-        <version>2.2</version>
+        <version>3.0</version>
     </parent>
 
     <artifactId>promtius-gcm</artifactId>

diff --git a/promtius-gcm/src/main/java/be/appfoundry/promtius/google/GoogleCloudMessagingPusher.java b/promtius-gcm/src/main/java/be/appfoundry/promtius/google/GoogleCloudMessagingPusher.java
@@ -2,12 +2,14 @@
 
 import be.appfoundry.custom.google.android.gcm.server.Constants;
 import be.appfoundry.custom.google.android.gcm.server.Message;
+import be.appfoundry.custom.google.android.gcm.server.Message.Priority;
 import be.appfoundry.custom.google.android.gcm.server.MulticastResult;
 import be.appfoundry.custom.google.android.gcm.server.Result;
 import be.appfoundry.promtius.ClientToken;
 import be.appfoundry.promtius.ClientTokenFactory;
 import be.appfoundry.promtius.ClientTokenService;
 import be.appfoundry.promtius.PushPayload;
+import be.appfoundry.promtius.PushPayload.PushPriority;
 import be.appfoundry.promtius.Pusher;
 import be.appfoundry.promtius.exception.PushFailedException;
 import com.google.common.collect.ImmutableList;
@@ -62,7 +64,8 @@ public void sendPush(final PushPayload payload, final Collection<G> groups) {
     }
 
     private void pushPayloadToClientsIdentifiedByTokens(final PushPayload payload, final List<CT> tokens) {
-        Message.Builder builder = new Message.Builder().addData("message", payload.getMessage()).addData("sound", payload.getSound()).collapseKey(payload.getDiscriminator());
+        final Priority gcmPriority = (payload.getPushPriority().equals(PushPriority.NORMAL)) ? Priority.NORMAL : Priority.HIGH;
+        Message.Builder builder = new Message.Builder().addData("message", payload.getMessage()).addData("sound", payload.getSound()).collapseKey(payload.getDiscriminator()).priority(gcmPriority);
         if (payload.getCustomFields().isPresent()) {
             Map<String, ?> customFields = payload.getCustomFields().get();
             builder.addData("data", customFields);