Add javadocs

Author: ST-DDT

examples/cloud-eureka-server/src/main/java/net/devh/boot/grpc/examples/cloud/server/EurekaServerApplication.java

@@ -21,11 +21,19 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
 
+/**
+ * Eureka cloud discovery server application.
+ */
 @EnableEurekaServer
 @SpringBootApplication
 public class EurekaServerApplication {
 
-    public static void main(String[] args) {
+    /**
+     * Starts the Eureka cloud discovery server application.
+     *
+     * @param args The arguments to pass to the application.
+     */
+    public static void main(final String... args) {
         SpringApplication.run(EurekaServerApplication.class, args);
     }
 

examples/cloud-grpc-client/src/main/java/net/devh/boot/grpc/examples/cloud/client/CloudClientApplication.java

@@ -21,10 +21,18 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
 
+/**
+ * Example grpc client application using cloud discovery.
+ */
 @EnableDiscoveryClient
 @SpringBootApplication
 public class CloudClientApplication {
 
+    /**
+     * Starts the grpc cloud discovery client application.
+     *
+     * @param args The arguments to pass to the application.
+     */
     public static void main(final String... args) {
         SpringApplication.run(CloudClientApplication.class, args);
     }

examples/cloud-grpc-client/src/main/java/net/devh/boot/grpc/examples/cloud/client/GlobalClientInterceptorConfiguration.java renamed to examples/cloud-grpc-client/src/main/java/net/devh/boot/grpc/examples/cloud/client/GlobalInterceptorConfiguration.java

@@ -18,15 +18,23 @@
 package net.devh.boot.grpc.examples.cloud.client;
 
 import org.springframework.context.annotation.Configuration;
-import org.springframework.core.Ordered;
-import org.springframework.core.annotation.Order;
 
+import io.grpc.ClientInterceptor;
 import net.devh.boot.grpc.client.interceptor.GrpcGlobalClientInterceptor;
 
-@Order(Ordered.LOWEST_PRECEDENCE)
+/**
+ * Example configuration class that adds a {@link ClientInterceptor} to the global interceptor list.
+ */
 @Configuration(proxyBeanMethods = false)
-public class GlobalClientInterceptorConfiguration {
+public class GlobalInterceptorConfiguration {
 
+    /**
+     * Creates a new {@link LogGrpcInterceptor} bean and adds it to the global interceptor list. As an alternative you
+     * can directly annotate the {@code LogGrpcInterceptor} class and it will automatically be picked up by spring's
+     * classpath scanning.
+     *
+     * @return The newly created bean.
+     */
     @GrpcGlobalClientInterceptor
     LogGrpcInterceptor logClientInterceptor() {
         return new LogGrpcInterceptor();

examples/cloud-grpc-client/src/main/java/net/devh/boot/grpc/examples/cloud/client/GrpcClientController.java

@@ -23,7 +23,7 @@
 import org.springframework.web.bind.annotation.RestController;
 
 /**
- * Optional demo controller making the grpc service accessible via browser.
+ * Optional demo controller making the grpc service accessible via browser requests.
  */
 @RestController
 public class GrpcClientController {

examples/cloud-grpc-client/src/main/java/net/devh/boot/grpc/examples/cloud/client/GrpcClientService.java

@@ -26,6 +26,9 @@
 import net.devh.boot.grpc.examples.lib.HelloRequest;
 import net.devh.boot.grpc.examples.lib.SimpleGrpc.SimpleBlockingStub;
 
+/**
+ * Example class demonstrating the usage of {@link GrpcClient}s inside an application.
+ */
 @Service
 @Slf4j
 public class GrpcClientService {

examples/cloud-grpc-client/src/main/java/net/devh/boot/grpc/examples/cloud/client/LogGrpcInterceptor.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2016-2021 Michael Zhang <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package net.devh.boot.grpc.examples.cloud.client;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.grpc.CallOptions;
+import io.grpc.Channel;
+import io.grpc.ClientCall;
+import io.grpc.ClientInterceptor;
+import io.grpc.MethodDescriptor;
+import net.devh.boot.grpc.client.interceptor.GrpcGlobalClientInterceptor;
+
+/**
+ * Example {@link ClientInterceptor} that logs all called methods. In this example it is added to Spring's application
+ * context via {@link GlobalInterceptorConfiguration}, but is also possible to directly annotate this class with
+ * {@link GrpcGlobalClientInterceptor}.
+ */
+// @GrpcGlobalClientInterceptor
+public class LogGrpcInterceptor implements ClientInterceptor {
+
+    private static final Logger log = LoggerFactory.getLogger(LogGrpcInterceptor.class);
+
+    @Override
+    public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(
+            final MethodDescriptor<ReqT, RespT> method,
+            final CallOptions callOptions,
+            final Channel next) {
+
+        log.info(method.getFullMethodName());
+        return next.newCall(method, callOptions);
+    }
+
+}

examples/cloud-grpc-server/src/main/java/net/devh/boot/grpc/examples/cloud/server/CloudServerApplication.java

@@ -21,10 +21,18 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
 
+/**
+ * Example grpc service application supporting cloud discovery.
+ */
 @EnableDiscoveryClient
 @SpringBootApplication
 public class CloudServerApplication {
 
+    /**
+     * Starts the grpc cloud server application.
+     *
+     * @param args The arguments to pass to the application.
+     */
     public static void main(final String... args) {
         SpringApplication.run(CloudServerApplication.class, args);
     }

examples/cloud-grpc-server/src/main/java/net/devh/boot/grpc/examples/cloud/server/GlobalInterceptorConfiguration.java

@@ -19,11 +19,22 @@
 
 import org.springframework.context.annotation.Configuration;
 
+import io.grpc.ServerInterceptor;
 import net.devh.boot.grpc.server.interceptor.GrpcGlobalServerInterceptor;
 
+/**
+ * Example configuration class that adds a {@link ServerInterceptor} to the global interceptor list.
+ */
 @Configuration(proxyBeanMethods = false)
 public class GlobalInterceptorConfiguration {
 
+    /**
+     * Creates a new {@link LogGrpcInterceptor} bean and adds it to the global interceptor list. As an alternative you
+     * can directly annotate the {@code LogGrpcInterceptor} class and it will automatically be picked up by spring's
+     * classpath scanning.
+     *
+     * @return The newly created bean.
+     */
     @GrpcGlobalServerInterceptor
     LogGrpcInterceptor logServerInterceptor() {
         return new LogGrpcInterceptor();

examples/cloud-grpc-server/src/main/java/net/devh/boot/grpc/examples/cloud/server/GrpcServerService.java

@@ -23,6 +23,9 @@
 import net.devh.boot.grpc.examples.lib.SimpleGrpc;
 import net.devh.boot.grpc.server.service.GrpcService;
 
+/**
+ * Example grpc server service implementation class.
+ */
 @GrpcService
 public class GrpcServerService extends SimpleGrpc.SimpleImplBase {
 

examples/cloud-grpc-server/src/main/java/net/devh/boot/grpc/examples/cloud/server/LogGrpcInterceptor.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2016-2021 Michael Zhang <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package net.devh.boot.grpc.examples.cloud.server;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.grpc.Metadata;
+import io.grpc.ServerCall;
+import io.grpc.ServerCallHandler;
+import io.grpc.ServerInterceptor;
+import net.devh.boot.grpc.server.interceptor.GrpcGlobalServerInterceptor;
+
+/**
+ * Example {@link ServerInterceptor} that logs all called methods. In this example it is added to Spring's application
+ * context via {@link GlobalInterceptorConfiguration}, but is also possible to directly annotate this class with
+ * {@link GrpcGlobalServerInterceptor}.
+ */
+// @GrpcGlobalServerInterceptor
+public class LogGrpcInterceptor implements ServerInterceptor {
+
+    private static final Logger log = LoggerFactory.getLogger(LogGrpcInterceptor.class);
+
+    @Override
+    public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(
+            ServerCall<ReqT, RespT> serverCall,
+            Metadata metadata,
+            ServerCallHandler<ReqT, RespT> serverCallHandler) {
+
+        log.info(serverCall.getMethodDescriptor().getFullMethodName());
+        return serverCallHandler.startCall(serverCall, metadata);
+    }
+
+}