io.servicetalk.grpc.api

Class GrpcRoutes<Service extends GrpcService>

Object

GrpcRoutes<Service>

Type Parameters:

Service - Type for service that these routes represent.

public abstract class GrpcRoutes<Service extends GrpcService>
extends Object

A holder of gRPC routes that constitutes a service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	GrpcRoutes.AllGrpcRoutes A collection of route corresponding to the enclosing GrpcRoutes.
protected static interface	GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> A blocking gRPC route with request streaming.
protected static interface	GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> A blocking gRPC route with response streaming.
protected static interface	GrpcRoutes.BlockingRoute<Req,Resp> A blocking gRPC route.
protected static interface	GrpcRoutes.BlockingStreamingRoute<Req,Resp> A blocking gRPC route with bi-directional streaming.
protected static interface	GrpcRoutes.RequestStreamingRoute<Req,Resp> An asynchronous gRPC route with request streaming.
protected static interface	GrpcRoutes.ResponseStreamingRoute<Req,Resp> An asynchronous gRPC route with response streaming.
protected static interface	GrpcRoutes.Route<Req,Resp> An asynchronous gRPC route.
protected static interface	GrpcRoutes.StreamingRoute<Req,Resp> An asynchronous gRPC route with bi-directional streaming.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GrpcRoutes() Create a new instance.
protected	GrpcRoutes(RouteExecutionStrategyFactory<GrpcExecutionStrategy> strategyFactory) Create new instance.

Method Summary

Modifier and Type	Method and Description
protected <Req,Resp> void	addBlockingRequestStreamingRoute(Class<?> serviceClass, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.BlockingRequestStreamingRoute to this factory.
protected <Req,Resp> void	addBlockingRequestStreamingRoute(GrpcExecutionStrategy executionStrategy, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.BlockingRequestStreamingRoute to this factory.
protected <Req,Resp> void	addBlockingRequestStreamingRoute(String path, Class<?> serviceClass, String methodName, GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addBlockingStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, BlockingStreamingRoute).
protected <Req,Resp> void	addBlockingRequestStreamingRoute(String path, GrpcExecutionStrategy executionStrategy, GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addBlockingRequestStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, BlockingRequestStreamingRoute).
protected <Req,Resp> void	addBlockingResponseStreamingRoute(Class<?> serviceClass, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.BlockingResponseStreamingRoute to this factory.
protected <Req,Resp> void	addBlockingResponseStreamingRoute(GrpcExecutionStrategy executionStrategy, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.BlockingResponseStreamingRoute to this factory.
protected <Req,Resp> void	addBlockingResponseStreamingRoute(String path, Class<?> serviceClass, String methodName, GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addBlockingResponseStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, BlockingResponseStreamingRoute).
protected <Req,Resp> void	addBlockingResponseStreamingRoute(String path, GrpcExecutionStrategy executionStrategy, GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addBlockingResponseStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, BlockingResponseStreamingRoute).
protected <Req,Resp> void	addBlockingRoute(Class<?> serviceClass, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.BlockingRoute<Req,Resp> route) Adds a GrpcRoutes.BlockingRoute to this factory.
protected <Req,Resp> void	addBlockingRoute(GrpcExecutionStrategy executionStrategy, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.BlockingRoute<Req,Resp> route) Adds a GrpcRoutes.BlockingRoute to this factory.
protected <Req,Resp> void	addBlockingRoute(String path, Class<?> serviceClass, String methodName, GrpcRoutes.BlockingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addBlockingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, BlockingRoute).
protected <Req,Resp> void	addBlockingRoute(String path, GrpcExecutionStrategy executionStrategy, GrpcRoutes.BlockingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addBlockingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, BlockingRoute).
protected <Req,Resp> void	addBlockingStreamingRoute(Class<?> serviceClass, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.BlockingStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.BlockingStreamingRoute to this factory.
protected <Req,Resp> void	addBlockingStreamingRoute(GrpcExecutionStrategy executionStrategy, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.BlockingStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.BlockingStreamingRoute to this factory.
protected <Req,Resp> void	addBlockingStreamingRoute(String path, Class<?> serviceClass, String methodName, GrpcRoutes.BlockingStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addBlockingStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, BlockingStreamingRoute).
protected <Req,Resp> void	addBlockingStreamingRoute(String path, GrpcExecutionStrategy executionStrategy, GrpcRoutes.BlockingStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addBlockingStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, BlockingStreamingRoute).
protected <Req,Resp> void	addRequestStreamingRoute(Class<?> serviceClass, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.RequestStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.RequestStreamingRoute to this factory.
protected <Req,Resp> void	addRequestStreamingRoute(GrpcExecutionStrategy executionStrategy, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.RequestStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.RequestStreamingRoute to this factory.
protected <Req,Resp> void	addRequestStreamingRoute(String path, Class<?> serviceClass, String methodName, GrpcRoutes.RequestStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addRequestStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, RequestStreamingRoute).
protected <Req,Resp> void	addRequestStreamingRoute(String path, GrpcExecutionStrategy executionStrategy, GrpcRoutes.RequestStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addRequestStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, RequestStreamingRoute).
protected <Req,Resp> void	addResponseStreamingRoute(Class<?> serviceClass, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.ResponseStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.ResponseStreamingRoute to this factory.
protected <Req,Resp> void	addResponseStreamingRoute(GrpcExecutionStrategy executionStrategy, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.ResponseStreamingRoute<Req,Resp> route) Adds a GrpcRoutes.ResponseStreamingRoute to this factory.
protected <Req,Resp> void	addResponseStreamingRoute(String path, Class<?> serviceClass, String methodName, GrpcRoutes.ResponseStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addResponseStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, ResponseStreamingRoute).
protected <Req,Resp> void	addResponseStreamingRoute(String path, GrpcExecutionStrategy executionStrategy, GrpcRoutes.ResponseStreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addResponseStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, ResponseStreamingRoute).
protected <Req,Resp> void	addRoute(Class<?> serviceClass, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.Route<Req,Resp> route) Adds a GrpcRoutes.Route to this factory.
protected <Req,Resp> void	addRoute(GrpcExecutionStrategy executionStrategy, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.Route<Req,Resp> route) Adds a GrpcRoutes.Route to this factory.
protected <Req,Resp> void	addRoute(String path, Class<?> serviceClass, String methodName, GrpcRoutes.Route<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addRoute(Class, MethodDescriptor, BufferDecoderGroup, List, Route).
protected <Req,Resp> void	addRoute(String path, GrpcExecutionStrategy executionStrategy, GrpcRoutes.Route<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, Route).
protected <Req,Resp> void	addStreamingRoute(Class<?> serviceClass, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.StreamingRoute<Req,Resp> route) Adds a GrpcRoutes.StreamingRoute to this factory.
protected <Req,Resp> void	addStreamingRoute(GrpcExecutionStrategy executionStrategy, MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors, List<BufferEncoder> compressors, GrpcRoutes.StreamingRoute<Req,Resp> route) Adds a GrpcRoutes.StreamingRoute to this factory.
protected <Req,Resp> void	addStreamingRoute(String path, Class<?> serviceClass, String methodName, GrpcRoutes.StreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, StreamingRoute).
protected <Req,Resp> void	addStreamingRoute(String path, GrpcExecutionStrategy executionStrategy, GrpcRoutes.StreamingRoute<Req,Resp> route, Class<Req> requestClass, Class<Resp> responseClass, GrpcSerializationProvider serializationProvider) Deprecated. Use addStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, StreamingRoute)
protected abstract Service	newServiceFromRoutes(GrpcRoutes.AllGrpcRoutes routes) Create a new Service from the passed GrpcRoutes.AllGrpcRoutes.
protected abstract void	registerRoutes(Service service) Register all routes contained in the passed Service.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GrpcRoutes

protected GrpcRoutes()

Create a new instance.

GrpcRoutes

protected GrpcRoutes(RouteExecutionStrategyFactory<GrpcExecutionStrategy> strategyFactory)

Create new instance.

Parameters:

strategyFactory - a RouteExecutionStrategyFactory<GrpcExecutionStrategy> for creating GrpcExecutionStrategy instances that can be used for offloading the handling of request to resource methods, as specified via RouteExecutionStrategy annotation

Method Detail

registerRoutes

protected abstract void registerRoutes(Service service)

Register all routes contained in the passed Service.

Parameters:

service - Service for which routes have to be registered.

newServiceFromRoutes

protected abstract Service newServiceFromRoutes(GrpcRoutes.AllGrpcRoutes routes)

Create a new Service from the passed GrpcRoutes.AllGrpcRoutes.

Parameters:

routes - GrpcRoutes.AllGrpcRoutes for which a Service has to be created.

Returns:

Service containing all the passed routes.

addRoute

@Deprecated
protected final <Req,Resp> void addRoute(String path,
                                                     Class<?> serviceClass,
                                                     String methodName,
                                                     GrpcRoutes.Route<Req,Resp> route,
                                                     Class<Req> requestClass,
                                                     Class<Resp> responseClass,
                                                     GrpcSerializationProvider serializationProvider)

Deprecated. Use addRoute(Class, MethodDescriptor, BufferDecoderGroup, List, Route).

Adds a GrpcRoutes.Route to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

serviceClass - Class of the gRPC service.

methodName - the name of gRPC method.

route - GrpcRoutes.Route to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addRoute

protected final <Req,Resp> void addRoute(Class<?> serviceClass,
                                         MethodDescriptor<Req,Resp> methodDescriptor,
                                         BufferDecoderGroup decompressors,
                                         List<BufferEncoder> compressors,
                                         GrpcRoutes.Route<Req,Resp> route)

Adds a GrpcRoutes.Route to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serviceClass - Class of the gRPC service which can be used to extract annotations to override offloading behavior (e.g. NoOffloadsRouteExecutionStrategy, RouteExecutionStrategy).

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to each response.

route - The interface to invoke when data is received for this route.

addRoute

@Deprecated
protected final <Req,Resp> void addRoute(String path,
                                                     GrpcExecutionStrategy executionStrategy,
                                                     GrpcRoutes.Route<Req,Resp> route,
                                                     Class<Req> requestClass,
                                                     Class<Resp> responseClass,
                                                     GrpcSerializationProvider serializationProvider)

Deprecated. Use addRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, Route).

Adds a GrpcRoutes.Route to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

executionStrategy - GrpcExecutionStrategy to use.

route - GrpcRoutes.Route to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addRoute

protected final <Req,Resp> void addRoute(GrpcExecutionStrategy executionStrategy,
                                         MethodDescriptor<Req,Resp> methodDescriptor,
                                         BufferDecoderGroup decompressors,
                                         List<BufferEncoder> compressors,
                                         GrpcRoutes.Route<Req,Resp> route)

Adds a GrpcRoutes.Route to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

executionStrategy - The execution strategy to use for this route.

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to each response.

route - The interface to invoke when data is received for this route.

addStreamingRoute

@Deprecated
protected final <Req,Resp> void addStreamingRoute(String path,
                                                              Class<?> serviceClass,
                                                              String methodName,
                                                              GrpcRoutes.StreamingRoute<Req,Resp> route,
                                                              Class<Req> requestClass,
                                                              Class<Resp> responseClass,
                                                              GrpcSerializationProvider serializationProvider)

Deprecated. Use addStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, StreamingRoute).

Adds a GrpcRoutes.StreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

serviceClass - Class of the gRPC service.

methodName - the name of gRPC method.

route - GrpcRoutes.StreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addStreamingRoute

protected final <Req,Resp> void addStreamingRoute(Class<?> serviceClass,
                                                  MethodDescriptor<Req,Resp> methodDescriptor,
                                                  BufferDecoderGroup decompressors,
                                                  List<BufferEncoder> compressors,
                                                  GrpcRoutes.StreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.StreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serviceClass - Class of the gRPC service which can be used to extract annotations to override offloading behavior (e.g. NoOffloadsRouteExecutionStrategy, RouteExecutionStrategy).

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addStreamingRoute

@Deprecated
protected final <Req,Resp> void addStreamingRoute(String path,
                                                              GrpcExecutionStrategy executionStrategy,
                                                              GrpcRoutes.StreamingRoute<Req,Resp> route,
                                                              Class<Req> requestClass,
                                                              Class<Resp> responseClass,
                                                              GrpcSerializationProvider serializationProvider)

Deprecated. Use addStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, StreamingRoute)

Adds a GrpcRoutes.StreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

executionStrategy - GrpcExecutionStrategy to use.

route - GrpcRoutes.StreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addStreamingRoute

protected final <Req,Resp> void addStreamingRoute(GrpcExecutionStrategy executionStrategy,
                                                  MethodDescriptor<Req,Resp> methodDescriptor,
                                                  BufferDecoderGroup decompressors,
                                                  List<BufferEncoder> compressors,
                                                  GrpcRoutes.StreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.StreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

executionStrategy - The execution strategy to use for this route.

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addRequestStreamingRoute

@Deprecated
protected final <Req,Resp> void addRequestStreamingRoute(String path,
                                                                     Class<?> serviceClass,
                                                                     String methodName,
                                                                     GrpcRoutes.RequestStreamingRoute<Req,Resp> route,
                                                                     Class<Req> requestClass,
                                                                     Class<Resp> responseClass,
                                                                     GrpcSerializationProvider serializationProvider)

Deprecated. Use addRequestStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, RequestStreamingRoute).

Adds a GrpcRoutes.RequestStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

serviceClass - Class of the gRPC service.

methodName - the name of gRPC method.

route - GrpcRoutes.RequestStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addRequestStreamingRoute

protected final <Req,Resp> void addRequestStreamingRoute(Class<?> serviceClass,
                                                         MethodDescriptor<Req,Resp> methodDescriptor,
                                                         BufferDecoderGroup decompressors,
                                                         List<BufferEncoder> compressors,
                                                         GrpcRoutes.RequestStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.RequestStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serviceClass - Class of the gRPC service which can be used to extract annotations to override offloading behavior (e.g. NoOffloadsRouteExecutionStrategy, RouteExecutionStrategy).

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addRequestStreamingRoute

@Deprecated
protected final <Req,Resp> void addRequestStreamingRoute(String path,
                                                                     GrpcExecutionStrategy executionStrategy,
                                                                     GrpcRoutes.RequestStreamingRoute<Req,Resp> route,
                                                                     Class<Req> requestClass,
                                                                     Class<Resp> responseClass,
                                                                     GrpcSerializationProvider serializationProvider)

Deprecated. Use addRequestStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, RequestStreamingRoute).

Adds a GrpcRoutes.RequestStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

executionStrategy - GrpcExecutionStrategy to use.

route - GrpcRoutes.RequestStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addRequestStreamingRoute

protected final <Req,Resp> void addRequestStreamingRoute(GrpcExecutionStrategy executionStrategy,
                                                         MethodDescriptor<Req,Resp> methodDescriptor,
                                                         BufferDecoderGroup decompressors,
                                                         List<BufferEncoder> compressors,
                                                         GrpcRoutes.RequestStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.RequestStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

executionStrategy - The execution strategy to use for this route.

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addResponseStreamingRoute

@Deprecated
protected final <Req,Resp> void addResponseStreamingRoute(String path,
                                                                      Class<?> serviceClass,
                                                                      String methodName,
                                                                      GrpcRoutes.ResponseStreamingRoute<Req,Resp> route,
                                                                      Class<Req> requestClass,
                                                                      Class<Resp> responseClass,
                                                                      GrpcSerializationProvider serializationProvider)

Deprecated. Use addResponseStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, ResponseStreamingRoute).

Adds a GrpcRoutes.ResponseStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

serviceClass - Class of the gRPC service.

methodName - the name of gRPC method.

route - GrpcRoutes.ResponseStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addResponseStreamingRoute

protected final <Req,Resp> void addResponseStreamingRoute(Class<?> serviceClass,
                                                          MethodDescriptor<Req,Resp> methodDescriptor,
                                                          BufferDecoderGroup decompressors,
                                                          List<BufferEncoder> compressors,
                                                          GrpcRoutes.ResponseStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.ResponseStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serviceClass - Class of the gRPC service which can be used to extract annotations to override offloading behavior (e.g. NoOffloadsRouteExecutionStrategy, RouteExecutionStrategy).

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addResponseStreamingRoute

@Deprecated
protected final <Req,Resp> void addResponseStreamingRoute(String path,
                                                                      GrpcExecutionStrategy executionStrategy,
                                                                      GrpcRoutes.ResponseStreamingRoute<Req,Resp> route,
                                                                      Class<Req> requestClass,
                                                                      Class<Resp> responseClass,
                                                                      GrpcSerializationProvider serializationProvider)

Deprecated. Use addResponseStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, ResponseStreamingRoute).

Adds a GrpcRoutes.ResponseStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

executionStrategy - GrpcExecutionStrategy to use.

route - GrpcRoutes.ResponseStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addResponseStreamingRoute

protected final <Req,Resp> void addResponseStreamingRoute(GrpcExecutionStrategy executionStrategy,
                                                          MethodDescriptor<Req,Resp> methodDescriptor,
                                                          BufferDecoderGroup decompressors,
                                                          List<BufferEncoder> compressors,
                                                          GrpcRoutes.ResponseStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.ResponseStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

executionStrategy - The execution strategy to use for this route.

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addBlockingRoute

@Deprecated
protected final <Req,Resp> void addBlockingRoute(String path,
                                                             Class<?> serviceClass,
                                                             String methodName,
                                                             GrpcRoutes.BlockingRoute<Req,Resp> route,
                                                             Class<Req> requestClass,
                                                             Class<Resp> responseClass,
                                                             GrpcSerializationProvider serializationProvider)

Deprecated. Use addBlockingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, BlockingRoute).

Adds a GrpcRoutes.BlockingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

serviceClass - Class of the gRPC service.

methodName - the name of gRPC method.

route - GrpcRoutes.BlockingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addBlockingRoute

protected final <Req,Resp> void addBlockingRoute(Class<?> serviceClass,
                                                 MethodDescriptor<Req,Resp> methodDescriptor,
                                                 BufferDecoderGroup decompressors,
                                                 List<BufferEncoder> compressors,
                                                 GrpcRoutes.BlockingRoute<Req,Resp> route)

Adds a GrpcRoutes.BlockingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serviceClass - Class of the gRPC service which can be used to extract annotations to override offloading behavior (e.g. NoOffloadsRouteExecutionStrategy, RouteExecutionStrategy).

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addBlockingRoute

@Deprecated
protected final <Req,Resp> void addBlockingRoute(String path,
                                                             GrpcExecutionStrategy executionStrategy,
                                                             GrpcRoutes.BlockingRoute<Req,Resp> route,
                                                             Class<Req> requestClass,
                                                             Class<Resp> responseClass,
                                                             GrpcSerializationProvider serializationProvider)

Deprecated. Use addBlockingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, BlockingRoute).

Adds a GrpcRoutes.BlockingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

executionStrategy - GrpcExecutionStrategy to use.

route - GrpcRoutes.BlockingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addBlockingRoute

protected final <Req,Resp> void addBlockingRoute(GrpcExecutionStrategy executionStrategy,
                                                 MethodDescriptor<Req,Resp> methodDescriptor,
                                                 BufferDecoderGroup decompressors,
                                                 List<BufferEncoder> compressors,
                                                 GrpcRoutes.BlockingRoute<Req,Resp> route)

Adds a GrpcRoutes.BlockingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

executionStrategy - The execution strategy to use for this route.

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addBlockingStreamingRoute

@Deprecated
protected final <Req,Resp> void addBlockingStreamingRoute(String path,
                                                                      Class<?> serviceClass,
                                                                      String methodName,
                                                                      GrpcRoutes.BlockingStreamingRoute<Req,Resp> route,
                                                                      Class<Req> requestClass,
                                                                      Class<Resp> responseClass,
                                                                      GrpcSerializationProvider serializationProvider)

Deprecated. Use addBlockingStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, BlockingStreamingRoute).

Adds a GrpcRoutes.BlockingStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

serviceClass - Class of the gRPC service.

methodName - the name of gRPC method.

route - GrpcRoutes.BlockingStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addBlockingStreamingRoute

protected final <Req,Resp> void addBlockingStreamingRoute(Class<?> serviceClass,
                                                          MethodDescriptor<Req,Resp> methodDescriptor,
                                                          BufferDecoderGroup decompressors,
                                                          List<BufferEncoder> compressors,
                                                          GrpcRoutes.BlockingStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.BlockingStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serviceClass - Class of the gRPC service which can be used to extract annotations to override offloading behavior (e.g. NoOffloadsRouteExecutionStrategy, RouteExecutionStrategy).

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addBlockingStreamingRoute

@Deprecated
protected final <Req,Resp> void addBlockingStreamingRoute(String path,
                                                                      GrpcExecutionStrategy executionStrategy,
                                                                      GrpcRoutes.BlockingStreamingRoute<Req,Resp> route,
                                                                      Class<Req> requestClass,
                                                                      Class<Resp> responseClass,
                                                                      GrpcSerializationProvider serializationProvider)

Deprecated. Use addBlockingStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, BlockingStreamingRoute).

Adds a GrpcRoutes.BlockingStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

executionStrategy - GrpcExecutionStrategy to use.

route - GrpcRoutes.BlockingStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addBlockingStreamingRoute

protected final <Req,Resp> void addBlockingStreamingRoute(GrpcExecutionStrategy executionStrategy,
                                                          MethodDescriptor<Req,Resp> methodDescriptor,
                                                          BufferDecoderGroup decompressors,
                                                          List<BufferEncoder> compressors,
                                                          GrpcRoutes.BlockingStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.BlockingStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

executionStrategy - The execution strategy to use for this route.

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addBlockingRequestStreamingRoute

@Deprecated
protected final <Req,Resp> void addBlockingRequestStreamingRoute(String path,
                                                                             Class<?> serviceClass,
                                                                             String methodName,
                                                                             GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> route,
                                                                             Class<Req> requestClass,
                                                                             Class<Resp> responseClass,
                                                                             GrpcSerializationProvider serializationProvider)

Deprecated. Use addBlockingStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, BlockingStreamingRoute).

Adds a GrpcRoutes.BlockingRequestStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

serviceClass - Class of the gRPC service.

methodName - the name of gRPC method.

route - GrpcRoutes.BlockingRequestStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addBlockingRequestStreamingRoute

protected final <Req,Resp> void addBlockingRequestStreamingRoute(Class<?> serviceClass,
                                                                 MethodDescriptor<Req,Resp> methodDescriptor,
                                                                 BufferDecoderGroup decompressors,
                                                                 List<BufferEncoder> compressors,
                                                                 GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.BlockingRequestStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serviceClass - Class of the gRPC service which can be used to extract annotations to override offloading behavior (e.g. NoOffloadsRouteExecutionStrategy, RouteExecutionStrategy).

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addBlockingRequestStreamingRoute

@Deprecated
protected final <Req,Resp> void addBlockingRequestStreamingRoute(String path,
                                                                             GrpcExecutionStrategy executionStrategy,
                                                                             GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> route,
                                                                             Class<Req> requestClass,
                                                                             Class<Resp> responseClass,
                                                                             GrpcSerializationProvider serializationProvider)

Deprecated. Use addBlockingRequestStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, BlockingRequestStreamingRoute).

Adds a GrpcRoutes.BlockingRequestStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

executionStrategy - GrpcExecutionStrategy to use.

route - GrpcRoutes.BlockingRequestStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addBlockingRequestStreamingRoute

protected final <Req,Resp> void addBlockingRequestStreamingRoute(GrpcExecutionStrategy executionStrategy,
                                                                 MethodDescriptor<Req,Resp> methodDescriptor,
                                                                 BufferDecoderGroup decompressors,
                                                                 List<BufferEncoder> compressors,
                                                                 GrpcRoutes.BlockingRequestStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.BlockingRequestStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

executionStrategy - The execution strategy to use for this route.

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addBlockingResponseStreamingRoute

@Deprecated
protected final <Req,Resp> void addBlockingResponseStreamingRoute(String path,
                                                                              Class<?> serviceClass,
                                                                              String methodName,
                                                                              GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> route,
                                                                              Class<Req> requestClass,
                                                                              Class<Resp> responseClass,
                                                                              GrpcSerializationProvider serializationProvider)

Deprecated. Use addBlockingResponseStreamingRoute(Class, MethodDescriptor, BufferDecoderGroup, List, BlockingResponseStreamingRoute).

Adds a GrpcRoutes.BlockingResponseStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

serviceClass - Class of the gRPC service.

methodName - the name of gRPC method.

route - GrpcRoutes.BlockingResponseStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addBlockingResponseStreamingRoute

protected final <Req,Resp> void addBlockingResponseStreamingRoute(Class<?> serviceClass,
                                                                  MethodDescriptor<Req,Resp> methodDescriptor,
                                                                  BufferDecoderGroup decompressors,
                                                                  List<BufferEncoder> compressors,
                                                                  GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.BlockingResponseStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serviceClass - Class of the gRPC service which can be used to extract annotations to override offloading behavior (e.g. NoOffloadsRouteExecutionStrategy, RouteExecutionStrategy).

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.

addBlockingResponseStreamingRoute

@Deprecated
protected final <Req,Resp> void addBlockingResponseStreamingRoute(String path,
                                                                              GrpcExecutionStrategy executionStrategy,
                                                                              GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> route,
                                                                              Class<Req> requestClass,
                                                                              Class<Resp> responseClass,
                                                                              GrpcSerializationProvider serializationProvider)

Deprecated. Use addBlockingResponseStreamingRoute(GrpcExecutionStrategy, MethodDescriptor, BufferDecoderGroup, List, BlockingResponseStreamingRoute).

Adds a GrpcRoutes.BlockingResponseStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

path - for this route.

executionStrategy - GrpcExecutionStrategy to use.

route - GrpcRoutes.BlockingResponseStreamingRoute to add.

requestClass - Class for the request object.

responseClass - Class for the response object.

serializationProvider - GrpcSerializationProvider for the route.

addBlockingResponseStreamingRoute

protected final <Req,Resp> void addBlockingResponseStreamingRoute(GrpcExecutionStrategy executionStrategy,
                                                                  MethodDescriptor<Req,Resp> methodDescriptor,
                                                                  BufferDecoderGroup decompressors,
                                                                  List<BufferEncoder> compressors,
                                                                  GrpcRoutes.BlockingResponseStreamingRoute<Req,Resp> route)

Adds a GrpcRoutes.BlockingResponseStreamingRoute to this factory.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

executionStrategy - The execution strategy to use for this route.

methodDescriptor - Describes the method routing and serialization.

decompressors - Indicates the supported decompression applied to each request.

compressors - Indicates the supported compression can be applied to responses.

route - The interface to invoke when data is received for this route.