Merge pull request #191 from opentok/dev

Merge Configurable Request Timeout into Master

Author: yallen011

.bumpversion.cfg

@@ -0,0 +1,13 @@
+[bumpversion]
+commit = True
+tag = True
+current_version = 4.4.0
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?
+serialize = 
+	{major}.{minor}.{patch}
+
+[bumpversion:file:build.gradle]
+
+[bumpversion:file:README.md]
+
+[bumpversion:file:src/main/java/com/opentok/constants/Version.java]

.gitignore

@@ -25,3 +25,4 @@ bin
 .project
 
 /secret.sh
+**/.DS_Store

README.md

@@ -31,7 +31,7 @@ When you use Maven as your build tool, you can manage dependencies in the `pom.x
 <dependency>
     <groupId>com.tokbox</groupId>
     <artifactId>opentok-server-sdk</artifactId>
-    <version>4.3.2</version>
+    <version>4.4.0</version>
 </dependency>
 ```
 
@@ -41,7 +41,7 @@ When you use Gradle as your build tool, you can manage dependencies in the `buil
 
 ```groovy
 dependencies {
-  compile group: 'com.tokbox', name: 'opentok-server-sdk', version: '4.3.2'
+  compile group: 'com.tokbox', name: 'opentok-server-sdk', version: '4.4.0'
 }
 ```
 
@@ -69,6 +69,12 @@ String apiSecret = "YOUR API SECRET";
 OpenTok opentok = new OpenTok(apiKey, apiSecret)
 ```
 
+#### Additional Configurations
+`.requestTimeout(int)` - Change the default HTTP request timeout, default is 60 seconds.
+`.apiUrl(String)` - Change the domain that the SDK points to. Useful when needing to select a specific datacenter or point to a mock version of the API for testing.
+`.proxy(Proxy)` - Using a `Proxy` object, you can configure a proxy server that the http client should use when accessing the OpenTok URLs.
+
+
 And make sure you call `close` when you are done to prevent leaked file descriptors.
 
 ```java

build.gradle

@@ -12,7 +12,7 @@ apply plugin: 'jacoco'
 
 group = 'com.tokbox'
 archivesBaseName = 'opentok-server-sdk'
-version = '4.3.2'
+version = '4.4.0'
 
 task javadocJar(type: Jar) {
     classifier = 'javadoc'

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

@@ -134,7 +134,7 @@ public String generateToken(String sessionId, TokenOptions tokenOptions) throws
         } catch (UnsupportedEncodingException e) {
             throw new InvalidArgumentException("Session ID was not valid");
         }
-        if (!sessionIdParts.contains(Integer.toString(this.apiKey))) {
+        if (!sessionIdParts.contains(Integer.toString(apiKey))) {
             throw new InvalidArgumentException("Session ID was not valid");
         }
 
@@ -244,7 +244,7 @@ public String generateToken(String sessionId) throws OpenTokException {
     public Session createSession(SessionProperties properties) throws OpenTokException {
         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);
+        final String response = client.createSession(params);
 
         try {
             CreatedSession[] sessions = createdSessionReader.readValue(response);
@@ -306,7 +306,7 @@ public void signal(String sessionId, SignalProperties props) throws OpenTokExcep
             throw new InvalidArgumentException("Session string null or empty");
         }
         try {
-            this.client.signal(sessionId,null,props);
+            client.signal(sessionId,null,props);
 
         } catch (Exception e)
         {
@@ -321,7 +321,7 @@ public void signal(String sessionId, String connectionId, SignalProperties props
             throw new InvalidArgumentException("Session or Connection string null or empty");
         }
         try {
-            this.client.signal(sessionId, connectionId, props);
+            client.signal(sessionId, connectionId, props);
 
         } catch (Exception e)
         {
@@ -336,7 +336,7 @@ public void signal(String sessionId, String connectionId, SignalProperties props
      * @return The {@link Archive} object.
      */
     public Archive getArchive(String archiveId) throws OpenTokException {
-        String archive = this.client.getArchive(archiveId);
+        String archive = client.getArchive(archiveId);
         try {
             return archiveReader.readValue(archive);
         } catch (Exception e) {
@@ -401,7 +401,7 @@ public ArchiveList listArchives(int offset, int count) throws OpenTokException {
      * @return A List of {@link Archive} objects.
      */
     public ArchiveList listArchives(String sessionId, int offset, int count) throws OpenTokException {
-        String archives = this.client.getArchives(sessionId, offset, count);
+        String archives = client.getArchives(sessionId, offset, count);
         try {
             return archiveListReader.readValue(archives);
         } catch (JsonProcessingException e) {
@@ -442,7 +442,7 @@ public Archive startArchive(String sessionId, ArchiveProperties properties) thro
             throw new InvalidArgumentException("The resolution cannot be specified for individual output mode.");
         }
         // TODO: do validation on sessionId and name
-        String archive = this.client.startArchive(sessionId, properties);
+        String archive = client.startArchive(sessionId, properties);
         try {
             return archiveReader.readValue(archive);
         } catch (Exception e) {
@@ -470,7 +470,7 @@ public Archive startArchive(String sessionId, String name) throws OpenTokExcepti
      */
     public Archive stopArchive(String archiveId) throws OpenTokException {
 
-        String archive = this.client.stopArchive(archiveId);
+        String archive = client.stopArchive(archiveId);
         try {
             return archiveReader.readValue(archive);
         } catch (Exception e) {
@@ -488,7 +488,7 @@ public Archive stopArchive(String archiveId) throws OpenTokException {
      * @param archiveId The archive ID of the archive you want to delete.
      */
     public void deleteArchive(String archiveId) throws OpenTokException {
-        this.client.deleteArchive(archiveId);
+        client.deleteArchive(archiveId);
     }
     /**
      * Sets the layout type for a composed archive. For a description of layout types, see
@@ -503,7 +503,7 @@ public void setArchiveLayout(String archiveId, ArchiveProperties properties) thr
         if (StringUtils.isEmpty(archiveId) || properties == null) {
             throw new InvalidArgumentException("ArchiveId is not valid or properties are null");
         }
-        this.client.setArchiveLayout(archiveId, properties);
+        client.setArchiveLayout(archiveId, properties);
     }
     /**
      * Use this method to start a live streaming for an OpenTok session.
@@ -533,7 +533,7 @@ public Broadcast startBroadcast(String sessionId, BroadcastProperties properties
             throw new InvalidArgumentException("Session not valid or broadcast properties is null");
         }
 
-        String broadcast = this.client.startBroadcast(sessionId, properties);
+        String broadcast = client.startBroadcast(sessionId, properties);
         try {
             return broadcastReader.readValue(
                     broadcast);
@@ -557,7 +557,7 @@ public Broadcast stopBroadcast(String broadcastId) throws OpenTokException {
         if (StringUtils.isEmpty(broadcastId)) {
             throw new InvalidArgumentException("Broadcast id is null or empty");
         }
-        String broadcast = this.client.stopBroadcast(broadcastId);
+        String broadcast = client.stopBroadcast(broadcastId);
         try {
             return broadcastReader.readValue(broadcast);
         } catch (Exception e) {
@@ -575,7 +575,7 @@ public Broadcast getBroadcast(String broadcastId) throws OpenTokException {
         if(StringUtils.isEmpty(broadcastId)) {
             throw new InvalidArgumentException("Broadcast id is null or empty");
         }
-        String stream = this.client.getBroadcast(broadcastId);
+        String stream = client.getBroadcast(broadcastId);
         try {
             return broadcastReader.readValue(stream);
         } catch (Exception e) {
@@ -596,7 +596,7 @@ public void setBroadcastLayout(String broadcastId, BroadcastProperties propertie
         if (StringUtils.isEmpty(broadcastId) || properties == null) {
             throw new InvalidArgumentException("BroadcastId is not valid or properties are null");
         }
-        this.client.setBroadcastLayout(broadcastId, properties);
+        client.setBroadcastLayout(broadcastId, properties);
     }
     /**
      * Sets the layout class list for streams in a session. Layout classes are used in
@@ -619,7 +619,7 @@ public void setStreamLayouts(String sessionId, StreamListProperties properties)
         if (StringUtils.isEmpty(sessionId) || properties == null) {
             throw new InvalidArgumentException("SessionId is not valid or properties are null");
         }
-        this.client.setStreamLayouts(sessionId, properties);
+        client.setStreamLayouts(sessionId, properties);
     }
 
     /**
@@ -635,7 +635,7 @@ public void forceDisconnect(String sessionId, String connectionId) throws OpenTo
             throw new InvalidArgumentException("Session or Connection string null or empty");
         }
         try {
-            this.client.forceDisconnect(sessionId, connectionId);
+            client.forceDisconnect(sessionId, connectionId);
 
         } catch (Exception e)
         {
@@ -652,7 +652,7 @@ public void forceDisconnect(String sessionId, String connectionId) throws OpenTo
      * @return The {@link Stream} object.
      */
     public Stream getStream(String sessionId, String streamId) throws OpenTokException {
-        String stream = this.client.getStream(sessionId, streamId);
+        String stream = client.getStream(sessionId, streamId);
         try {
             return streamReader.readValue(stream);
         } catch (Exception e) {
@@ -668,7 +668,7 @@ public Stream getStream(String sessionId, String streamId) throws OpenTokExcepti
      * @return The list of {@link Stream} objects.
      */
     public StreamList listStreams(String sessionId) throws OpenTokException {
-        String streams = this.client.listStreams(sessionId);
+        String streams = client.listStreams(sessionId);
         try {
             return streamListReader.readValue(streams);
         } catch (JsonProcessingException e) {
@@ -690,7 +690,7 @@ public Sip dial(String sessionId, String token, SipProperties properties) throws
         if((StringUtils.isEmpty(sessionId) || StringUtils.isEmpty(token) || properties == null || StringUtils.isEmpty(properties.sipUri()))) {
             throw  new InvalidArgumentException ("Session id or token is null or empty or sip properties is null or sip uri empty or null.");
         }
-        String sip = this.client.sipDial(sessionId,token,properties);
+        String sip = client.sipDial(sessionId,token,properties);
         try {
             return sipReader.readValue(sip);
         } catch (JsonProcessingException e) {
@@ -707,6 +707,7 @@ public static class Builder {
         private ProxyAuthScheme proxyAuthScheme;
         private String principal;
         private String password;
+        private int requestTimeout;
 
         public Builder(int apiKey, String apiSecret) {
             this.apiKey = apiKey;
@@ -722,6 +723,11 @@ public Builder proxy(Proxy proxy) {
             proxy(proxy, null, null, null);
             return this;
         }
+
+        public Builder requestTimeout(int requestTimeout) {
+            this.requestTimeout = requestTimeout * 1000;
+            return this;
+        }
 
         public Builder proxy(Proxy proxy, ProxyAuthScheme proxyAuthScheme, String principal, String password) {
             this.proxy = proxy;
@@ -734,18 +740,21 @@ public Builder proxy(Proxy proxy, ProxyAuthScheme proxyAuthScheme, String princi
         public OpenTok build() {
             HttpClient.Builder clientBuilder = new HttpClient.Builder(apiKey, apiSecret);
 
-            if (this.apiUrl != null) {
-                clientBuilder.apiUrl(this.apiUrl);
+            if (apiUrl != null) {
+                clientBuilder.apiUrl(apiUrl);
+            }
+            if (proxy != null) {
+                clientBuilder.proxy(proxy, proxyAuthScheme, principal, password);
             }
-            if (this.proxy != null) {
-                clientBuilder.proxy(this.proxy, proxyAuthScheme, principal, password);
+            if(requestTimeout !=0){
+                clientBuilder.requestTimeoutMS(requestTimeout);
             }
 
-            return new OpenTok(this.apiKey, this.apiSecret, clientBuilder.build());
+            return new OpenTok(apiKey, apiSecret, clientBuilder.build());
         }
     }
 
     public void close() {
-        this.client.close();
+        client.close();
     }
 }

src/main/java/com/opentok/constants/Version.java

@@ -8,5 +8,5 @@
 package com.opentok.constants;
 
 public class Version {
-    public static final String VERSION = "4.3.2";
+    public static final String VERSION = "4.4.0";
 }

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

@@ -14,15 +14,7 @@
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.JsonNodeFactory;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import com.opentok.ArchiveLayout;
-import com.opentok.ArchiveProperties;
-import com.opentok.BroadcastLayout;
-import com.opentok.BroadcastProperties;
-import com.opentok.RtmpProperties;
-import com.opentok.SignalProperties;
-import com.opentok.SipProperties;
-import com.opentok.StreamListProperties;
-import com.opentok.StreamProperties;
+import com.opentok.*;
 import com.opentok.constants.DefaultApiUrl;
 import com.opentok.constants.Version;
 import com.opentok.exception.InvalidArgumentException;
@@ -830,6 +822,7 @@ public static class Builder {
         private String password;
         private String apiUrl;
         private AsyncHttpClientConfig config;
+        private int requestTimeoutMS;
 
         public Builder(int apiKey, String apiSecret) {
             this.apiKey = apiKey;
@@ -854,19 +847,34 @@ public Builder proxy(Proxy proxy, ProxyAuthScheme proxyAuthScheme, String princi
             return this;
         }
 
+        /**
+         * Specify a custom timeout value for HTTP requests when initalizing a new {@link OpenTok} object.
+         *
+         * @param requestTimeoutMS request timeout in milliseconds
+         * @return Builder
+         */
+        public Builder requestTimeoutMS(int requestTimeoutMS) {
+            this.requestTimeoutMS = requestTimeoutMS;
+            return this;
+        }
+
         public HttpClient build() {
             DefaultAsyncHttpClientConfig.Builder configBuilder = new DefaultAsyncHttpClientConfig.Builder()
                     .setUserAgent("Opentok-Java-SDK/" + Version.VERSION + " JRE/" + System.getProperty("java.version"))
-                    .addRequestFilter(new TokenAuthRequestFilter(this.apiKey, this.apiSecret));
-            if (this.apiUrl == null) {
-                this.apiUrl=DefaultApiUrl.DEFAULT_API_URI;
+                    .addRequestFilter(new TokenAuthRequestFilter(apiKey, apiSecret));
+            if (apiUrl == null) {
+                apiUrl=DefaultApiUrl.DEFAULT_API_URI;
             }
 
-            if (this.proxy != null) {
-                configBuilder.setProxyServer(createProxyServer(this.proxy, this.proxyAuthScheme, this.principal, this.password));
+            if (proxy != null) {
+                configBuilder.setProxyServer(createProxyServer(proxy, proxyAuthScheme, principal, password));
+            }
+
+            if(requestTimeoutMS != 0){
+                configBuilder.setRequestTimeout(requestTimeoutMS);
             }
 
-            this.config = configBuilder.build();
+            config = configBuilder.build();
             // NOTE: not thread-safe, config could be modified by another thread here?
             HttpClient client = new HttpClient(this);
             return client;