Add comments, Add message's timestamp, Improve RedisManager dummy singleton to be more singleton, Update README.md

Author: MrApik

README.md

@@ -175,6 +175,7 @@ This approach however **IS NOT RECOMMENDED** unless you know what you're doing!
 
 ```java
 import cz.foresttech.forestredis.shared.IForestRedisPlugin;
+import cz.foresttech.forestredis.shared.RedisManager;
 import org.bukkit.plugin.java.JavaPlugin;
 
 /**
@@ -189,7 +190,7 @@ public class MyExamplePlugin extends JavaPlugin implements IForestRedisPlugin {
         load();
         // ...
     }
-    
+
     @Override
     public void onDisable() {
         //...
@@ -213,12 +214,16 @@ public class MyExamplePlugin extends JavaPlugin implements IForestRedisPlugin {
         );
 
         // Initialize RedisManager instance (singleton)
-        new RedisManager(this, serverIdentifier, redisConfiguration).setup();
+        // Since init, use RedisManager#getAPI() to obtain the instance
+        RedisManager.init(this, serverIdentifier, redisConfiguration);
+        
+        // Now setup the connection
+        RedisManager.getAPI().setup(/*channels*/);
 
         // Now you can use #getAPI() call to get singleton instance
         RedisManager.getAPI().subscribe("MyChannel1");
     }
-    
+
     @Override
     public void runAsync(Runnable task) {
         // Required so RedisManager can run tasks async

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.example</groupId>
     <artifactId>ForestRedisAPI</artifactId>
-    <version>1.0.3</version>
+    <version>1.0.4</version>
 
     <properties>
         <maven.compiler.source>11</maven.compiler.source>
@@ -20,13 +20,15 @@
                 <filtering>true</filtering>
                 <includes>
                     <include>plugin.yml</include>
+                    <include>bungee.yml</include>
                 </includes>
             </resource>
             <resource>
                 <directory>src/main/resources</directory>
                 <filtering>false</filtering>
                 <excludes>
                     <exclude>plugin.yml</exclude>
+                    <exclude>bungee.yml</exclude>
                 </excludes>
             </resource>
         </resources>

src/main/java/cz/foresttech/forestredis/bungee/events/RedisMessageReceivedEvent.java

@@ -41,7 +41,6 @@ public String getMessage() {
     }
 
     @Override
-    @SuppressWarnings("Make sure the recieved message can really be converted to provided type!")
     public <T> T getMessageObject(Class<T> objectClass) {
         return this.messageTransferObject.parseMessageObject(objectClass);
     }
@@ -51,4 +50,9 @@ public boolean isSelfSender() {
         return this.messageTransferObject.getSenderIdentifier().equals(RedisManager.getAPI().getServerIdentifier());
     }
 
+    @Override
+    public long getTimeStamp() {
+        return this.messageTransferObject.getTimestamp();
+    }
+
 }

src/main/java/cz/foresttech/forestredis/shared/IForestRedisPlugin.java

@@ -57,6 +57,7 @@ default IConfigurationAdapter getConfigAdapter() {
      * Loading RedisManager from config method
      */
     default void load() {
+        // Close if RedisManager is already initialized
         if (RedisManager.getAPI() != null) {
             RedisManager.getAPI().close();
         }
@@ -86,7 +87,7 @@ default void load() {
         );
 
         // Initialize RedisManager object
-        new RedisManager(this, serverIdentifier, redisConfiguration);
+        RedisManager.init(this, serverIdentifier, redisConfiguration);
 
         // Setup the RedisManager
         List<String> channels = configAdapter.getStringList("channels");
@@ -98,4 +99,7 @@ default void load() {
         String[] channelsArray = channels.toArray(new String[0]);
         RedisManager.getAPI().setup(channelsArray);
     }
+
+    /*----------------------------------------------------------------------------------------------------------*/
+
 }

src/main/java/cz/foresttech/forestredis/shared/RedisManager.java

@@ -59,17 +59,14 @@ public class RedisManager {
     /*----------------------------------------------------------------------------------------------------------*/
 
     /**
-     * Constructor method for obtaining {@link RedisManager} instance. Constructor does not subscribe to the channels,
+     * Constructor method for creating {@link RedisManager} instance. Constructor does not subscribe to the channels,
      * it just stores the provided data for the future.
      *
      * @param plugin             Origin plugin which tries to obtain the instance
      * @param serverIdentifier   Identifier of the server (e.g. 'Bungee01'). Shall be unique to prevent bugs
      * @param redisConfiguration {@link RedisConfiguration} object with Redis server credentials
      */
-    public RedisManager(IForestRedisPlugin plugin, String serverIdentifier, RedisConfiguration redisConfiguration) {
-        // Initialize singleton instance
-        api = this;
-
+    private RedisManager(IForestRedisPlugin plugin, String serverIdentifier, RedisConfiguration redisConfiguration) {
         this.plugin = plugin;
         this.closing = false;
 
@@ -203,7 +200,7 @@ public boolean subscribe(String... channels) {
      * @see #publishMessage(String, String)
      */
     public boolean publishObject(String targetChannel, Object objectToPublish) {
-        MessageTransferObject messageTransferObject = MessageTransferObject.wrap(this.serverIdentifier, objectToPublish);
+        MessageTransferObject messageTransferObject = MessageTransferObject.wrap(this.serverIdentifier, objectToPublish, System.currentTimeMillis());
         return this.executePublish(targetChannel, messageTransferObject);
     }
 
@@ -219,7 +216,7 @@ public boolean publishObject(String targetChannel, Object objectToPublish) {
      * @see #publishObject(String, Object)
      */
     public boolean publishMessage(String targetChannel, String messageToPublish) {
-        MessageTransferObject messageTransferObject = new MessageTransferObject(this.serverIdentifier, messageToPublish);
+        MessageTransferObject messageTransferObject = new MessageTransferObject(this.serverIdentifier, messageToPublish, System.currentTimeMillis());
         return this.executePublish(targetChannel, messageTransferObject);
     }
 
@@ -388,6 +385,20 @@ public void onMessage(String channel, String message) {
 
     /*----------------------------------------------------------------------------------------------------------*/
 
+    /**
+     * Initialization method for creating {@link RedisManager} singleton instance. This won't start any
+     * connection or subscription.
+     *
+     * @param plugin             Origin plugin which tries to obtain the instance
+     * @param serverIdentifier   Identifier of the server (e.g. 'Bungee01'). Shall be unique to prevent bugs
+     * @param redisConfiguration {@link RedisConfiguration} object with Redis server credentials
+     */
+    public static void init(IForestRedisPlugin plugin, String serverIdentifier, RedisConfiguration redisConfiguration) {
+        api = new RedisManager(plugin, serverIdentifier, redisConfiguration);
+    }
+
+    /*----------------------------------------------------------------------------------------------------------*/
+
     /**
      * Gets the singleton instance of {@link RedisManager} object. This is the only
      * recommended approach to access the API methods.

src/main/java/cz/foresttech/forestredis/shared/config/IConfigurationAdapter.java

@@ -75,4 +75,6 @@ public interface IConfigurationAdapter {
      */
     List<String> getStringList(String path);
 
+    /*----------------------------------------------------------------------------------------------------------*/
+
 }

src/main/java/cz/foresttech/forestredis/shared/events/IRedisMessageReceivedEvent.java

@@ -34,13 +34,23 @@ public interface IRedisMessageReceivedEvent {
 
     /*----------------------------------------------------------------------------------------------------------*/
 
+    /**
+     * Obtains message timestamp
+     *
+     * @return  TimeStamp of the message
+     */
+    long getTimeStamp();
+
+    /*----------------------------------------------------------------------------------------------------------*/
+
     /**
      * Obtains object from received message by provided type
      *
      * @param objectClass   Object class
      * @param <T>   Object type
      * @return  Parsed object (null if it cannot be parsed)
      */
+    @SuppressWarnings("Make sure the recieved message can really be converted to provided type!")
     <T> T getMessageObject(Class<T> objectClass);
 
     /*----------------------------------------------------------------------------------------------------------*/
@@ -52,4 +62,6 @@ public interface IRedisMessageReceivedEvent {
      */
     boolean isSelfSender();
 
+    /*----------------------------------------------------------------------------------------------------------*/
+
 }

src/main/java/cz/foresttech/forestredis/shared/models/MessageTransferObject.java

@@ -11,37 +11,32 @@ public class MessageTransferObject {
 
     private String senderIdentifier;
     private String message;
+    private long timestamp;
 
     public MessageTransferObject() {
     }
 
-    public MessageTransferObject(String senderIdentifier, String message) {
-        this.senderIdentifier = senderIdentifier;
-        this.message = message;
-    }
-
-    public String getSenderIdentifier() {
-        return senderIdentifier;
-    }
-
-    public String getMessage() {
-        return message;
-    }
+    /*----------------------------------------------------------------------------------------------------------*/
 
-    public void setSenderIdentifier(String senderIdentifier) {
+    /**
+     * Constructs the instance with provided parameters
+     *
+     * @param senderIdentifier Identifier of sending server
+     * @param message          Message content
+     * @param timestamp        TimeStamp of the message
+     */
+    public MessageTransferObject(String senderIdentifier, String message, long timestamp) {
         this.senderIdentifier = senderIdentifier;
-    }
-
-    public void setMessage(String message) {
         this.message = message;
+        this.timestamp = timestamp;
     }
 
     /*----------------------------------------------------------------------------------------------------------*/
 
     /**
      * Converts current data to JSON using {@link Gson}
      *
-     * @return
+     * @return Object serialized to JSON String
      */
     public String toJson() {
         try {
@@ -57,8 +52,8 @@ public String toJson() {
     /**
      * Obtains {@link MessageTransferObject} from provided JSON String.
      *
-     * @param json
-     * @return
+     * @param json Serialized {@link MessageTransferObject} in JSON String
+     * @return Deserialized {@link MessageTransferObject}
      */
     public static MessageTransferObject fromJson(String json) {
         try {
@@ -74,15 +69,16 @@ public static MessageTransferObject fromJson(String json) {
     /**
      * Wraps the given object to {@link MessageTransferObject} object.
      *
-     * @param senderIdentifier
-     * @param objectToWrap
-     * @return
+     * @param senderIdentifier Identifier of the sending server
+     * @param objectToWrap     Object which shall be wrapped
+     * @param timestamp        TimeStamp of the message
+     * @return Instance of {@link MessageTransferObject} containing serialized object from input
      */
-    public static MessageTransferObject wrap(String senderIdentifier, Object objectToWrap) {
+    public static MessageTransferObject wrap(String senderIdentifier, Object objectToWrap, long timestamp) {
         Gson gson = new GsonBuilder().create();
         String message = gson.toJson(objectToWrap);
 
-        return new MessageTransferObject(senderIdentifier, message);
+        return new MessageTransferObject(senderIdentifier, message, timestamp);
     }
 
     /*----------------------------------------------------------------------------------------------------------*/
@@ -105,4 +101,27 @@ public <T> T parseMessageObject(Class<T> objectType) {
 
     /*----------------------------------------------------------------------------------------------------------*/
 
+    public Long getTimestamp() {
+        return timestamp;
+    }
+
+    public void setTimestamp(Long timestamp) {
+        this.timestamp = timestamp;
+    }
+
+    public String getSenderIdentifier() {
+        return senderIdentifier;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public void setSenderIdentifier(String senderIdentifier) {
+        this.senderIdentifier = senderIdentifier;
+    }
+
+    public void setMessage(String message) {
+        this.message = message;
+    }
 }

src/main/java/cz/foresttech/forestredis/shared/models/RedisConfiguration.java

@@ -15,6 +15,17 @@ public class RedisConfiguration {
     private final String password;
     private final boolean ssl;
 
+    /*----------------------------------------------------------------------------------------------------------*/
+
+    /**
+     * Constructs the instance of the object
+     *
+     * @param hostName Hostname of the Redis server
+     * @param port     Port of the Redis server
+     * @param username Username used to connect to Redis server (can be null)
+     * @param password Password used to connect to Redis server (can be null)
+     * @param ssl      Whether to make the connection with SSL
+     */
     public RedisConfiguration(String hostName, int port, String username, String password, boolean ssl) {
         this.hostName = hostName;
         this.port = port;
@@ -36,10 +47,14 @@ public JedisPool build() {
             return null;
         }
 
-        if (this.username == null) {
-            return new JedisPool(new JedisPoolConfig(), this.hostName, this.port, Protocol.DEFAULT_TIMEOUT, this.password, this.ssl);
+        try {
+            if (this.username == null) {
+                return new JedisPool(new JedisPoolConfig(), this.hostName, this.port, Protocol.DEFAULT_TIMEOUT, this.password, this.ssl);
+            }
+            return new JedisPool(new JedisPoolConfig(), this.hostName, this.port, Protocol.DEFAULT_TIMEOUT, this.username, this.password, this.ssl);
+        } catch (Exception exception) {
+            return null;
         }
-        return new JedisPool(new JedisPoolConfig(), this.hostName, this.port, Protocol.DEFAULT_TIMEOUT, this.username, this.password, this.ssl);
     }
 
     /*----------------------------------------------------------------------------------------------------------*/