Protocol 2.0

android/src/androidTest/java/io/ably/lib/test/android/AndroidPushTest.java

@@ -54,7 +54,6 @@
 import io.ably.lib.types.ClientOptions;
 import io.ably.lib.types.ErrorInfo;
 import io.ably.lib.types.Param;
-import io.ably.lib.types.RegistrationToken;
 import io.ably.lib.util.Base64Coder;
 import io.ably.lib.util.IntentUtils;
 import io.ably.lib.util.JsonUtils;
@@ -1372,11 +1371,12 @@ public void run() throws Exception {
                 }
 
                 testActivation.registerAndWait();
-                DeviceDetails otherDevice = DeviceDetails.fromJsonObject(JsonUtils.object()
+                LocalDevice otherDevice = LocalDevice.fromJsonObject(JsonUtils.object()
                         .add("id", "other")
                         .add("platform", "android")
                         .add("formFactor", "tablet")
                         .add("metadata", JsonUtils.object())
+                        .add("deviceSecret", "testdevicesecret==") //Required by API protocol 2.0
                         .add("push", JsonUtils.object()
                                 .add("recipient", JsonUtils.object()
                                         .add("transportType", "fcm")

android/src/main/java/io/ably/lib/push/ActivationStateMachine.java

@@ -19,7 +19,6 @@
 import io.ably.lib.types.Callback;
 import io.ably.lib.types.ErrorInfo;
 import io.ably.lib.types.Param;
-import io.ably.lib.types.RegistrationToken;
 import io.ably.lib.util.IntentUtils;
 import io.ably.lib.util.Log;
 import io.ably.lib.util.ParamsUtils;

android/src/main/java/io/ably/lib/push/LocalDevice.java

@@ -15,12 +15,10 @@
 import io.ably.lib.types.RegistrationToken;
 import io.ably.lib.util.Base64Coder;
 import io.ably.lib.util.Log;
+import io.ably.lib.util.Serialisation;
 
 public class LocalDevice extends DeviceDetails {
-    /**
-     * A unique device secret generated by the Ably SDK.
-     */
-    public String deviceSecret;
+
     /**
      * A unique device identity token used to communicate with APNS or FCM.
      */
@@ -42,12 +40,11 @@ public LocalDevice(ActivationContext activationContext, Storage storage) {
     }
 
     public JsonObject toJsonObject() {
-        JsonObject o = super.toJsonObject();
-        if (deviceSecret != null) {
-            o.addProperty("deviceSecret", deviceSecret);
-        }
+        return super.toJsonObject();
+    }
 
-        return o;
+    public static LocalDevice fromJsonObject(JsonObject o) {
+        return Serialisation.gson.fromJson(o, LocalDevice.class);
     }
 
     private void loadPersisted() {

core/src/main/java/io/ably/lib/realtime/AblyRealtimeBase.java

@@ -65,7 +65,7 @@ public AblyRealtimeBase(String key, PlatformAgentProvider platformAgentProvider)
      * @param platformAgentProvider for providing the platform specific part of the agent header
      * @throws AblyException
      */
-    public AblyRealtimeBase(ClientOptions options, PlatformAgentProvider platformAgentProvider) throws AblyException {
+    public AblyRealtimeBase(final ClientOptions options, PlatformAgentProvider platformAgentProvider) throws AblyException {
         super(options, platformAgentProvider);
         final InternalChannels channels = new InternalChannels();
         this.channels = (Channels<ChannelType>) channels;
@@ -79,6 +79,31 @@ public void onConnectionStateChanged(ConnectionStateListener.ConnectionStateChan
             }
         });
 
+        if (options.recover != null) {
+            ConnectionRecoveryKey recoveryKey = ConnectionRecoveryKey.fromJson(options.recover);
+            if (recoveryKey == null) {
+                Log.d(TAG, "Recovery key initialization failed!");
+                connection.connectionManager.msgSerial = 0; //RTN16f
+            } else {
+                connection.connectionManager.msgSerial = recoveryKey.getMsgSerial(); //RTN16f
+
+                for (Map.Entry<String, String> serial : recoveryKey.getSerials().entrySet()) {
+                    //RTN16j
+                    RealtimeChannelBase channel = channels.get(serial.getKey());
+                    if (channel != null) {
+                        channel.properties.channelSerial = serial.getValue(); //RTN16i
+                    }
+                }
+            }
+
+            connection.on(ConnectionEvent.connected, new ConnectionStateListener() {
+                @Override
+                public void onConnectionStateChanged(ConnectionStateChange state) {
+                    options.recover = null; //RTN16k
+                }
+            });
+        }
+
         if(options.autoConnect) connection.connect();
     }
 
@@ -232,6 +257,21 @@ public void suspendAll(ErrorInfo error, boolean notifyStateChange) {
             }
         }
 
+        /**
+         * By spec RTN15c6, RTN15c7
+         */
+        @Override
+        public void reAttach() {
+            for (Map.Entry<String, RealtimeChannelBase> channelEntry : map.entrySet()) {
+                RealtimeChannelBase channel = channelEntry.getValue();
+                if (channel.state == ChannelState.attaching || channel.state == ChannelState.attached || channel.state == ChannelState.suspended) {
+                    Log.d(TAG, "reAttach(); channel = " + channel.name);
+                    channel.state = ChannelState.attaching;
+                    channel.attach(true, null);
+                }
+            }
+        }
+
         private void clear() {
             map.clear();
         }

core/src/main/java/io/ably/lib/realtime/Connection.java

@@ -59,16 +59,6 @@ public class Connection extends EventEmitter<ConnectionEvent, ConnectionStateLis
      */
     public String id;
 
-    /**
-     * The serial number of the last message to be received on this connection,
-     * used automatically by the library when recovering or resuming a connection.
-     * When recovering a connection explicitly, the recoveryKey is used in the recover
-     * client options as it contains both the key and the last message serial.
-     * <p>
-     * Spec: RTN10
-     */
-    public long serial;
-
     /**
      * Explicitly calling connect() is unnecessary unless the autoConnect attribute of the {@link io.ably.lib.types.ClientOptions}
      * object is false.
@@ -101,7 +91,6 @@ public void ping(CompletionListener listener) {
      */
     public void close() {
         key = null;
-        recoveryKey = null;
         connectionManager.close();
     }
 
@@ -124,7 +113,7 @@ public void onConnectionStateChange(ConnectionStateChange stateChange) {
     @Override
     protected void apply(ConnectionStateListener listener, ConnectionEvent event, Object... args) {
         try {
-            listener.onConnectionStateChanged((ConnectionStateChange)args[0]);
+            listener.onConnectionStateChanged((ConnectionStateChange) args[0]);
         } catch (Throwable t) {
             Log.e(TAG, "Unexpected exception calling ConnectionStateListener", t);
         }
@@ -135,6 +124,35 @@ public void emitUpdate(ErrorInfo errorInfo) {
             emit(ConnectionEvent.update, ConnectionStateListener.ConnectionStateChange.createUpdateEvent(errorInfo));
     }
 
+    /**
+     * Spec: RTN16g
+     *
+     * @return a json string which incorporates the @connectionKey@, the current @msgSerial@,
+     * and a collection of pairs of channel @name@ and current @channelSerial@ for every currently attached channel.
+     */
+    public String createRecoveryKey() {
+        if (key == null || connectionManager == null || connectionManager.getConnectionState() == null ||
+            connectionManager.getConnectionState().state == ConnectionState.closed ||
+            connectionManager.getConnectionState().state == ConnectionState.closing ||
+            connectionManager.getConnectionState().state == ConnectionState.failed ||
+            connectionManager.getConnectionState().state == ConnectionState.suspended
+        ) {
+            //RTN16h
+            return null;
+        }
+
+        ConnectionRecoveryKey recoveryKey = new ConnectionRecoveryKey(key, connectionManager.msgSerial);
+
+        for (Object channel : ably.channels.values()) {
+            if (channel instanceof RealtimeChannelBase) {
+                RealtimeChannelBase rcb = (RealtimeChannelBase) channel;
+                recoveryKey.addSerial(rcb.name, rcb.properties.channelSerial);
+            }
+        }
+
+        return recoveryKey.asJson();
+    }
+
     @Deprecated
     public void emit(ConnectionState state, ConnectionStateChange stateChange) {
         super.emit(state.getConnectionEvent(), stateChange);

core/src/main/java/io/ably/lib/realtime/ConnectionRecoveryKey.java

@@ -0,0 +1,62 @@
+package io.ably.lib.realtime;
+
+import com.google.gson.JsonSyntaxException;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import io.ably.lib.util.Log;
+import io.ably.lib.util.Serialisation;
+
+public class ConnectionRecoveryKey {
+    private static final String TAG = "RecoveryKey";
+
+    private final String connectionKey;
+    private final long msgSerial;
+    /**
+     * Key - channel name
+     * <p>
+     * Value - channelSerial
+     */
+    private final Map<String, String> serials = new HashMap<>();
+
+    public ConnectionRecoveryKey(String connectionKey, long msgSerial) {
+        this.connectionKey = connectionKey;
+        this.msgSerial = msgSerial;
+    }
+
+    public String getConnectionKey() {
+        return connectionKey;
+    }
+
+    public long getMsgSerial() {
+        return msgSerial;
+    }
+
+    public Map<String, String> getSerials() {
+        return serials;
+    }
+
+    public void setSerials(Map<String, String> serials) {
+        this.serials.clear();
+        this.serials.putAll(serials);
+    }
+
+    public void addSerial(String channelName, String channelSerial) {
+        this.serials.put(channelName, channelSerial);
+    }
+
+    public String asJson() {
+        return Serialisation.gson.toJson(this);
+    }
+
+    public static ConnectionRecoveryKey fromJson(String json) {
+        try {
+            return Serialisation.gson.fromJson(json, ConnectionRecoveryKey.class);
+        } catch (JsonSyntaxException e) {
+            Log.e(TAG, "Cannot create recovery key from json: " + e.getMessage());
+            return null;
+        }
+    }
+
+}