Make ApnsPayloadBuilder a concrete class

Author: jchambers

README.md

@@ -87,7 +87,7 @@ Pushy's APNs clients maintain an internal pool of connections to the APNs server
 final SimpleApnsPushNotification pushNotification;
 
 {
-    final ApnsPayloadBuilder payloadBuilder = new SimpleApnsPayloadBuilder();
+    final ApnsPayloadBuilder payloadBuilder = new ApnsPayloadBuilder();
     payloadBuilder.setAlertBody("Example!");
 
     final String payload = payloadBuilder.build();
@@ -97,7 +97,7 @@ final SimpleApnsPushNotification pushNotification;
 }
 ```
 
-Pushy includes a [`SimpleApnsPayloadBuilder`](https://pushy-apns.org/apidocs/0.15/com/eatthepath/pushy/apns/util/SimpleApnsPayloadBuilder.html). [APNs payloads are just JSON strings](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification), and callers may produce payloads by the method of their choice; while Pushy's payload builders may be convenient, callers are _not_ obligated to use them.
+Pushy includes an [`ApnsPayloadBuilder`](https://pushy-apns.org/apidocs/0.15/com/eatthepath/pushy/apns/util/ApnsPayloadBuilder.html). [APNs payloads are just JSON strings](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification), and callers may produce payloads by the method of their choice; while Pushy's payload builders may be convenient, callers are _not_ obligated to use them.
 
 The process of sending a push notification is asynchronous; although the process of sending a notification and getting a reply from the server may take some time, the client will return a [`CompletableFuture`](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html) right away. You can use that `CompletableFuture` to track the progress and eventual outcome of the sending operation. Note that sending a notification returns a [`PushNotificationFuture`](https://pushy-apns.org/apidocs/0.15/com/eatthepath/pushy/apns/util/concurrent/PushNotificationFuture.html), which is a subclass of `CompletableFuture` that always holds a reference to the notification that was sent.
 

benchmark/src/main/java/com/eatthepath/pushy/apns/ApnsClientBenchmark.java

@@ -26,7 +26,6 @@
 import com.eatthepath.pushy.apns.server.BenchmarkApnsServer;
 import com.eatthepath.pushy.apns.server.BenchmarkApnsServerBuilder;
 import com.eatthepath.pushy.apns.util.ApnsPayloadBuilder;
-import com.eatthepath.pushy.apns.util.SimpleApnsPayloadBuilder;
 import com.eatthepath.pushy.apns.util.SimpleApnsPushNotification;
 import io.netty.channel.nio.NioEventLoopGroup;
 import io.netty.util.concurrent.Future;
@@ -102,7 +101,7 @@ public void setUp() throws Exception {
 
         this.pushNotifications = new ArrayList<>(this.notificationCount);
         {
-            final ApnsPayloadBuilder payloadBuilder = new SimpleApnsPayloadBuilder();
+            final ApnsPayloadBuilder payloadBuilder = new ApnsPayloadBuilder();
 
             for (int i = 0; i < this.notificationCount; i++) {
                 final String payload =

…l/SimpleApnsPayloadBuilderBenchmark.java …ns/util/ApnsPayloadBuilderBenchmark.javabenchmark/src/main/java/com/eatthepath/pushy/apns/util/SimpleApnsPayloadBuilderBenchmark.java renamed to benchmark/src/main/java/com/eatthepath/pushy/apns/util/ApnsPayloadBuilderBenchmark.java benchmark/src/main/java/com/eatthepath/pushy/apns/util/SimpleApnsPayloadBuilderBenchmark.java renamed to benchmark/src/main/java/com/eatthepath/pushy/apns/util/ApnsPayloadBuilderBenchmark.java

@@ -29,9 +29,9 @@
 import java.util.List;
 
 @State(Scope.Thread)
-public class SimpleApnsPayloadBuilderBenchmark {
+public class ApnsPayloadBuilderBenchmark {
 
-    private SimpleApnsPayloadBuilder payloadBuilder;
+    private ApnsPayloadBuilder payloadBuilder;
 
     @Param({"512", "4096"})
     public int messageBodyLength;
@@ -43,7 +43,7 @@ public class SimpleApnsPayloadBuilderBenchmark {
 
     @Setup
     public void setUp() {
-        this.payloadBuilder = new SimpleApnsPayloadBuilder();
+        this.payloadBuilder = new ApnsPayloadBuilder();
 
         final char[] messageBodyCharacters;
         {

pushy/src/main/java/com/eatthepath/pushy/apns/util/ApnsPayloadBuilder.java

@@ -22,21 +22,28 @@
 
 package com.eatthepath.pushy.apns.util;
 
+import com.eatthepath.json.JsonSerializer;
+
 import java.time.Instant;
 import java.util.*;
+import java.util.function.Function;
 
 /**
  * <p>A base utility class for constructing JSON payloads suitable for inclusion in APNs push notifications. Payload
  * builders are reusable, but are <em>not</em> thread-safe.</p>
  *
+ * <p>{@code ApnsPayloadBuilder} will, by default, use a {@link JsonSerializer} to serialize payloads. Callers may
+ * provide their own serialization functions (see {@link #build(Function)}) in order to serialize payloads with
+ * third-party JSON libraries.</p>
+ *
  * @author <a href="https://github.com/jchambers">Jon Chambers</a>
  *
  * @see <a href="https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification">Generating a Remote Notification</a>
  *
  * @since 0.14.0
  */
 @SuppressWarnings({"UnusedReturnValue", "unused"})
-public abstract class ApnsPayloadBuilder {
+public class ApnsPayloadBuilder {
 
     private String alertBody = null;
 
@@ -886,7 +893,7 @@ public ApnsPayloadBuilder setDismissalDate(final Instant dismissalDate) {
      *
      * @since 0.14.0
      */
-    protected Map<String, Object> buildPayloadMap() {
+    private Map<String, Object> buildPayloadMap() {
         final boolean isLiveActivityPayload = event != null;
 
         final Map<String, Object> payload = new HashMap<>();
@@ -1049,15 +1056,29 @@ protected Map<String, Object> buildPayloadMap() {
     }
 
     /**
-     * Returns a JSON representation of the push notification payload under construction.
+     * Returns a JSON representation of the push notification payload under construction. This method serializes
+     * payloads using a {@link JsonSerializer}. Please see the documentation for {@link JsonSerializer} for details
+     * about how this payload builder serializes custom properties.
      *
      * @return a JSON representation of the payload under construction
      *
-     * @see #buildPayloadMap()
-     *
      * @since 0.14.0
      */
-    public abstract String build();
+    public String build() {
+        return build(JsonSerializer::writeJsonTextAsString);
+    }
+
+    /**
+     * Returns a JSON representation of the push notification payload under construction using the serialization method
+     * of the caller's choice. Callers may use this method to serialize payloads with third-party JSON libraries.
+     *
+     * @return a JSON representation of the payload under construction
+     *
+     * @since 0.16.0
+     */
+    public String build(final Function<Map<String, Object>, String> buildPayloadFunction) {
+        return buildPayloadFunction.apply(this.buildPayloadMap());
+    }
 
     /**
      * Returns a map representing a
@@ -1072,14 +1093,16 @@ protected Map<String, Object> buildPayloadMap() {
      *
      * @since 0.14.0
      */
-    protected Map<String, String> buildMdmPayloadMap(final String pushMagicValue) {
+    private Map<String, String> buildMdmPayloadMap(final String pushMagicValue) {
         return Collections.singletonMap(MDM_KEY, pushMagicValue);
     }
 
     /**
      * Returns a JSON representation of a
      * <a href="https://developer.apple.com/library/content/documentation/Miscellaneous/Reference/MobileDeviceManagementProtocolRef/1-Introduction/Introduction.html#//apple_ref/doc/uid/TP40017387-CH1-SW1">Mobile
-     * Device Management</a> "wake up" payload.
+     * Device Management</a> "wake up" payload. This method serializes payloads using a {@link JsonSerializer}. Please
+     * see the documentation for {@link JsonSerializer} for details about how this payload builder serializes custom
+     * properties.
      *
      * @param pushMagicValue the "push magic" string that the device sends to the MDM server in a {@code TokenUpdate}
      * message
@@ -1090,8 +1113,28 @@ protected Map<String, String> buildMdmPayloadMap(final String pushMagicValue) {
      * Device Management (MDM) Protocol</a>
      *
      * @since 0.14.0
+     */
+    public String buildMdmPayload(final String pushMagicValue) {
+        return buildMdmPayload(pushMagicValue, JsonSerializer::writeJsonTextAsString);
+    }
+
+    /**
+     * Returns a JSON representation of a
+     * <a href="https://developer.apple.com/library/content/documentation/Miscellaneous/Reference/MobileDeviceManagementProtocolRef/1-Introduction/Introduction.html#//apple_ref/doc/uid/TP40017387-CH1-SW1">Mobile
+     * Device Management</a> "wake up" payload. This method uses the serialization method of the caller's choice.
+     * Callers may use this method to serialize payloads with third-party JSON libraries.
+     *
+     * @param pushMagicValue the "push magic" string that the device sends to the MDM server in a {@code TokenUpdate}
+     * message
      *
-     * @see #buildMdmPayloadMap(String)
+     * @return a JSON representation of an MDM "wake up" notification payload
+     *
+     * @see <a href="https://developer.apple.com/library/content/documentation/Miscellaneous/Reference/MobileDeviceManagementProtocolRef/3-MDM_Protocol/MDM_Protocol.html#//apple_ref/doc/uid/TP40017387-CH3-SW2">Mobile
+     * Device Management (MDM) Protocol</a>
+     *
+     * @since 0.16.0
      */
-    public abstract String buildMdmPayload(final String pushMagicValue);
+    public String buildMdmPayload(final String pushMagicValue, final Function<Map<String, String>, String> buildPayloadFunction) {
+        return buildPayloadFunction.apply(buildMdmPayloadMap(pushMagicValue));
+    }
 }

pushy/src/main/java/com/eatthepath/pushy/apns/util/SimpleApnsPayloadBuilder.java

@@ -27,7 +27,6 @@
 import com.eatthepath.pushy.apns.auth.KeyPairUtil;
 import com.eatthepath.pushy.apns.server.*;
 import com.eatthepath.pushy.apns.util.ApnsPayloadBuilder;
-import com.eatthepath.pushy.apns.util.SimpleApnsPayloadBuilder;
 import io.netty.channel.nio.NioEventLoopGroup;
 import io.netty.util.concurrent.*;
 import org.junit.jupiter.api.AfterAll;
@@ -174,7 +173,7 @@ protected static String generateRandomDeviceToken() {
     }
 
     protected static String generateRandomPayload() {
-        final ApnsPayloadBuilder payloadBuilder = new SimpleApnsPayloadBuilder();
+        final ApnsPayloadBuilder payloadBuilder = new ApnsPayloadBuilder();
         payloadBuilder.setAlertBody(UUID.randomUUID().toString());
 
         return payloadBuilder.build();

pushy/src/test/java/com/eatthepath/pushy/apns/AbstractClientServerTest.java

@@ -25,7 +25,6 @@
 import com.eatthepath.pushy.apns.auth.ApnsSigningKey;
 import com.eatthepath.pushy.apns.proxy.Socks5ProxyHandlerFactory;
 import com.eatthepath.pushy.apns.util.ApnsPayloadBuilder;
-import com.eatthepath.pushy.apns.util.SimpleApnsPayloadBuilder;
 import com.eatthepath.pushy.apns.util.SimpleApnsPushNotification;
 import com.eatthepath.pushy.apns.util.TokenUtil;
 import com.eatthepath.pushy.apns.util.concurrent.PushNotificationFuture;
@@ -77,7 +76,7 @@ public static void main(final String[] args) throws Exception {
         final SimpleApnsPushNotification pushNotification;
 
         {
-            final ApnsPayloadBuilder payloadBuilder = new SimpleApnsPayloadBuilder();
+            final ApnsPayloadBuilder payloadBuilder = new ApnsPayloadBuilder();
             payloadBuilder.setAlertBody("Example!");
 
             final String payload = payloadBuilder.build();

pushy/src/test/java/com/eatthepath/pushy/apns/ExampleApp.java

@@ -41,15 +41,13 @@
 import static org.junit.jupiter.api.Assertions.*;
 import static org.junit.jupiter.params.provider.Arguments.arguments;
 
-public abstract class ApnsPayloadBuilderTest {
+class ApnsPayloadBuilderTest {
 
     private ApnsPayloadBuilder builder;
 
-    protected abstract ApnsPayloadBuilder getBuilder();
-
     @BeforeEach
     public void setUp() {
-        this.builder = getBuilder();
+        this.builder = new ApnsPayloadBuilder();
     }
 
     @Test