codes.sf.springboot.grpc.client

Annotation Type GrpcStubScan

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface GrpcStubScan

Configures gRPC stubs scanning.

Either basePackageClasses() or basePackages() may be specified to define specific packages to scan. If specific packages are not defined, scanning will occur from the package of the class that declares this annotation.

If this annotation is missing, auto configuration will fallback on environment property grpc.client.scanPackages. If the property is missing as well, auto configuration will finally fall back on the values in @ComponentScan.

Since:

0.0.1

See Also:

gRPC Basics - Java, gRPC Java Generated Code Reference

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<?>[]	basePackageClasses Type-safe alternative to basePackages() for specifying the packages to scan for gRPC stubs.
java.lang.String[]	basePackages Base packages to scan for gRPC stubs
java.lang.Class<? extends org.springframework.beans.factory.support.BeanNameGenerator>	nameGenerator The BeanNameGenerator class to be used for naming detected gRPC stubs within the Spring container.
java.lang.String	resourcePattern Controls the class files eligible for gRPC stubs detection.
org.springframework.context.annotation.ScopedProxyMode	scopedProxy Indicates whether proxies should be generated for detected gRPC stubs, which may be necessary when using scopes in a proxy-style fashion.
java.lang.Class<? extends org.springframework.context.annotation.ScopeMetadataResolver>	scopeResolver The ScopeMetadataResolver to be used for resolving the scope of detected gRPC stubs.
java.lang.String[]	value Alias for basePackages().

Element Detail

value

@AliasFor(value="basePackages")
public abstract java.lang.String[] value

Alias for basePackages().

Allows for more concise annotation declarations if no other attributes are needed — for example, @GrpcStubScan("org.my.pkg") instead of @GrpcStubScan(basePackages = "org.my.pkg").

Returns:

packages to scan for gRPC stubs

Default:

{}

basePackages

@AliasFor(value="value")
public abstract java.lang.String[] basePackages

Base packages to scan for gRPC stubs

value() is an alias for (and mutually exclusive with) this attribute.

Use basePackageClasses() for a type-safe alternative to String-based package names.

Returns:

packages to scan for gRPC stubs

Default:

{}

basePackageClasses

public abstract java.lang.Class<?>[] basePackageClasses

Type-safe alternative to basePackages() for specifying the packages to scan for gRPC stubs. The package of each class specified will be scanned.

Consider using this type-safe alternative with the generated stubs' enclosing class. For example @GrpcStubScan(basePackageClasses = "org.my.pkg.grpc.MyServiceGrpc.class")

Returns:

packages to scan for gRPC stubs

Default:

{}

nameGenerator

public abstract java.lang.Class<? extends org.springframework.beans.factory.support.BeanNameGenerator> nameGenerator

The BeanNameGenerator class to be used for naming detected gRPC stubs within the Spring container.

The default value of the BeanNameGenerator interface itself indicates that the scanner used to process this @GrpcStubScan annotation should use its inherited bean name generator, e.g. the default AnnotationBeanNameGenerator or any custom instance supplied to the application context at bootstrap time.

Returns:

class to be used for naming detected gRPC stub beans

See Also:

AnnotationConfigApplicationContext.setBeanNameGenerator(BeanNameGenerator)

Default:

org.springframework.beans.factory.support.BeanNameGenerator.class

scopeResolver

public abstract java.lang.Class<? extends org.springframework.context.annotation.ScopeMetadataResolver> scopeResolver

The ScopeMetadataResolver to be used for resolving the scope of detected gRPC stubs.

Returns:

ScopeMetadataResolver class

Default:

org.springframework.context.annotation.AnnotationScopeMetadataResolver.class

scopedProxy

public abstract org.springframework.context.annotation.ScopedProxyMode scopedProxy

Indicates whether proxies should be generated for detected gRPC stubs, which may be necessary when using scopes in a proxy-style fashion.

The default is defer to the default behavior of the gRPC stub scanner used to execute the actual scan.

Note that setting this attribute overrides any value set for scopeResolver().

Returns:

scoped proxy mode to use with stubs

See Also:

GrpcStubScanner.setScopedProxyMode(ScopedProxyMode)

Default:

org.springframework.context.annotation.ScopedProxyMode.DEFAULT

resourcePattern

public abstract java.lang.String resourcePattern

Controls the class files eligible for gRPC stubs detection.

Returns:

pattern of gRPC classes stubs

Default:

"**/*.class"