Merge pull request #1148 from ably/rename/liveobject-classes

[LiveObject] Refactor/rename liveobjects classes

Author: sacOO7

android/src/main/java/io/ably/lib/realtime/Channel.java

@@ -3,7 +3,7 @@
 import io.ably.lib.types.AblyException;
 import io.ably.lib.types.ChannelOptions;
 import io.ably.lib.push.PushChannel;
-import io.ably.lib.objects.LiveObjectsPlugin;
+import io.ably.lib.objects.ObjectsPlugin;
 
 
 public class Channel extends ChannelBase {
@@ -14,8 +14,8 @@ public class Channel extends ChannelBase {
      */
     public final PushChannel push;
 
-    Channel(AblyRealtime ably, String name, ChannelOptions options, LiveObjectsPlugin liveObjectsPlugin) throws AblyException {
-        super(ably, name, options, liveObjectsPlugin);
+    Channel(AblyRealtime ably, String name, ChannelOptions options, ObjectsPlugin objectsPlugin) throws AblyException {
+        super(ably, name, options, objectsPlugin);
         this.push = ((io.ably.lib.rest.AblyRest) ably).channels.get(name, options).push;
     }
 

java/src/main/java/io/ably/lib/realtime/Channel.java

@@ -1,12 +1,13 @@
 package io.ably.lib.realtime;
 
-import io.ably.lib.objects.LiveObjectsPlugin;
+import io.ably.lib.objects.ObjectsPlugin;
 import io.ably.lib.types.AblyException;
 import io.ably.lib.types.ChannelOptions;
+import org.jetbrains.annotations.Nullable;
 
 public class Channel extends ChannelBase {
-    Channel(AblyRealtime ably, String name, ChannelOptions options, LiveObjectsPlugin liveObjectsPlugin) throws AblyException {
-        super(ably, name, options, liveObjectsPlugin);
+    Channel(AblyRealtime ably, String name, ChannelOptions options, @Nullable ObjectsPlugin objectsPlugin) throws AblyException {
+        super(ably, name, options, objectsPlugin);
     }
 
     public interface MessageListener extends ChannelBase.MessageListener {}

lib/src/main/java/io/ably/lib/objects/Adapter.java

@@ -9,9 +9,9 @@
 import io.ably.lib.util.Log;
 import org.jetbrains.annotations.NotNull;
 
-public class Adapter implements LiveObjectsAdapter {
+public class Adapter implements ObjectsAdapter {
     private final AblyRealtime ably;
-    private static final String TAG = LiveObjectsAdapter.class.getName();
+    private static final String TAG = ObjectsAdapter.class.getName();
 
     public Adapter(@NotNull AblyRealtime ably) {
         this.ably = ably;

lib/src/main/java/io/ably/lib/objects/LiveObjectsHelper.java

@@ -7,11 +7,11 @@
 import org.jetbrains.annotations.Blocking;
 import org.jetbrains.annotations.NotNull;
 
-public interface LiveObjectsAdapter {
+public interface ObjectsAdapter {
     /**
      * Retrieves the client options configured for the Ably client.
      * Used to access client configuration parameters such as echoMessages setting
-     * that affect the behavior of LiveObjects operations.
+     * that affect the behavior of Objects operations.
      *
      * @return the client options containing configuration parameters
      */

…ably/lib/objects/LiveObjectsAdapter.java …/io/ably/lib/objects/ObjectsAdapter.javalib/src/main/java/io/ably/lib/objects/LiveObjectsAdapter.java renamed to lib/src/main/java/io/ably/lib/objects/ObjectsAdapter.java lib/src/main/java/io/ably/lib/objects/LiveObjectsAdapter.java renamed to lib/src/main/java/io/ably/lib/objects/ObjectsAdapter.java

@@ -3,9 +3,9 @@
 import io.ably.lib.types.AblyException;
 
 /**
- * Callback interface for handling results of asynchronous LiveObjects operations.
+ * Callback interface for handling results of asynchronous Objects operations.
  * Used for operations like creating LiveMaps/LiveCounters, modifying entries, and retrieving objects.
- * Callbacks are executed on background threads managed by the LiveObjects system.
+ * Callbacks are executed on background threads managed by the Objects system.
  *
  * @param <T> the type of the result returned by the asynchronous operation
  */

lib/src/main/java/io/ably/lib/objects/ObjectsCallback.java

@@ -0,0 +1,48 @@
+package io.ably.lib.objects;
+
+import io.ably.lib.realtime.AblyRealtime;
+import io.ably.lib.util.Log;
+import org.jetbrains.annotations.Nullable;
+
+import java.lang.reflect.InvocationTargetException;
+
+public class ObjectsHelper {
+
+    private static final String TAG = ObjectsHelper.class.getName();
+    private static volatile ObjectsSerializer objectsSerializer;
+
+    @Nullable
+    public static ObjectsPlugin tryInitializeObjectsPlugin(AblyRealtime ablyRealtime) {
+        try {
+            Class<?> objectsImplementation = Class.forName("io.ably.lib.objects.DefaultObjectsPlugin");
+            ObjectsAdapter adapter = new Adapter(ablyRealtime);
+            return (ObjectsPlugin) objectsImplementation
+                .getDeclaredConstructor(ObjectsAdapter.class)
+                .newInstance(adapter);
+        } catch (ClassNotFoundException | InstantiationException | IllegalAccessException | NoSuchMethodException |
+                 InvocationTargetException e) {
+            Log.i(TAG, "LiveObjects plugin not found in classpath. LiveObjects functionality will not be available.", e);
+            return null;
+        }
+    }
+
+    @Nullable
+    public static ObjectsSerializer getSerializer() {
+        if (objectsSerializer == null) {
+            synchronized (ObjectsHelper.class) {
+                if (objectsSerializer == null) { // Double-Checked Locking (DCL)
+                    try {
+                        Class<?> serializerClass = Class.forName("io.ably.lib.objects.serialization.DefaultObjectsSerializer");
+                        objectsSerializer = (ObjectsSerializer) serializerClass.getDeclaredConstructor().newInstance();
+                    } catch (ClassNotFoundException | InstantiationException | IllegalAccessException |
+                             NoSuchMethodException |
+                             InvocationTargetException e) {
+                        Log.w(TAG, "Failed to init ObjectsSerializer, LiveObjects plugin not included in the classpath", e);
+                        return null;
+                    }
+                }
+            }
+        }
+        return objectsSerializer;
+    }
+}

lib/src/main/java/io/ably/lib/objects/ObjectsHelper.java

@@ -11,14 +11,14 @@
 
 import java.lang.reflect.Type;
 
-public class LiveObjectsJsonSerializer implements JsonSerializer<Object[]>, JsonDeserializer<Object[]> {
-    private static final String TAG = LiveObjectsJsonSerializer.class.getName();
+public class ObjectsJsonSerializer implements JsonSerializer<Object[]>, JsonDeserializer<Object[]> {
+    private static final String TAG = ObjectsJsonSerializer.class.getName();
 
     @Override
     public Object[] deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
-        LiveObjectSerializer serializer = LiveObjectsHelper.getLiveObjectSerializer();
+        ObjectsSerializer serializer = ObjectsHelper.getSerializer();
         if (serializer == null) {
-            Log.w(TAG, "Skipping 'state' field json deserialization because LiveObjectsSerializer not found.");
+            Log.w(TAG, "Skipping 'state' field json deserialization because ObjectsSerializer not found.");
             return null;
         }
         if (!json.isJsonArray()) {
@@ -29,9 +29,9 @@ public Object[] deserialize(JsonElement json, Type typeOfT, JsonDeserializationC
 
     @Override
     public JsonElement serialize(Object[] src, Type typeOfSrc, JsonSerializationContext context) {
-        LiveObjectSerializer serializer = LiveObjectsHelper.getLiveObjectSerializer();
+        ObjectsSerializer serializer = ObjectsHelper.getSerializer();
         if (serializer == null) {
-            Log.w(TAG, "Skipping 'state' field json serialization because LiveObjectsSerializer not found.");
+            Log.w(TAG, "Skipping 'state' field json serialization because ObjectsSerializer not found.");
             return JsonNull.INSTANCE;
         }
         return serializer.asJsonArray(src);

…b/objects/LiveObjectsJsonSerializer.java …y/lib/objects/ObjectsJsonSerializer.javalib/src/main/java/io/ably/lib/objects/LiveObjectsJsonSerializer.java renamed to lib/src/main/java/io/ably/lib/objects/ObjectsJsonSerializer.java lib/src/main/java/io/ably/lib/objects/LiveObjectsJsonSerializer.java renamed to lib/src/main/java/io/ably/lib/objects/ObjectsJsonSerializer.java

@@ -5,22 +5,22 @@
 import org.jetbrains.annotations.NotNull;
 
 /**
- * The LiveObjectsPlugin interface provides a mechanism for managing and interacting with
+ * The ObjectsPlugin interface provides a mechanism for managing and interacting with
  * live data objects in a real-time environment. It allows for the retrieval, disposal, and
- * management of LiveObjects instances associated with specific channel names.
+ * management of Objects instances associated with specific channel names.
  */
-public interface LiveObjectsPlugin {
+public interface ObjectsPlugin {
 
     /**
-     * Retrieves an instance of LiveObjects associated with the specified channel name.
-     * This method ensures that a LiveObjects instance is available for the given channel,
+     * Retrieves an instance of RealtimeObjects associated with the specified channel name.
+     * This method ensures that a RealtimeObjects instance is available for the given channel,
      * creating one if it does not already exist.
      *
-     * @param channelName the name of the channel for which the LiveObjects instance is to be retrieved.
-     * @return the LiveObjects instance associated with the specified channel name.
+     * @param channelName the name of the channel for which the RealtimeObjects instance is to be retrieved.
+     * @return the RealtimeObjects instance associated with the specified channel name.
      */
     @NotNull
-    LiveObjects getInstance(@NotNull String channelName);
+    RealtimeObjects getInstance(@NotNull String channelName);
 
     /**
      * Handles a protocol message.
@@ -34,7 +34,7 @@ public interface LiveObjectsPlugin {
     /**
      * Handles state changes for a specific channel.
      * This method is invoked whenever a channel's state changes, allowing the implementation
-     * to update the LiveObjects instances accordingly based on the new state and presence of objects.
+     * to update the RealtimeObjects instances accordingly based on the new state and presence of objects.
      *
      * @param channelName the name of the channel whose state has changed.
      * @param state the new state of the channel.
@@ -43,12 +43,12 @@ public interface LiveObjectsPlugin {
     void handleStateChange(@NotNull String channelName, @NotNull ChannelState state, boolean hasObjects);
 
     /**
-     * Disposes of the LiveObjects instance associated with the specified channel name.
-     * This method removes the LiveObjects instance for the given channel, releasing any
+     * Disposes of the RealtimeObjects instance associated with the specified channel name.
+     * This method removes the RealtimeObjects instance for the given channel, releasing any
      * resources associated with it.
      * This is invoked when ablyRealtimeClient.channels.release(channelName) is called
      *
-     * @param channelName the name of the channel whose LiveObjects instance is to be removed.
+     * @param channelName the name of the channel whose RealtimeObjects instance is to be removed.
      */
     void dispose(@NotNull String channelName);
 

…/ably/lib/objects/LiveObjectsPlugin.java …a/io/ably/lib/objects/ObjectsPlugin.javalib/src/main/java/io/ably/lib/objects/LiveObjectsPlugin.java renamed to lib/src/main/java/io/ably/lib/objects/ObjectsPlugin.java lib/src/main/java/io/ably/lib/objects/LiveObjectsPlugin.java renamed to lib/src/main/java/io/ably/lib/objects/ObjectsPlugin.java

@@ -8,10 +8,9 @@
 import java.io.IOException;
 
 /**
- * Serializer interface for converting between LiveObject arrays and their
- * MessagePack or JSON representations.
+ * Serializer interface for converting between objects and their MessagePack or JSON representations.
  */
-public interface LiveObjectSerializer {
+public interface ObjectsSerializer {
     /**
      * Reads a MessagePack array from the given unpacker and deserializes it into an Object array.
      *