[#11004] Removed legacy channel api supports

channel/src/main/java/com/navercorp/pinpoint/channel/Channel.java

@@ -17,6 +17,16 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * Channel is publishable channel, and subscribable channel at the same time.
+ * If a pair of PubChannel, and SubChannel are bound in a single channel interface, the two channel
+ * should be able to communicate with each other.
+ * <br>
+ * In most cases, A paired PubChannel, and SubChannel are located at the different side of the network, and
+ * implemented with distributed systems like Redis, Kafka, etc.
+ *
+ * @see PubChannel
+ * @see SubChannel
  */
 public interface Channel extends PubChannel, SubChannel {
 }

channel/src/main/java/com/navercorp/pinpoint/channel/ChannelProvider.java

@@ -17,6 +17,12 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * ChannelProvider provides PubChannel, and SubChannel by the key.
+ * <br>
+ * In distributed system, A pair of PubChannel, and SubChannel are connected each other if they have the same key.
+ * In the other word, even if the two processes are located at the different side of the network, they can communicate
+ * with each other if they have the same key.
  */
 public interface ChannelProvider extends PubChannelProvider, SubChannelProvider {
     static ChannelProvider pair(PubChannelProvider pub, SubChannelProvider sub) {

channel/src/main/java/com/navercorp/pinpoint/channel/ChannelProviderRegistry.java

@@ -19,6 +19,10 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * A pair for registration of ChannelProvider.
+ *
+ * @see ChannelProviderRepository
  */
 public class ChannelProviderRegistry {
 

channel/src/main/java/com/navercorp/pinpoint/channel/ChannelProviderRepository.java

@@ -21,6 +21,19 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * The channels are provided by the URI key with the formats like below:
+ * <br>
+ * <pre>
+ *     scheme://key
+ *     e.g. redis://hello-world-topic?param1=value1&param2=value2
+ *     e.g. kafka://hello-world-topic?param1=value1&param2=value2
+ * </pre>
+ *
+ * If a pair of PubChannel, and SubChannel are obtained by the same key, they can communicate with each other.
+ *
+ * @see ChannelProvider
+ * @see Channel
  */
 public class ChannelProviderRepository {
 

channel/src/main/java/com/navercorp/pinpoint/channel/PubChannel.java

@@ -17,6 +17,11 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * PubChannel publishes the byte array parameter into the connected SubChannel.
+ *
+ * @see Channel
+ * @see SubChannel
  */
 public interface PubChannel {
 

channel/src/main/java/com/navercorp/pinpoint/channel/PubChannelProvider.java

@@ -17,6 +17,10 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * Provides the PubChannel by the key.
+ *
+ * @see ChannelProvider
  */
 public interface PubChannelProvider {
 

channel/src/main/java/com/navercorp/pinpoint/channel/SubChannel.java

@@ -17,6 +17,11 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * SubChannel registers, or de-register the handler for the incoming byte array from PubChannel.
+ *
+ * @see Channel
+ * @see PubChannel
  */
 public interface SubChannel {
 

channel/src/main/java/com/navercorp/pinpoint/channel/SubChannelProvider.java

@@ -17,6 +17,10 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * Provide the SubChannel by the key.
+ *
+ * @see ChannelProvider
  */
 public interface SubChannelProvider {
 

channel/src/main/java/com/navercorp/pinpoint/channel/SubConsumer.java

@@ -17,6 +17,10 @@
 
 /**
  * @author youngjin.kim2
+ *
+ * Handler object for the byte array from SubChannel
+ *
+ * @see SubChannel
  */
 public interface SubConsumer {