Merge pull request #119 from juandebravo/feature/prefer-json-to-create-a-session

Prefer JSON format response while creating an Opentok session

Author: ggarber

build.gradle

@@ -7,6 +7,7 @@ apply plugin: 'maven'
 apply plugin: 'signing'
 apply plugin: 'idea'
 apply plugin: 'eclipse'
+apply plugin: 'license'
 
 group = 'com.tokbox'
 archivesBaseName = 'opentok-server-sdk'
@@ -49,7 +50,6 @@ dependencies {
     //compile group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.5'
 }
 
-apply plugin: 'license'
 license {
     header rootProject.file('codequality/HEADER')
     ext.year = Calendar.getInstance().get(Calendar.YEAR)

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

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.
@@ -11,7 +11,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
-* Represents an archive of an OpenTok session. 
+* Represents an archive of an OpenTok session.
 */
 @JsonIgnoreProperties(ignoreUnknown=true)
 public class Archive {
@@ -160,7 +160,7 @@ public String getSessionId() {
         return sessionId;
     }
 
-    /** 
+    /**
      * The size of the MP4 file. For archives that have not been generated, this value is set to 0.
      */
     public int getSize() {
@@ -176,7 +176,7 @@ public Status getStatus() {
 
     /**
      * The download URL of the available MP4 file. This is only set for an archive with the status
-     * set to Status.AVAILABLE; for other archives, (including archives with the status of 
+     * set to Status.AVAILABLE; for other archives, (including archives with the status of
      * Status.UPLOADED) this method returns null. The download URL is obfuscated, and the file
      * is only available from the URL for 10 minutes. To generate a new URL, call the
      * {@link com.opentok.OpenTok#listArchives()} or {@link com.opentok.OpenTok#getArchive(String)}
@@ -201,7 +201,7 @@ public boolean hasAudio() {
     }
 
     /**
-     * The output mode to be generated for this archive: <code>composed</code> or <code>individual</code>. 
+     * The output mode to be generated for this archive: <code>composed</code> or <code>individual</code>.
      */
     public OutputMode getOutputMode() {
         return outputMode;
@@ -214,7 +214,7 @@ public String toString() {
         } catch (Exception e) {
             return "";
         }
-        
+
     }
 
-}
+}

src/main/java/com/opentok/ArchiveList.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

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

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

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

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/CreatedSession.java

@@ -0,0 +1,75 @@
+/**
+ * OpenTok Java SDK
+ * Copyright (C) 2017 TokBox, Inc.
+ * http://www.tokbox.com
+ *
+ * Licensed under The MIT License (MIT). See LICENSE file for more information.
+ */
+package com.opentok;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+/**
+ * Represents a generated OpenTok session via REST API.
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class CreatedSession {
+
+    private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
+
+    @JsonProperty("session_id")
+    private String sessionId;
+
+    @JsonProperty("project_id")
+    private String projectId;
+
+    @JsonProperty("partner_id")
+    private String partnerId;
+
+    @JsonProperty("create_dt")
+    private String createDt;
+
+    @JsonProperty("media_server_url")
+    private String mediaServerURL;
+
+    protected CreatedSession() {
+    }
+
+    @JsonCreator
+    public static CreatedSession makeSession() {
+        return new CreatedSession();
+    }
+
+    public String getId() {
+        return sessionId;
+    }
+
+    public String getProjectId() {
+        return projectId;
+    }
+
+    public String getPartnerId() {
+        return partnerId;
+    }
+
+    public String getCreateDt() {
+        return createDt;
+    }
+
+    public String getMediaServerURL() {
+        return mediaServerURL;
+    }
+
+    @Override
+    public String toString() {
+        try {
+            return OBJECT_MAPPER.writeValueAsString(this);
+        } catch (Exception e) {
+            return "";
+        }
+
+    }
+}

src/main/java/com/opentok/MediaMode.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/OpenTok.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.
@@ -15,14 +15,8 @@
 import com.opentok.exception.RequestException;
 import com.opentok.util.Crypto;
 import com.opentok.util.HttpClient;
-import com.opentok.util.TokenGenerator;
-import org.xml.sax.InputSource;
 
-import javax.xml.xpath.XPath;
-import javax.xml.xpath.XPathExpressionException;
-import javax.xml.xpath.XPathFactory;
 import java.io.IOException;
-import java.io.StringReader;
 import java.io.UnsupportedEncodingException;
 import java.net.Proxy;
 import java.util.Collection;
@@ -48,6 +42,8 @@ public class OpenTok {
             .readerFor(Archive.class);
     static protected ObjectReader archiveListReader = new ObjectMapper()
             .readerFor(ArchiveList.class);
+    static protected ObjectReader createdSessionReader = new ObjectMapper()
+            .readerFor(CreatedSession[].class);
     static final String defaultApiUrl = "https://api.opentok.com";
 
     /**
@@ -238,25 +234,19 @@ public String generateToken(String sessionId) throws OpenTokException {
      * session. You will use this session ID in the client SDKs to identify the session.
      */
     public Session createSession(SessionProperties properties) throws OpenTokException {
-        Map<String, Collection<String>> params;
-        String xpathQuery = "/sessions/Session/session_id";
+        final SessionProperties _properties = properties != null ? properties : new SessionProperties.Builder().build();
+        final Map<String, Collection<String>> params = _properties.toMap();
+        final String response = this.client.createSession(params);
 
-        // NOTE: doing this null check twice is kind of ugly
-        params = properties != null ? properties.toMap() :
-                new SessionProperties.Builder().build().toMap();
-        
-        String xmlResponse = this.client.createSession(params);
-
-
-        // NOTE: doing this null check twice is kind of ugly
         try {
-            if (properties != null) {
-                return new Session(readXml(xpathQuery, xmlResponse), apiKey, apiSecret, properties);
-            } else {
-                return new Session(readXml(xpathQuery, xmlResponse), apiKey, apiSecret);
+            CreatedSession[] sessions = createdSessionReader.readValue(response);
+            // A bit ugly, but API response should include an array with one session
+            if (sessions.length != 1) {
+                throw new OpenTokException(String.format("Unexpected number of sessions created %d", sessions.length));
             }
-        } catch (XPathExpressionException e) {
-            throw new OpenTokException("Cannot create session. Could not read the response: " + xmlResponse);
+            return new Session(sessions[0].getId(), apiKey, apiSecret, _properties);
+        } catch (IOException e) {
+            throw new OpenTokException("Cannot create session. Could not read the response: " + response);
         }
     }
 
@@ -302,13 +292,6 @@ public Session createSession() throws OpenTokException {
         return createSession(null);
     }
 
-    private static String readXml(String xpathQuery, String xml) throws XPathExpressionException {
-        XPathFactory xpathFactory = XPathFactory.newInstance();
-        XPath xpath = xpathFactory.newXPath();
-        InputSource source = new InputSource(new StringReader(xml));
-        return xpath.evaluate(xpathQuery, source);
-    }
-
     /**
      * Gets an {@link Archive} object for the given archive ID.
      *

src/main/java/com/opentok/Role.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/Session.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2016 TokBox, Inc.
+ * Copyright (C) 2017 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.