Added support for MultiBroadcastTag and MultiArchiveTag (#226)

* Added multiArchiveTag

* Added multiBroadcastTag

* Updated docs

* Removed getMulti*Tag from responses

* Revert "Removed getMulti*Tag from responses"

This reverts commit 6e7f123.

* Docs edits re multiArchive/BroadcastTag.

Co-authored-by: Jeff Swartz <jeff.swartz@vonage.com>

Author: SMadani

build.gradle

@@ -25,7 +25,7 @@ dependencies {
     implementation 'commons-lang:commons-lang:2.6'
     implementation 'commons-validator:commons-validator:1.7'
     implementation 'org.asynchttpclient:async-http-client:2.12.3'
-    implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.2.2'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.3'
     implementation 'commons-codec:commons-codec:1.15'
     implementation 'org.bitbucket.b_c:jose4j:0.7.12'
 }
@@ -150,8 +150,8 @@ publishing {
 }
 
 signing {
-    def signingKey = System.getenv("signingKey")
-    def signingPassword = System.getenv("signingPassword")
+    def signingKey = findProperty("signingKey")
+    def signingPassword = findProperty("signingPassword")
     useInMemoryPgpKeys(signingKey, signingPassword)
     sign publishing.publications.mavenJava
 }

src/main/java/com/opentok/Archive.java

@@ -63,8 +63,9 @@ public enum Status {
          */
         EXPIRED;
 
-        @JsonValue public String toString() {
-            return super.toString().toLowerCase();
+        @JsonValue
+        public String toString() {
+            return name().toLowerCase();
         }
     }
 
@@ -105,7 +106,10 @@ public enum StreamMode {
          */
         MANUAL;
 
-        @JsonValue public String toString() { return super.toString().toLowerCase(); }
+        @JsonValue
+        public String toString() {
+            return name().toLowerCase();
+        }
     }
 
     @JsonProperty private long createdAt;
@@ -124,6 +128,7 @@ public enum StreamMode {
     @JsonProperty private StreamMode streamMode = StreamMode.AUTO;
     @JsonProperty private String password;
     @JsonProperty private String resolution;
+    @JsonProperty private String multiArchiveTag;
 
     protected Archive() {
     }
@@ -252,6 +257,13 @@ public String getPassword() {
         return password;
     }
 
+    /**
+     * Returns the multiArchiveTag if set for the Archive.
+     */
+    public String getMultiArchiveTag() {
+        return multiArchiveTag;
+    }
+
     @Override
     public String toString() {
         try {

src/main/java/com/opentok/ArchiveMode.java

@@ -17,22 +17,16 @@ public enum ArchiveMode {
      * The session is not archived automatically. To archive the session, you can call the
      * OpenTok.StartArchive() method.
      */
-    MANUAL ("manual"),
+    MANUAL,
 
     /**
      * The session is archived automatically (as soon as there are clients connected
      * to the session).
      */
-    ALWAYS ("always");
-
-    private String serialized;
-
-    ArchiveMode(String s) {
-        serialized = s;
-    }
+    ALWAYS;
 
     @Override
     public String toString() {
-        return serialized;
+        return name().toLowerCase();
     }
 }

src/main/java/com/opentok/ArchiveProperties.java

@@ -23,10 +23,9 @@
  * @see OpenTok#createSession(com.opentok.SessionProperties properties)
  */
 public class ArchiveProperties {
-
-
     private String name;
     private String resolution;
+    private String multiArchiveTag;
     private boolean hasAudio;
     private boolean hasVideo;
     private OutputMode outputMode;
@@ -41,6 +40,7 @@ private ArchiveProperties(Builder builder) {
         this.outputMode = builder.outputMode;
         this.streamMode = builder.streamMode;
         this.layout = builder.layout;
+        this.multiArchiveTag = builder.multiArchiveTag;
     }
 
     /**
@@ -51,6 +51,7 @@ private ArchiveProperties(Builder builder) {
     public static class Builder {
         private String name = null;
         private String resolution = null;
+        private String multiArchiveTag = null;
         private boolean hasAudio = true;
         private boolean hasVideo = true;
         private OutputMode outputMode = OutputMode.COMPOSED;
@@ -125,7 +126,7 @@ public Builder outputMode(OutputMode outputMode) {
 
         /**
          * Sets the stream mode for this archive.
-         *
+         * <p>
          * When streams are selected automatically (<code>StreamMode.AUTO</code>, the default), all
          * streams in the session can be included in the archive. When streams are selected manually
          * (<code>StreamMode.MANUAL</code>), you specify streams to be included based on calls
@@ -151,13 +152,30 @@ public Builder streamMode(StreamMode streamMode) {
          *
          * @param layout An object of type {@link ArchiveLayout} .
          *
-         * @return The ArchiveProperties.Builder object with the output mode setting.
+         * @return The ArchiveProperties.Builder object with the layout setting.
          */
         public Builder layout(ArchiveLayout layout) {
             this.layout = layout;
             return this;
         }
 
+        /**
+         * Set this to support recording multiple archives for the same session simultaneously.
+         * Set this to a unique string for each simultaneous archive of an ongoing session. You must also set this
+         * option when manually starting an archive that is automatically archived. If you do
+         * not specify a unique multiArchiveTag, you can only record one archive at a time for a given session. See
+         * <a href="https://tokbox.com/developer/guides/archiving/#simultaneous-archives">
+         * Simultaneous Archives documentation</a>.
+         *
+         * @param multiArchiveTag A unique archive tag.
+         *
+         * @return The ArchiveProperties.Builder object with the MultiArchiveTag setting.
+         */
+        public Builder multiArchiveTag(String multiArchiveTag) {
+            this.multiArchiveTag = multiArchiveTag;
+            return this;
+        }
+
         /**
          * Builds the ArchiveProperties object.
          *
@@ -182,6 +200,13 @@ public String resolution() {
         return resolution;
     }
 
+    /**
+     * Returns the multiArchiveTag, if present.
+     */
+    public String getMultiArchiveTag() {
+        return multiArchiveTag;
+    }
+
     /**
      * Whether the archive has a video track (<code>true</code>) or not (<code>false</code>).
      */
@@ -252,6 +277,12 @@ public Map<String, Collection<String>> toMap() {
             params.put("layout", valueList);
         }
 
+        if (multiArchiveTag != null) {
+            valueList = new ArrayList<>();
+            valueList.add(multiArchiveTag);
+            params.put("multiArchiveTag", valueList);
+        }
+
         return params;
     }
 

src/main/java/com/opentok/Broadcast.java

@@ -51,6 +51,7 @@ public enum StreamMode {
     @JsonProperty private long updatedAt;
     @JsonProperty private String resolution;
     @JsonProperty private String status;
+    @JsonProperty private String multiBroadcastTag;
     @JsonProperty private StreamMode streamMode = StreamMode.AUTO;
     private List<Rtmp> rtmpList = new ArrayList<>();
     private String hls;
@@ -120,6 +121,13 @@ public String getStatus() {
         return status;
     }
 
+    /**
+     * Returns the multiBroadcastTag if set for the Broadcast.
+     */
+    public String getMultiBroadcastTag() {
+        return multiBroadcastTag;
+    }
+
     /**
      * Details on the HLS and RTMP broadcast streams. For an HLS stream, the URL is provided.
      * See the <a href="https://tokbox.com/developer/guides/broadcast/live-streaming/">OpenTok

src/main/java/com/opentok/BroadcastProperties.java

@@ -19,12 +19,12 @@
  * {@link OpenTok#startBroadcast(String sessionId, BroadcastProperties properties)} method.
  */
 public class BroadcastProperties {
-
     private BroadcastLayout layout;
     private int maxDuration;
     private boolean hasHls;
     private List<RtmpProperties> rtmpList;
     private String resolution;
+    private String multiBroadcastTag;
     private StreamMode streamMode;
     private Hls hls;
 
@@ -36,6 +36,7 @@ private BroadcastProperties(Builder builder) {
         this.rtmpList = builder.rtmpList;
         this.resolution = builder.resolution;
         this.streamMode = builder.streamMode;
+        this.multiBroadcastTag = builder.multiBroadcastTag;
     }
 
     /**
@@ -47,7 +48,7 @@ public static class Builder {
         private BroadcastLayout layout = new BroadcastLayout(BroadcastLayout.Type.BESTFIT);
         private int maxDuration = 7200;
         private boolean hasHls = false;
-
+        private String multiBroadcastTag;
         private Hls hls;
         private List<RtmpProperties> rtmpList = new ArrayList<>();
         private String resolution = "640x480";
@@ -64,6 +65,7 @@ public Builder layout(BroadcastLayout layout){
             this.layout = layout;
             return this;
         }
+
         /**
          * Sets the maximum duration, in seconds, of the broadcast.
          * The broadcast will automatically stop when the maximum duration is reached.
@@ -157,6 +159,21 @@ public Builder streamMode(StreamMode streamMode) {
             return this;
         }
 
+        /**
+         * Set this to support multiple broadcasts for the same session simultaneously.
+         * Set this to a unique string for each simultaneous broadcast of an ongoing session. See
+         * <a href="https://tokbox.com/developer/guides/broadcast/live-streaming#simultaneous-broadcasts">
+         * Simultaneous Broadcasts documentation</a>.
+         *
+         * @param multiBroadcastTag A unique multi-broadcast tag.
+         *
+         * @return The BroadcastProperties.Builder object with the multiBroadcastTag setting.
+         */
+        public Builder multiBroadcastTag(String multiBroadcastTag) {
+            this.multiBroadcastTag = multiBroadcastTag;
+            return this;
+        }
+
          /**
          * Builds the BroadcastProperties object.
          *
@@ -209,6 +226,13 @@ public String resolution() {
         return resolution;
     }
 
+    /**
+     * Returns the multiBroadcastTag, if present.
+     */
+    public String getMultiBroadcastTag() {
+        return multiBroadcastTag;
+    }
+
     /**
      * The stream mode of the broadcast.
      */

src/main/java/com/opentok/util/HttpClient.java

@@ -215,6 +215,9 @@ public String startArchive(String sessionId, ArchiveProperties properties) throw
         if (properties.resolution() != null) {
             requestJson.put("resolution", properties.resolution());
         }
+        if (properties.getMultiArchiveTag() != null) {
+            requestJson.put("multiArchiveTag", properties.getMultiArchiveTag());
+        }
 
         String requestBody;
         try {
@@ -519,6 +522,9 @@ public String startBroadcast(String sessionId, BroadcastProperties properties) t
         if (properties.resolution() != null) {
             requestJson.put("resolution", properties.resolution());
         }
+        if (properties.getMultiBroadcastTag() != null) {
+            requestJson.put("multiBroadcastTag", properties.getMultiBroadcastTag());
+        }
 
         ObjectNode outputs = requestJson.putObject("outputs");
         if (properties.hasHls()) {

src/test/java/com/opentok/test/OpenTokTest.java

@@ -639,6 +639,7 @@ public void testListArchives() throws OpenTokException {
                                 "            \"duration\" : 14,\n" +
                                 "            \"id\" : \"5350f06f-0166-402e-bc27-09ba54948512\",\n" +
                                 "            \"name\" : \"\",\n" +
+                                "            \"multiArchiveTag\" : \"MyVideoArchiveTag\",\n" +
                                 "            \"partnerId\" : 123456,\n" +
                                 "            \"reason\" : \"\",\n" +
                                 "            \"sessionId\" : \"SESSIONID\",\n" +
@@ -707,6 +708,7 @@ public void testListArchives() throws OpenTokException {
         assertEquals(60, archives.getTotalCount());
         assertNotNull(archives.get(0));
         assertEquals("ef546c5a-4fd7-4e59-ab3d-f1cfb4148d1d", archives.get(0).getId());
+        assertEquals("MyVideoArchiveTag", archives.get(1).getMultiArchiveTag());
         verify(getRequestedFor(urlMatching(archivePath)));
         assertTrue(Helpers.verifyTokenAuth(apiKey, apiSecret,
                 findAll(getRequestedFor(urlMatching(archivePath)))));
@@ -967,9 +969,10 @@ public void testStartArchive() throws OpenTokException {
                 .outputMode(OutputMode.COMPOSED)
                 .streamMode(Archive.StreamMode.AUTO)
                 .resolution("1920x1080")
+                .multiArchiveTag("MyArchiveTag")
                 .build();
 
-        properties.toMap();
+        assertNotNull(properties.toMap());
 
         Archive archive = sdk.startArchive(sessionId, properties);
         assertNotNull(archive);
@@ -1711,6 +1714,7 @@ public void testStartBroadcast() throws OpenTokException {
                                 "          \"upDatedAt\" : 1437676551000,\n" +
                                 "          \"resolution\" : \"1280x720\",\n" +
                                 "          \"status\" : \"started\",\n" +
+                                "          \"multiBroadcastTag\" : \"MyVideoBroadcastTag\",\n" +
                                 "          \"broadcastUrls\" : {" +
                                 "           \"hls\" : \"http://server/fakepath/playlist.m3u8\"," +
                                 "           \"rtmp\" : [{" +
@@ -1737,6 +1741,7 @@ public void testStartBroadcast() throws OpenTokException {
                 .addRtmpProperties(rtmpNextProps)
                 .maxDuration(1000)
                 .resolution("640x480")
+                .multiBroadcastTag("MyVideoBroadcastTag")
                 .layout(layout)
                 .streamMode(Broadcast.StreamMode.AUTO)
                 .build();
@@ -1755,6 +1760,7 @@ public void testStartBroadcast() throws OpenTokException {
         assertTrue(broadcast.getUpdatedAt() > -1);
         assertTrue(broadcast.getProjectId() > -1);
         assertEquals(sessionId, broadcast.getSessionId());
+        assertEquals("MyVideoBroadcastTag", broadcast.getMultiBroadcastTag());
         assertEquals(Broadcast.StreamMode.AUTO, broadcast.getStreamMode());
         assertNotNull(broadcast.getId());
         verify(postRequestedFor(urlMatching(url)));