Merge pull request #289 from scalecube/feature/issue-283-cluster-codec-artifact-CR1arvy

[CR][287] Feature/issue 283 cluster codec artifact

Author: artem-v

cluster-api/src/main/java/io/scalecube/cluster/Cluster.java

@@ -74,7 +74,7 @@ public interface Cluster {
   <T> Optional<T> metadata();
 
   /**
-   * Returns cluster member metadata by given member with default metadata type.
+   * Returns cluster member metadata by given member.
    *
    * @param member cluster member
    * @return cluster member metadata

cluster-api/src/main/java/io/scalecube/cluster/ClusterConfig.java

@@ -3,6 +3,7 @@
 import io.scalecube.cluster.fdetector.FailureDetectorConfig;
 import io.scalecube.cluster.gossip.GossipConfig;
 import io.scalecube.cluster.membership.MembershipConfig;
+import io.scalecube.cluster.metadata.MetadataCodec;
 import io.scalecube.cluster.metadata.MetadataDecoder;
 import io.scalecube.cluster.metadata.MetadataEncoder;
 import io.scalecube.cluster.transport.api.TransportConfig;
@@ -32,12 +33,13 @@ public final class ClusterConfig implements Cloneable {
 
   private Object metadata;
   private int metadataTimeout = DEFAULT_METADATA_TIMEOUT;
+  private MetadataCodec metadataCodec = MetadataCodec.INSTANCE;
   private MetadataEncoder metadataEncoder = MetadataEncoder.INSTANCE;
   private MetadataDecoder metadataDecoder = MetadataDecoder.INSTANCE;
 
   private String memberAlias;
-  private String memberHost;
-  private Integer memberPort;
+  private String containerHost;
+  private Integer containerPort;
 
   private TransportConfig transportConfig = TransportConfig.defaultConfig();
   private FailureDetectorConfig failureDetectorConfig = FailureDetectorConfig.defaultConfig();
@@ -93,7 +95,7 @@ public <T> T metadata() {
   }
 
   /**
-   * Sets a metadata.
+   * Setter for metadata.
    *
    * @param metadata metadata
    * @return new {@code ClusterConfig} instance
@@ -109,7 +111,7 @@ public int metadataTimeout() {
   }
 
   /**
-   * Sets a metadataTimeout.
+   * Setter for metadataTimeout.
    *
    * @param metadataTimeout metadata timeout
    * @return new {@code ClusterConfig} instance
@@ -120,60 +122,129 @@ public ClusterConfig metadataTimeout(int metadataTimeout) {
     return c;
   }
 
+  public MetadataCodec metadataCodec() {
+    return metadataCodec;
+  }
+
+  /**
+   * Setter for metadataCodec.
+   *
+   * @param metadataCodec metadata codec
+   * @return new {@code ClusterConfig} instance
+   */
+  public ClusterConfig metadataCodec(MetadataCodec metadataCodec) {
+    ClusterConfig c = clone();
+    c.metadataCodec = metadataCodec;
+    return c;
+  }
+
+  /**
+   * Deprecated since {@code 2.4.10} in favor of {@link MetadataCodec}.
+   *
+   * @return metadataEncoder
+   */
+  @Deprecated
   public MetadataEncoder metadataEncoder() {
     return metadataEncoder;
   }
 
   /**
-   * Sets a metadataEncoder.
+   * Setter for metadataEncoder. Deprecated since {@code 2.4.10} in favor of {@link MetadataCodec}.
    *
    * @param metadataEncoder metadata encoder
    * @return new {@code ClusterConfig} instance
    */
+  @Deprecated
   public ClusterConfig metadataEncoder(MetadataEncoder metadataEncoder) {
     ClusterConfig c = clone();
     c.metadataEncoder = metadataEncoder;
     return c;
   }
 
+  /**
+   * Deprecated since {@code 2.4.10} in favor of {@link MetadataCodec}.
+   *
+   * @return metadataDecoder
+   */
+  @Deprecated
   public MetadataDecoder metadataDecoder() {
     return metadataDecoder;
   }
 
   /**
-   * Sets a metadataDecoder.
+   * Setter for metadataDecoder. Deprecated since {@code 2.4.10} in favor of {@link MetadataCodec}.
    *
    * @param metadataDecoder metadata decoder
    * @return new {@code ClusterConfig} instance
    */
+  @Deprecated
   public ClusterConfig metadataDecoder(MetadataDecoder metadataDecoder) {
     ClusterConfig c = clone();
     c.metadataDecoder = metadataDecoder;
     return c;
   }
 
+  /**
+   * Deprecated since {@code 2.4.10} in favor of {@link #containerHost()}.
+   *
+   * @return member host
+   */
+  @Deprecated
   public String memberHost() {
-    return memberHost;
+    return containerHost;
   }
 
   /**
-   * Sets a memberHost.
+   * Deprecated since {@code 2.4.10} in favor of {@link #containerHost(String)}.
    *
    * @param memberHost member host
    * @return new {@code ClusterConfig} instance
    */
+  @Deprecated
   public ClusterConfig memberHost(String memberHost) {
     ClusterConfig c = clone();
-    c.memberHost = memberHost;
+    c.containerHost = memberHost;
     return c;
   }
 
+  /**
+   * Returns mappedHost. {@code mappedHost} is a config property for container environments, it's
+   * being set for advertising to scalecube cluster some connectable hostname which maps to
+   * scalecube transport's hostname on which scalecube transport is listening.
+   *
+   * @return mapped host
+   */
+  public String containerHost() {
+    return containerHost;
+  }
+
+  /**
+   * Setter for mappedHost. {@code mappedHost} is a config property for container environments, it's
+   * being set for advertising to scalecube cluster some connectable hostname which maps to
+   * scalecube transport's hostname on which scalecube transport is listening.
+   *
+   * @param mappedHost mapped host
+   * @return new {@code ClusterConfig} instance
+   */
+  public ClusterConfig containerHost(String mappedHost) {
+    ClusterConfig c = clone();
+    c.containerHost = mappedHost;
+    return c;
+  }
+
+  /**
+   * Returns memberAlias. {@code memberAlias} is a config property which facilitates {@link
+   * io.scalecube.cluster.Member#toString()}.
+   *
+   * @return member alias.
+   */
   public String memberAlias() {
     return memberAlias;
   }
 
   /**
-   * Sets a memberAlias.
+   * Setter for memberAlias. {@code memberAlias} is a config property which facilitates {@link
+   * io.scalecube.cluster.Member#toString()}.
    *
    * @param memberAlias member alias
    * @return new {@code ClusterConfig} instance
@@ -184,19 +255,51 @@ public ClusterConfig memberAlias(String memberAlias) {
     return c;
   }
 
+  /**
+   * Returns mappedPort. {@code mappedPort} is a config property for container environments, it's
+   * being set for advertising to scalecube cluster a port which mapped to scalecube transport's
+   * listening port.
+   *
+   * @return mapped port
+   */
+  public Integer containerPort() {
+    return containerPort;
+  }
+
+  /**
+   * Setter for mappedPort. {@code mappedPort} is a config property for container environments, it's
+   * being set for advertising to scalecube cluster a port which mapped to scalecube transport's
+   * listening port.
+   *
+   * @param mappedPort mapped port
+   * @return new {@code ClusterConfig} instance
+   */
+  public ClusterConfig containerPort(Integer mappedPort) {
+    ClusterConfig c = clone();
+    c.containerPort = mappedPort;
+    return c;
+  }
+
+  /**
+   * Deprecated since {@code 2.4.10} in favor of {@link #containerPort()}.
+   *
+   * @return member port
+   */
+  @Deprecated
   public Integer memberPort() {
-    return memberPort;
+    return containerPort;
   }
 
   /**
-   * Sets a memberPort.
+   * Deprecated since {@code 2.4.10} in favor of {@link #containerPort(Integer)}.
    *
    * @param memberPort member port
    * @return new {@code ClusterConfig} instance
    */
+  @Deprecated
   public ClusterConfig memberPort(Integer memberPort) {
     ClusterConfig c = clone();
-    c.memberPort = memberPort;
+    c.containerPort = memberPort;
     return c;
   }
 
@@ -283,11 +386,12 @@ public String toString() {
     return new StringJoiner(", ", ClusterConfig.class.getSimpleName() + "[", "]")
         .add("metadata=" + metadataAsString())
         .add("metadataTimeout=" + metadataTimeout)
+        .add("metadataCodec=" + metadataCodec)
         .add("metadataEncoder=" + metadataEncoder)
         .add("metadataDecoder=" + metadataDecoder)
         .add("memberAlias='" + memberAlias + "'")
-        .add("memberHost='" + memberHost + "'")
-        .add("memberPort=" + memberPort)
+        .add("containerHost='" + containerHost + "'")
+        .add("containerPort=" + containerPort)
         .add("transportConfig=" + transportConfig)
         .add("failureDetectorConfig=" + failureDetectorConfig)
         .add("gossipConfig=" + gossipConfig)

cluster-api/src/main/java/io/scalecube/cluster/metadata/MetadataCodec.java

@@ -0,0 +1,27 @@
+package io.scalecube.cluster.metadata;
+
+import io.scalecube.utils.ServiceLoaderUtil;
+import java.nio.ByteBuffer;
+
+/** Contains methods for metadata serializing/deserializing logic. */
+public interface MetadataCodec {
+
+  MetadataCodec INSTANCE = ServiceLoaderUtil.findFirst(MetadataCodec.class).orElse(null);
+
+  /**
+   * Deserializes metadata from buffer.
+   *
+   * @param buffer metadata buffer; if {@code buffer} is empty then returned result shall be null.
+   * @return metadata object from metadata buffer or null
+   */
+  Object deserialize(ByteBuffer buffer);
+
+  /**
+   * Serializes given metadata into buffer.
+   *
+   * @param metadata metadata object (optional); if {@code metadata} is null then returned result
+   *     may be null or empty buffer.
+   * @return buffer or null
+   */
+  ByteBuffer serialize(Object metadata);
+}

cluster-api/src/main/java/io/scalecube/cluster/metadata/MetadataDecoder.java

@@ -3,6 +3,11 @@
 import io.scalecube.utils.ServiceLoaderUtil;
 import java.nio.ByteBuffer;
 
+/**
+ * MetadataDecoder. <br>
+ * Deprecated since {@code 2.4.10} in favor of {@link MetadataCodec}.
+ */
+@Deprecated
 @FunctionalInterface
 public interface MetadataDecoder {
 

cluster-api/src/main/java/io/scalecube/cluster/metadata/MetadataEncoder.java

@@ -4,6 +4,11 @@
 import java.nio.ByteBuffer;
 import reactor.util.annotation.Nullable;
 
+/**
+ * MetadataEncoder. <br>
+ * Deprecated since {@code 2.4.10} in favor of {@link MetadataCodec}.
+ */
+@Deprecated
 @FunctionalInterface
 public interface MetadataEncoder {