Added the capability to build the payload externally: Message.Builder for GCM and PayloadBuilder for APNS.

Author: rion18

CHANGELOG.MD

@@ -17,3 +17,8 @@ First release of the GCM Push Client.
 
 + Fixed Java8 required binary.
 
+## [1.0.3](https://github.com/devsu/push-sender/releases/tag/1.0.3) (2016-08-24)
+
++ PayloadBuilder can now be built externally.
++ Added validity checks where they were missing.
+

README.MD

@@ -1,6 +1,6 @@
 # Push Sender #
 
-Push Sender is a Java library that allows sending push messages easily, based on the awesome libraries [gcm-server](https://github.com/theganyo/gcm-server) by [theganyo](https://github.com/theganyo) and [java-apns](https://github.com/notnoop/java-apns) by [notnoop](https://github.com/notnoop). Send push messages with one line of code, forget about the rest, and focus on making your application's business logic!
+Push Sender is a Java library that allows sending push messages easily, based on the awesome libraries [gcm-server](https://github.com/theganyo/gcm-server) by [theganyo](https://github.com/theganyo) and [java-apns](https://github.com/notnoop/java-apns) by [notnoop](https://github.com/notnoop). Be sure to check them out! Send push messages with one line of code, forget about the rest, and focus on making your application's business logic!
 
 ## Overview ###
 
@@ -10,7 +10,7 @@ Using Push Sender is very simple. You can import Push Sender on your POM file us
 	<dependency>
 		<groupId>com.devsu</groupId>
 		<artifactId>push-sender</artifactId>
-		<version>1.0.2</version>
+		<version>1.0.3</version>
 	</dependency>
 ```
 

open_source_licenses.txt

@@ -1,4 +1,4 @@
-## theganyo/gcm-server
+## notnoop/java-apns
 
 Copyright 2009, Mahmood Ali.
 All rights reserved.

pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>com.devsu</groupId>
 	<artifactId>push-sender</artifactId>
-	<version>1.0.2</version>
+	<version>1.0.3</version>
 	<packaging>jar</packaging>
 	<name>Push Sender</name>
 	<description>Push Sender is a library that allows you to quickly send push messages via APNS or GCM, on your Java powered servers.</description>

src/main/java/com/devsu/push/sender/service/async/AsyncAndroidPushService.java

@@ -1,13 +1,19 @@
 package com.devsu.push.sender.service.async;
 
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+
 import com.devsu.push.sender.callback.PushCallback;
 import com.devsu.push.sender.service.sync.SyncAndroidPushService;
+import com.google.android.gcm.server.Message;
 
 /**
  * The async push service for Android (GCM).
  */
 public class AsyncAndroidPushService extends AsyncPushServiceBase {
 
+	private static final String BUILDER_OBJECT = Message.Builder.class.getSimpleName();
+	
 	/**
 	 * @see com.devsu.push.sender.service.sync.SyncAndroidPushService#AndroidPushService(String)
 	 */
@@ -24,6 +30,62 @@ public AsyncAndroidPushService(String gcmApiKey, PushCallback pushCallback) {
 		super(new SyncAndroidPushService(gcmApiKey), pushCallback);
 	}
 
+	/**
+	 * Sends a single push message.
+	 * @param msgBuilder The Message.Builder object.
+	 * @param token The push token.
+	 * @return <i>true</i> if the push message request was sent. 
+	 * @throws Exception
+	 */
+	public void sendPush(final Message.Builder msgBuilder, final String token) {
+		ExecutorService executorService = Executors.newSingleThreadExecutor();
+		executorService.execute(new Runnable() {
+		    @Override
+			public void run() {
+		    	try {
+		    		SyncAndroidPushService service = (SyncAndroidPushService) pushService;
+					boolean result = service.sendPush(msgBuilder, token);
+					if (pushCallback != null) {
+						pushCallback.onSingleSuccess(result, BUILDER_OBJECT, msgBuilder.build().toString(), null, token);
+					}
+		    	} catch (Exception e) {
+		    		if (pushCallback != null) {
+		    			pushCallback.onError(e);
+		    		}
+		    	}
+		    }
+		});
+		executorService.shutdown();
+	}
+	
+	/**
+	 * Sends a bulk push message.
+	 * @param msgBuilder The Message.Builder object.
+	 * @param token The push token.
+	 * @return <i>true</i> if the push message request was sent. 
+	 * @throws Exception
+	 */
+	public void sendPushInBulk(final Message.Builder msgBuilder, final String... tokens) {
+		ExecutorService executorService = Executors.newSingleThreadExecutor();
+		executorService.execute(new Runnable() {
+		    @Override
+			public void run() {
+		    	try {
+		    		SyncAndroidPushService service = (SyncAndroidPushService) pushService;
+					boolean result = service.sendPushInBulk(msgBuilder, tokens);
+					if (pushCallback != null) {
+						pushCallback.onBulkSuccess(result, BUILDER_OBJECT, msgBuilder.build().toString(), null, tokens);
+					}
+		    	} catch (Exception e) {
+		    		if (pushCallback != null) {
+		    			pushCallback.onError(e);
+		    		}
+		    	}
+		    }
+		});
+		executorService.shutdown();
+	}
+	
 	/**
 	 * @see com.devsu.push.sender.service.sync.SyncAndroidPushService#setMaxRetries(int)
 	 */

src/main/java/com/devsu/push/sender/service/async/AsyncApplePushService.java

@@ -1,7 +1,13 @@
 package com.devsu.push.sender.service.async;
 
+import java.util.Date;
+import java.util.Map;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+
 import com.devsu.push.sender.callback.PushCallback;
 import com.devsu.push.sender.service.sync.SyncApplePushService;
+import com.notnoop.apns.PayloadBuilder;
 import com.notnoop.exceptions.InvalidSSLConfig;
 import com.notnoop.exceptions.RuntimeIOException;
 
@@ -10,6 +16,8 @@
  */
 public class AsyncApplePushService extends AsyncPushServiceBase {
 
+	private static final String BUILDER_OBJECT = PayloadBuilder.class.getSimpleName();
+
 	/**
 	 * @see com.devsu.push.sender.service.sync.SyncApplePushService#ApplePushService(String, String, boolean)
 	 */
@@ -32,6 +40,62 @@ public AsyncApplePushService(String certificatePath, String certificatePassword,
 		super(new SyncApplePushService(certificatePath, certificatePassword, useProductionServer), pushCallback);
 	}
 
+	/**
+	 * Sends a single push message.
+	 * @param msgBuilder The PayloadBuilder object.
+	 * @param token The push token.
+	 * @return <i>true</i> if the push message request was sent. 
+	 * @throws Exception
+	 */
+	public void sendPush(final PayloadBuilder msgBuilder, final String token) {
+		ExecutorService executorService = Executors.newSingleThreadExecutor();
+		executorService.execute(new Runnable() {
+		    @Override
+			public void run() {
+		    	try {
+		    		SyncApplePushService service = (SyncApplePushService) pushService;
+					boolean result = service.sendPush(msgBuilder, token);
+					if (pushCallback != null) {
+						pushCallback.onSingleSuccess(result, BUILDER_OBJECT, msgBuilder.toString(), null, token);
+					}
+		    	} catch (Exception e) {
+		    		if (pushCallback != null) {
+		    			pushCallback.onError(e);
+		    		}
+		    	}
+		    }
+		});
+		executorService.shutdown();
+	}
+	
+	/**
+	 * Sends a bulk push message.
+	 * @param msgBuilder The Message.Builder object.
+	 * @param token The push token.
+	 * @return <i>true</i> if the push message request was sent. 
+	 * @throws Exception
+	 */
+	public void sendPushInBulk(final PayloadBuilder msgBuilder, final String... tokens) {
+		ExecutorService executorService = Executors.newSingleThreadExecutor();
+		executorService.execute(new Runnable() {
+		    @Override
+			public void run() {
+		    	try {
+		    		SyncApplePushService service = (SyncApplePushService) pushService;
+					boolean result = service.sendPushInBulk(msgBuilder, tokens);
+					if (pushCallback != null) {
+						pushCallback.onBulkSuccess(result, BUILDER_OBJECT, msgBuilder.build().toString(), null, tokens);
+					}
+		    	} catch (Exception e) {
+		    		if (pushCallback != null) {
+		    			pushCallback.onError(e);
+		    		}
+		    	}
+		    }
+		});
+		executorService.shutdown();
+	}
+	
 	/**
 	 * @see com.devsu.push.sender.service.sync.SyncApplePushService#setupDevelopmentServer(java.lang.String, java.lang.String)
 	 */
@@ -52,4 +116,8 @@ public void setupProductionServer(String certificatePath, String certificatePass
 	public void setPushEnabled(boolean pushEnabled) {
 		((SyncApplePushService)pushService).setPushEnabled(pushEnabled);
 	}
+	
+	public Map<String, Date> getInactiveDevices() {
+		return ((SyncApplePushService)pushService).getInactiveDevices();
+	}
 }

src/main/java/com/devsu/push/sender/service/async/AsyncPushServiceBase.java

@@ -10,7 +10,7 @@
 /**
  * Abstract base class for every async push service.
  */
-public abstract class AsyncPushServiceBase implements AsyncPushService  {
+public abstract class AsyncPushServiceBase implements AsyncPushService {
 
 	/**
 	 * The push service that will be used in this async service.
@@ -33,23 +33,23 @@ protected AsyncPushServiceBase(SyncPushService pushService, PushCallback pushCal
 	}
 
 	/* 
-	 * @see com.rion18.pusher.service.async.AsyncPushService#sendPush(java.lang.String, java.lang.String)
+	 * @see com.rion18.push.sender.service.async.AsyncPushService#sendPush(java.lang.String, java.lang.String)
 	 */
 	@Override
 	public void sendPush(String message, String token) {
 		sendPush(null, message, null, token);
 	}
 
 	/* 
-	 * @see com.rion18.pusher.service.async.AsyncPushService#sendPush(java.lang.String, java.lang.String, java.lang.String)
+	 * @see com.rion18.push.sender.service.async.AsyncPushService#sendPush(java.lang.String, java.lang.String, java.lang.String)
 	 */
 	@Override
 	public void sendPush(String title, String message, String token) {
 		sendPush(title, message, null, token);
 	}
 
 	/*
-	 * @see com.rion18.pusher.service.async.AsyncPushService#sendPush(java.lang.String, java.lang.String, java.util.Map, java.lang.String)
+	 * @see com.rion18.push.sender.service.async.AsyncPushService#sendPush(java.lang.String, java.lang.String, java.util.Map, java.lang.String)
 	 */
 	@Override
 	public void sendPush(final String title, final String message, 
@@ -74,23 +74,23 @@ public void run() {
 	}
 
 	/* 
-	 * @see com.rion18.pusher.service.async.AsyncPushService#sendPushInBulk(java.lang.String, java.lang.String[])
+	 * @see com.rion18.push.sender.service.async.AsyncPushService#sendPushInBulk(java.lang.String, java.lang.String[])
 	 */
 	@Override
 	public void sendPushInBulk(String message, String... tokens) {
 		sendPushInBulk(null, message, null, tokens);
 	}
 
 	/*
-	 * @see com.rion18.pusher.service.async.AsyncPushService#sendPushInBulk(java.lang.String, java.lang.String, java.lang.String[])
+	 * @see com.rion18.push.sender.service.async.AsyncPushService#sendPushInBulk(java.lang.String, java.lang.String, java.lang.String[])
 	 */
 	@Override
 	public void sendPushInBulk(String title, String message, String... tokens) {
 		sendPushInBulk(title, message, null, tokens);
 	}
 
 	/*
-	 * @see com.rion18.pusher.service.async.AsyncPushService#sendPushInBulk(java.lang.String, java.lang.String, java.util.Map, java.lang.String[])
+	 * @see com.rion18.push.sender.service.async.AsyncPushService#sendPushInBulk(java.lang.String, java.lang.String, java.util.Map, java.lang.String[])
 	 */
 	@Override
 	public void sendPushInBulk(final String title, final String message, 
@@ -115,7 +115,7 @@ public void run() {
 	}
 
 	/*
-	 * @see com.rion18.pusher.service.async.AsyncPushService#setPushCallback(com.rion18.pusher.callback.PushCallback)
+	 * @see com.rion18.push.sender.service.async.AsyncPushService#setPushCallback(com.rion18.push.sender.callback.PushCallback)
 	 */
 	@Override
 	public void setPushCallback(PushCallback pushCallback) {

src/main/java/com/devsu/push/sender/service/sync/SyncAndroidPushService.java

@@ -79,11 +79,11 @@ private void setDefaultValues() {
 	}
 
 	/*
-	 * @see com.rion18.pusher.service.sync.PushService#sendPush(java.lang.String, java.lang.String, java.util.Map, java.lang.String)
+	 * @see com.devsu.push.sender.service.sync.SyncPushService#sendPush(java.lang.String, java.lang.String, java.util.Map, java.lang.String)
 	 */
 	@Override
-	public boolean sendPush(final String title, final String message, 
-			final Map<String, String> additionalFields, final String token) throws IOException {
+	public boolean sendPush(final String title, final String message, final Map<String, String> additionalFields, 
+			final String token) throws IOException {
 		if (!validateSingleData(log, message, token)) {
 			return false;
 		}
@@ -92,8 +92,23 @@ public boolean sendPush(final String title, final String message,
 		return resultIsOk(result);
 	}
 
+	/**
+	 * Sends a single push message.
+	 * @param msgBuilder The Message.Builder object.
+	 * @param token The push token.
+	 * @return <i>true</i> if the push message request was sent. 
+	 * @throws Exception
+	 */
+	public boolean sendPush(Message.Builder msgBuilder, String token) throws Exception {
+		if (!validateToken(log, token)) {
+			return false;
+		}
+		Result result = senderService.send(msgBuilder.build(), token, maxRetries);
+		return resultIsOk(result);
+	}
+	
 	/*
-	 * @see com.rion18.pusher.service.sync.PushService#sendPushInBulk(java.lang.String, java.lang.String, java.util.Map, java.lang.String[])
+	 * @see com.devsu.push.sender.service.sync.SyncPushService#sendPushInBulk(java.lang.String, java.lang.String, java.util.Map, java.lang.String[])
 	 */
 	@Override
 	public boolean sendPushInBulk(final String title, final String message, 
@@ -111,6 +126,23 @@ public boolean sendPushInBulk(final String title, final String message,
 		return booleanResult;
 	}
 
+	/**
+	 * Sends a bulk push message.
+	 * @param msgBuilder The Message.Builder object.
+	 * @param token The push token.
+	 * @return <i>true</i> if the push message request was sent. 
+	 * @throws Exception
+	 */
+	public boolean sendPushInBulk(Message.Builder msgBuilder, String... tokens) throws Exception {
+		boolean booleanResult = true;
+		List<String[]> tokenLimitedList = ArrayUtil.splitArray(tokens, maxBulkSize);
+		for (String[] tokenArray: tokenLimitedList){
+			MulticastResult result = senderService.send(msgBuilder.build(), Arrays.asList(tokenArray), maxRetries);
+			booleanResult = booleanResult ? resultIsOk(result) : false;
+		}
+		return booleanResult;
+	}
+	
 	/**
 	 * Default message builder generator.
 	 * @param title The push message title.