Merge branch 'master' into feature/more-call-credential-helpers

Author: ST-DDT

docs/en/client/configuration.md

@@ -11,6 +11,7 @@ This section describes how you can configure your grpc-spring-boot-starter clien
 - [Configuration via Beans](#configuration-via-beans)
   - [GrpcChannelConfigurer](#grpcchannelconfigurer)
   - [ClientInterceptor](#clientinterceptor)
+  - [StubFactory](#stubfactory)
   - [StubTransformer](#stubtransformer)
 
 ## Additional Topics <!-- omit in toc -->
@@ -132,6 +133,45 @@ There are three ways to add a `ClientInterceptor` to your channel.
 - Explicitly list them in the `@GrpcClient#interceptors` or `@GrpcClient#interceptorNames` field
 - Use a `StubTransformer` and call `stub.withInterceptors(ClientInterceptor... interceptors)`
 
+### StubFactory
+
+A `StubFactory` is used to create a `Stub` of a specific type. The registered stub factories will be checked in order
+and the first applicable factory will be used to create the stub.
+
+This library has build in support for the `Stub` types defined in grpc-java:
+
+- [`AsyncStubs`](https://grpc.github.io/grpc-java/javadoc/io/grpc/stub/AbstractAsyncStub.html)
+- [`BlockingStubs`](https://grpc.github.io/grpc-java/javadoc/io/grpc/stub/AbstractBlockingStub.html)
+- [`FutureStubs`](https://grpc.github.io/grpc-java/javadoc/io/grpc/stub/AbstractFutureStub.html)
+
+But you can easily add support for other `Stub` types by adding a custom `StubFactory` to your application context.
+
+````java
+@Component
+public class MyCustomStubFactory implements StubFactory {
+
+    @Override
+    public MyCustomStub<?> createStub(Class<? extends AbstractStub<?>> stubType, Channel channel) {
+        try {
+            Class<?> enclosingClass = stubType.getEnclosingClass();
+            Method factoryMethod = enclosingClass.getMethod("newMyBetterFutureStub", Channel.class);
+            return stubType.cast(factoryMethod.invoke(null, channel));
+        } catch (Exception e) {
+            throw new BeanInstantiationException(stubType, "Failed to create gRPC stub", e);
+        }
+    }
+
+    @Override
+    public boolean isApplicable(Class<? extends AbstractStub<?>> stubType) {
+        return AbstractMyCustomStub.class.isAssignableFrom(stubType);
+    }
+
+}
+````
+
+> **Note:** Please report missing stub types (and the corresponding library) in our issue tracker so that we can add
+> support if possible.
+
 ### StubTransformer
 
 The stub transformer allows you to modify `Stub`s right before they are injected to your beans.

docs/en/client/getting-started.md

@@ -126,6 +126,9 @@ This section assumes that you have already defined and generated your [Protobuf
   automatically attach it to all `Stub`s (**NOT** `Channel`s). The
   [`CallCredentialsHelper`](https://javadoc.io/page/net.devh/grpc-client-spring-boot-autoconfigure/latest/net/devh/boot/grpc/client/security/CallCredentialsHelper.html)
   utility class helps you to create commonly used `CallCredentials` types and related `StubTransformer`.
+- [`StubFactory`](https://javadoc.io/page/net.devh/grpc-client-spring-boot-autoconfigure/latest/net/devh/boot/grpc/client/stubfactory/StubFactory.html):
+  A factory that can be used to create a specfic `Stub` type from a `Channel`. Multiple `StubFactory`s can be registered to support different stub types.
+  See also [Configuration -> StubFactory](configuration.md#stubfactory).
 - [`StubTransformer`](https://javadoc.io/page/net.devh/grpc-client-spring-boot-autoconfigure/latest/net/devh/boot/grpc/client/inject/StubTransformer.html):
   A transformer that will be applied to all client `Stub`s before they are injected.
   See also [Configuration -> StubTransformer](configuration.md#stubtransformer).

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

@@ -25,7 +25,7 @@
 import net.devh.boot.grpc.client.interceptor.GlobalClientInterceptorConfigurer;
 
 @Order(Ordered.LOWEST_PRECEDENCE)
-@Configuration
+@Configuration(proxyBeanMethods = false)
 public class GlobalClientInterceptorConfiguration {
 
     @Bean

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

@@ -22,7 +22,7 @@
 
 import net.devh.boot.grpc.server.interceptor.GlobalServerInterceptorConfigurer;
 
-@Configuration
+@Configuration(proxyBeanMethods = false)
 public class GlobalInterceptorConfiguration {
 
     @Bean

examples/local-grpc-client/src/main/java/net/devh/boot/grpc/examples/local/client/GlobalClientInterceptorConfiguration.java

@@ -25,7 +25,7 @@
 import net.devh.boot.grpc.client.interceptor.GlobalClientInterceptorConfigurer;
 
 @Order(Ordered.LOWEST_PRECEDENCE)
-@Configuration
+@Configuration(proxyBeanMethods = false)
 public class GlobalClientInterceptorConfiguration {
 
     @Bean

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

@@ -23,7 +23,7 @@
 import net.devh.boot.grpc.server.interceptor.GlobalServerInterceptorConfigurer;
 import net.devh.boot.grpc.server.interceptor.GlobalServerInterceptorRegistry;
 
-@Configuration
+@Configuration(proxyBeanMethods = false)
 public class GlobalInterceptorConfiguration {
 
     @Bean

examples/security-grpc-bearerAuth-client/src/main/java/net/devh/boot/grpc/examples/security/client/SecurityConfiguration.java

@@ -28,7 +28,7 @@
  *
  * @author Gregor Eeckels ([email protected])
  */
-@Configuration
+@Configuration(proxyBeanMethods = false)
 public class SecurityConfiguration {
 
     // This token will usually be created by a login endpoint (e.g. from Keycloak).

examples/security-grpc-bearerAuth-server/src/main/java/net/devh/boot/grpc/examples/security/server/SecurityConfiguration.java

@@ -40,7 +40,7 @@
  *
  * @author Gregor Eeckels ([email protected])
  */
-@Configuration
+@Configuration(proxyBeanMethods = false)
 // proxyTargetClass is required, if you use annotation driven security!
 // However, you will receive a warning that GrpcServerService#bindService() method is final.
 // You cannot avoid that warning (without massive amount of work), but it is safe to ignore it.
@@ -51,9 +51,11 @@
 public class SecurityConfiguration {
 
     @Bean
-    JwtAuthenticationConverter jwtAuthenticationConverter() {
+    JwtAuthenticationConverter jwtAuthenticationConverter(
+            final KeyCloakGrantedAuthoritiesConverter keyCloakGrantedAuthoritiesConverter) {
+
         final JwtAuthenticationConverter converter = new JwtAuthenticationConverter();
-        converter.setJwtGrantedAuthoritiesConverter(keyCloakGrantedAuthoritiesConverter());
+        converter.setJwtGrantedAuthoritiesConverter(keyCloakGrantedAuthoritiesConverter);
         return converter;
     }
 
@@ -63,26 +65,26 @@ KeyCloakGrantedAuthoritiesConverter keyCloakGrantedAuthoritiesConverter() {
     }
 
     @Bean
-    JwtAuthenticationProvider jwtAuthenticationProvider() {
+    JwtAuthenticationProvider jwtAuthenticationProvider(final JwtAuthenticationConverter jwtAuthenticationConverter) {
         final JwtAuthenticationProvider provider = new JwtAuthenticationProvider(jwtDecoder());
-        provider.setJwtAuthenticationConverter(jwtAuthenticationConverter());
+        provider.setJwtAuthenticationConverter(jwtAuthenticationConverter);
         return provider;
     }
 
     @Bean
     /*
      * Add the authentication providers to the manager.
      */
-    AuthenticationManager authenticationManager() {
+    AuthenticationManager authenticationManager(final JwtAuthenticationProvider jwtAuthenticationProvider) {
         final List<AuthenticationProvider> providers = new ArrayList<>();
-        providers.add(jwtAuthenticationProvider());
+        providers.add(jwtAuthenticationProvider);
         return new ProviderManager(providers);
     }
 
     @Bean
     // Configure which authentication types you support.
     GrpcAuthenticationReader authenticationReader() {
-        return new BearerAuthenticationReader(accessToken -> new BearerTokenAuthenticationToken(accessToken));
+        return new BearerAuthenticationReader(BearerTokenAuthenticationToken::new);
     }
 
     @Bean

examples/security-grpc-client/src/main/java/net/devh/boot/grpc/examples/security/client/SecurityConfiguration.java

@@ -32,7 +32,7 @@
  * @author Daniel Theuke ([email protected])
  * @see CallCredentialsHelper
  */
-@Configuration
+@Configuration(proxyBeanMethods = false)
 public class SecurityConfiguration {
 
     @Value("${auth.username}")

examples/security-grpc-server/src/main/java/net/devh/boot/grpc/examples/security/server/SecurityConfiguration.java

@@ -46,7 +46,7 @@
  *
  * @author Daniel Theuke ([email protected])
  */
-@Configuration
+@Configuration(proxyBeanMethods = false)
 // proxyTargetClass is required, if you use annotation driven security!
 // However, you will receive a warning that GrpcServerService#bindService() method is final.
 // You cannot avoid that warning (without massive amount of work), but it is safe to ignore it.
@@ -65,17 +65,17 @@ PasswordEncoder passwordEncoder() {
 
     @Bean
     // This could be your database lookup. There are some complete implementations in spring-security-web.
-    UserDetailsService userDetailsService() {
+    UserDetailsService userDetailsService(final PasswordEncoder passwordEncoder) {
         return username -> {
             log.debug("Searching user: {}", username);
             switch (username) {
                 case "guest": {
-                    return new User(username, passwordEncoder().encode(username + "Password"), Collections.emptyList());
+                    return new User(username, passwordEncoder.encode(username + "Password"), Collections.emptyList());
                 }
                 case "user": {
                     final List<SimpleGrantedAuthority> authorities =
                             Arrays.asList(new SimpleGrantedAuthority("ROLE_GREET"));
-                    return new User(username, passwordEncoder().encode(username + "Password"), authorities);
+                    return new User(username, passwordEncoder.encode(username + "Password"), authorities);
                 }
                 default: {
                     throw new UsernameNotFoundException("Could not find user!");
@@ -87,18 +87,21 @@ UserDetailsService userDetailsService() {
     @Bean
     // One of your authentication providers.
     // They ensure that the credentials are valid and populate the user's authorities.
-    DaoAuthenticationProvider daoAuthenticationProvider() {
+    DaoAuthenticationProvider daoAuthenticationProvider(
+            final UserDetailsService userDetailsService,
+            final PasswordEncoder passwordEncoder) {
+
         final DaoAuthenticationProvider provider = new DaoAuthenticationProvider();
-        provider.setUserDetailsService(userDetailsService());
-        provider.setPasswordEncoder(passwordEncoder());
+        provider.setUserDetailsService(userDetailsService);
+        provider.setPasswordEncoder(passwordEncoder);
         return provider;
     }
 
     @Bean
     // Add the authentication providers to the manager.
-    AuthenticationManager authenticationManager() {
+    AuthenticationManager authenticationManager(final DaoAuthenticationProvider daoAuthenticationProvider) {
         final List<AuthenticationProvider> providers = new ArrayList<>();
-        providers.add(daoAuthenticationProvider());
+        providers.add(daoAuthenticationProvider);
         return new ProviderManager(providers);
     }