make client classes internal (#888)

* make client classes internal

* updated changelog

Author: mhowlett

CHANGELOG.md

@@ -1,5 +1,10 @@
 # 1.0.0-RC5
 
+## New Features
+
+- Added DependentAdminClientBuilder class.
+
+
 ## Changes
 
 - Reverted RC4 changes.
@@ -9,6 +14,7 @@
 - Removed IAsyncDeserializer setter overloads from the ConsumerBuilder class.
 - Renamed Producer.BeginProduce to Producer.Produce.
 - Produce throws an exception if used when async serializers are configured.
+- Made AdminClient, Producer, and Consumer classes internal.
 
 
 # 1.0.0-RC4

src/Confluent.Kafka/AdminClient.cs

@@ -30,7 +30,7 @@ namespace Confluent.Kafka
     /// <summary>
     ///     Implements an Apache Kafka admin client.
     /// </summary>
-    public class AdminClient : IAdminClient
+    internal class AdminClient : IAdminClient
     {
         private int cancellationDelayMaxMs;
 
@@ -425,7 +425,7 @@ private SafeKafkaHandle kafkaHandle
         ///     make broker requests. It is valid to provide either a Consumer, Producer
         ///     or AdminClient handle.
         /// </param>
-        public AdminClient(Handle handle)
+        internal AdminClient(Handle handle)
         {                            
             this.ownedClient = null;
             this.handle = handle;

src/Confluent.Kafka/AdminClientBuilder.cs

@@ -21,7 +21,7 @@
 namespace Confluent.Kafka
 {
     /// <summary>
-    ///     A builder for <see cref="AdminClient" /> instances.
+    ///     A builder for <see cref="IAdminClient" />.
     /// </summary>
     public class AdminClientBuilder
     {
@@ -33,17 +33,17 @@ public class AdminClientBuilder
         /// <summary>
         ///     The configured error handler.
         /// </summary>
-        internal protected Action<AdminClient, Error> ErrorHandler { get; set; }
+        internal protected Action<IAdminClient, Error> ErrorHandler { get; set; }
 
         /// <summary>
         ///     The configured log handler.
         /// </summary>
-        internal protected Action<AdminClient, LogMessage> LogHandler { get; set; }
+        internal protected Action<IAdminClient, LogMessage> LogHandler { get; set; }
 
         /// <summary>
         ///     The configured statistics handler.
         /// </summary>
-        internal protected Action<AdminClient, string> StatisticsHandler { get; set; }
+        internal protected Action<IAdminClient, string> StatisticsHandler { get; set; }
 
         /// <summary>
         ///     Initialize a new <see cref="AdminClientBuilder" /> instance.
@@ -73,7 +73,7 @@ public AdminClientBuilder(IEnumerable<KeyValuePair<string, string>> config)
         ///     Executes on the poll thread (a background thread managed by
         ///     the admin client).
         /// </remarks>
-        public AdminClientBuilder SetStatisticsHandler(Action<AdminClient, string> statisticsHandler)
+        public AdminClientBuilder SetStatisticsHandler(Action<IAdminClient, string> statisticsHandler)
         {
             if (this.StatisticsHandler != null)
             {
@@ -93,7 +93,7 @@ public AdminClientBuilder SetStatisticsHandler(Action<AdminClient, string> stati
         ///     Executes on the poll thread (a background thread managed by the admin
         ///     client).
         /// </remarks>
-        public AdminClientBuilder SetErrorHandler(Action<AdminClient, Error> errorHandler)
+        public AdminClientBuilder SetErrorHandler(Action<IAdminClient, Error> errorHandler)
         {
             if (this.ErrorHandler != null)
             {
@@ -119,7 +119,7 @@ public AdminClientBuilder SetErrorHandler(Action<AdminClient, Error> errorHandle
         ///     Confluent.Kafka APIs from within a log handler or perform any
         ///     prolonged operations.
         /// </remarks>
-        public AdminClientBuilder SetLogHandler(Action<AdminClient, LogMessage> logHandler)
+        public AdminClientBuilder SetLogHandler(Action<IAdminClient, LogMessage> logHandler)
         {
             if (this.LogHandler != null)
             {

src/Confluent.Kafka/Consumer.cs

@@ -32,7 +32,7 @@ namespace Confluent.Kafka
     ///     Implements a high-level Apache Kafka consumer with
     ///     deserialization capability.
     /// </summary>
-    public class Consumer<TKey, TValue> : IConsumer<TKey, TValue>, IClient
+    internal class Consumer<TKey, TValue> : IConsumer<TKey, TValue>, IClient
     {
         internal class Config
         {

src/Confluent.Kafka/ConsumerBuilder.cs

@@ -27,7 +27,7 @@
 namespace Confluent.Kafka
 {
     /// <summary>
-    ///     A builder class for <see cref="Consumer{TKey,TValue}" /> instances.
+    ///     A builder class for <see cref="IConsumer{TKey,TValue}" />.
     /// </summary>
     public class ConsumerBuilder<TKey, TValue>
     {
@@ -353,7 +353,7 @@ public ConsumerBuilder<TKey, TValue> SetOffsetsCommittedHandler(Action<IConsumer
         }
 
         /// <summary>
-        ///     Build a new Consumer instance.
+        ///     Build a new IConsumer implementation instance.
         /// </summary>
         public virtual IConsumer<TKey, TValue> Build()
         {

src/Confluent.Kafka/DependentAdminClientBuilder.cs

@@ -0,0 +1,50 @@
+// Copyright 2019 Confluent Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Refer to LICENSE for more information.
+
+using System;
+using System.Collections.Generic;
+
+
+namespace Confluent.Kafka
+{
+    /// <summary>
+    ///     A builder class for <see cref="IAdminClient" /> instance
+    ///     implementations that leverage an existing client handle.
+    /// </summary>
+    public class DependentAdminClientBuilder
+    {
+        /// <summary>
+        ///     The configured client handle.
+        /// </summary>
+        public Handle Handle { get; set; }
+        
+        /// <summary>
+        ///     An underlying librdkafka client handle that the AdminClient.
+        /// </summary>
+        public DependentAdminClientBuilder(Handle handle)
+        {
+            this.Handle = handle;
+        }
+
+        /// <summary>
+        ///     Build a new IAdminClient implementation instance.
+        /// </summary>
+        public virtual IAdminClient Build()
+        {
+            return new AdminClient(this.Handle);
+        }
+    }
+}

src/Confluent.Kafka/DependentProducerBuilder.cs

@@ -21,8 +21,8 @@
 namespace Confluent.Kafka
 {
     /// <summary>
-    ///     A builder class for <see cref="Producer{TKey, TValue}" /> instances
-    ///     that leverage an existing client handle.
+    ///     A builder class for <see cref="IProducer{TKey, TValue}" /> instance
+    ///     implementations that leverage an existing client handle.
     /// </summary>
     public class DependentProducerBuilder<TKey, TValue>
     {
@@ -99,7 +99,7 @@ public DependentProducerBuilder<TKey, TValue> SetValueSerializer(IAsyncSerialize
         }
 
         /// <summary>
-        ///     Build a new Producer instance.
+        ///     Build a new IProducer implementation instance.
         /// </summary>
         public virtual IProducer<TKey, TValue> Build()
         {

src/Confluent.Kafka/Producer.cs

@@ -29,7 +29,7 @@ namespace Confluent.Kafka
     /// <summary>
     ///     A high level producer with serialization capability.
     /// </summary>
-    public class Producer<TKey, TValue> : IProducer<TKey, TValue>, IClient
+    internal class Producer<TKey, TValue> : IProducer<TKey, TValue>, IClient
     {
         internal class Config
         {

src/Confluent.Kafka/ProducerBuilder.cs

@@ -21,7 +21,7 @@
 namespace Confluent.Kafka
 {
     /// <summary>
-    ///     A builder class for <see cref="Producer{TKey, TValue}" /> instances.
+    ///     A builder class for <see cref="IProducer{TKey,TValue}" />.
     /// </summary>
     public class ProducerBuilder<TKey, TValue>
     {
@@ -217,7 +217,7 @@ public ProducerBuilder<TKey, TValue> SetValueSerializer(IAsyncSerializer<TValue>
         }
 
         /// <summary>
-        ///     Build a new Producer instance.
+        ///     Build a new IProducer implementation instance.
         /// </summary>
         public virtual IProducer<TKey, TValue> Build()
         {

test/Confluent.Kafka.IntegrationTests/Tests/AddBroker.cs

@@ -38,7 +38,7 @@ public void AddBrokers(string bootstrapServers)
             var producerConfig = new ProducerConfig { BootstrapServers = "localhost:65533" };
 
             using (var producer = new ProducerBuilder<Null, string>(producerConfig).Build())
-            using (var adminClient = new AdminClient(producer.Handle))
+            using (var adminClient = new DependentAdminClientBuilder(producer.Handle).Build())
             {
                 try
                 {