Adapt BindableService in ServerBuilder#addService

Makes binding services to server as simple as it can get.

Author: lukaszx0

benchmarks/src/generated/main/grpc/io/grpc/benchmarks/proto/BenchmarkServiceGrpc.java

@@ -157,7 +157,7 @@ public com.google.common.util.concurrent.ListenableFuture<io.grpc.benchmarks.pro
     }
   }
 
-  public static abstract class AbstractBenchmarkService implements BenchmarkService, io.grpc.stub.BindableService {
+  public static abstract class AbstractBenchmarkService implements BenchmarkService, io.grpc.BindableService {
     @Override public io.grpc.ServerServiceDefinition bindService() {
       return BenchmarkServiceGrpc.bindService(this);
     }

benchmarks/src/generated/main/grpc/io/grpc/benchmarks/proto/WorkerServiceGrpc.java

@@ -213,7 +213,7 @@ public com.google.common.util.concurrent.ListenableFuture<io.grpc.benchmarks.pro
     }
   }
 
-  public static abstract class AbstractWorkerService implements WorkerService, io.grpc.stub.BindableService {
+  public static abstract class AbstractWorkerService implements WorkerService, io.grpc.BindableService {
     @Override public io.grpc.ServerServiceDefinition bindService() {
       return WorkerServiceGrpc.bindService(this);
     }

compiler/src/java_plugin/cpp/java_generator.cpp

@@ -776,7 +776,7 @@ void GenerateService(const ServiceDescriptor* service,
   vars["MethodType"] = "io.grpc.MethodDescriptor.MethodType";
   vars["ServerMethodDefinition"] =
       "io.grpc.ServerMethodDefinition";
-  vars["BindableService"] = "io.grpc.stub.BindableService";
+  vars["BindableService"] = "io.grpc.BindableService";
   vars["ServerServiceDefinition"] =
       "io.grpc.ServerServiceDefinition";
   vars["AbstractStub"] = "io.grpc.stub.AbstractStub";

compiler/src/test/golden/TestService.java.txt

@@ -224,7 +224,7 @@ public class TestServiceGrpc {
     }
   }
 
-  public static abstract class AbstractTestService implements TestService, io.grpc.stub.BindableService {
+  public static abstract class AbstractTestService implements TestService, io.grpc.BindableService {
     @Override public io.grpc.ServerServiceDefinition bindService() {
       return TestServiceGrpc.bindService(this);
     }

compiler/src/testLite/golden/TestService.java.txt

@@ -224,7 +224,7 @@ public class TestServiceGrpc {
     }
   }
 
-  public static abstract class AbstractTestService implements TestService, io.grpc.stub.BindableService {
+  public static abstract class AbstractTestService implements TestService, io.grpc.BindableService {
     @Override public io.grpc.ServerServiceDefinition bindService() {
       return TestServiceGrpc.bindService(this);
     }

compiler/src/testNano/golden/TestService.java.txt

@@ -302,7 +302,7 @@ public class TestServiceGrpc {
     }
   }
 
-  public static abstract class AbstractTestService implements TestService, io.grpc.stub.BindableService {
+  public static abstract class AbstractTestService implements TestService, io.grpc.BindableService {
     @Override public io.grpc.ServerServiceDefinition bindService() {
       return TestServiceGrpc.bindService(this);
     }

…n/java/io/grpc/stub/BindableService.java …c/main/java/io/grpc/BindableService.javastub/src/main/java/io/grpc/stub/BindableService.java renamed to core/src/main/java/io/grpc/BindableService.java stub/src/main/java/io/grpc/stub/BindableService.java renamed to core/src/main/java/io/grpc/BindableService.java

@@ -29,24 +29,22 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package io.grpc.stub;
-
-import io.grpc.ExperimentalApi;
-import io.grpc.ServerServiceDefinition;
+package io.grpc;
 
 /**
  * Provides a way to bind instance of service implementation to server.
  *
- * <p>Enables dynamic creation of {@link ServerServiceDefinition} when exact type of service class
- * is unknown.
+ * <p>It is used by service's abstract class generated by compiler (eg.:
+ * RouteGuideGrpc.AbstractRouteGuide for RouteGuide service) and lets implementation classes to be
+ * bind to server.
  *
- * <pre><code>Class<? extends BindableService> service = ...;
- * ServerBuilder.forPort(...).addService(service.newInstance().bindService());
- * </code></pre></p>
+ * <pre><code>
+ * class RouteGuideService extends RouteGuideGrpc.AbstractRouteGuide {
+ *   // ...
+ * }
  *
- * <p>It is used by service's abstract class generated by compiler (eg.:
- * RouteGuideGrpc.AbstractRouteGuide for RouteGuide service). Service implementation classes which
- * want to be "dynamically" bind should inherit from this base class.</p>
+ * Server server = ServerBuilder.forPort(1234).addService(new RouteGuideService()).build();
+ * </code></pre></p>
  */
 @ExperimentalApi
 public interface BindableService {

core/src/main/java/io/grpc/ServerBuilder.java

@@ -74,11 +74,22 @@ public static ServerBuilder<?> forPort(int port) {
   /**
    * Adds a service implementation to the handler registry.
    *
+   * @param service ServerServiceDefinition object
    * @throws UnsupportedOperationException if this builder does not support dynamically adding
    *                                       services.
    */
   public abstract T addService(ServerServiceDefinition service);
 
+  /**
+   * Adds a service implementation to the handler registry.
+   *
+   * @param bindableService BindableService object
+   * @throws UnsupportedOperationException if this builder does not support dynamically adding
+   *     services.
+   */
+  @ExperimentalApi
+  public abstract T addService(BindableService bindableService);
+
   /**
    * Makes the server use TLS.
    *

core/src/main/java/io/grpc/ServerInterceptors.java

@@ -61,6 +61,12 @@ public static ServerServiceDefinition interceptForward(ServerServiceDefinition s
     return interceptForward(serviceDef, Arrays.asList(interceptors));
   }
 
+  @ExperimentalApi
+  public static ServerServiceDefinition interceptForward(BindableService bindableService,
+      ServerInterceptor... interceptors) {
+    return interceptForward(bindableService.bindService(), Arrays.asList(interceptors));
+  }
+
   /**
    * Create a new {@code ServerServiceDefinition} whose {@link ServerCallHandler}s will call
    * {@code interceptors} before calling the pre-existing {@code ServerCallHandler}. The first
@@ -92,6 +98,12 @@ public static ServerServiceDefinition intercept(ServerServiceDefinition serviceD
     return intercept(serviceDef, Arrays.asList(interceptors));
   }
 
+  @ExperimentalApi
+  public static ServerServiceDefinition intercept(BindableService bindableService,
+      ServerInterceptor... interceptors) {
+    return intercept(bindableService.bindService(), Arrays.asList(interceptors));
+  }
+
   /**
    * Create a new {@code ServerServiceDefinition} whose {@link ServerCallHandler}s will call
    * {@code interceptors} before calling the pre-existing {@code ServerCallHandler}. The last

core/src/main/java/io/grpc/internal/AbstractServerImplBuilder.java

@@ -36,6 +36,7 @@
 import com.google.common.base.Preconditions;
 import com.google.common.util.concurrent.MoreExecutors;
 
+import io.grpc.BindableService;
 import io.grpc.CompressorRegistry;
 import io.grpc.Context;
 import io.grpc.DecompressorRegistry;
@@ -98,6 +99,8 @@ public final T executor(@Nullable Executor executor) {
    *
    * <p>This is supported only if the user didn't provide a handler registry, or the provided one is
    * a {@link MutableHandlerRegistry}. Otherwise it throws an UnsupportedOperationException.
+   *
+   * @param service ServerServiceDefinition object.
    */
   @Override
   public final T addService(ServerServiceDefinition service) {
@@ -108,6 +111,19 @@ public final T addService(ServerServiceDefinition service) {
     throw new UnsupportedOperationException("Underlying HandlerRegistry is not mutable");
   }
 
+  /**
+   * Adds a service implementation to the handler registry.
+   *
+   * <p>This is supported only if the user didn't provide a handler registry, or the provided one is
+   * a {@link MutableHandlerRegistry}. Otherwise it throws an UnsupportedOperationException.
+   *
+   * @param bindableService BindableService object.
+   */
+  @Override
+  public final T addService(BindableService bindableService) {
+    return addService(bindableService.bindService());
+  }
+
   @Override
   public final T decompressorRegistry(DecompressorRegistry registry) {
     decompressorRegistry = registry;