Chapter 40. gRPC

host (common)

Required The gRPC server host name. This is localhost or 0.0.0.0 when being a consumer or remote server host name when using producer.

String

port (common)

Required The gRPC local or remote server port.

int

service (common)

Required Fully qualified service name from the protocol buffer descriptor file (package dot service definition name).

String

flowControlWindow (common)

The HTTP/2 flow control window size (MiB).

1048576

int

maxMessageSize (common)

The maximum message size allowed to be received/sent (MiB).

4194304

int

autoDiscoverServerInterceptors (consumer)

Setting the autoDiscoverServerInterceptors mechanism, if true, the component will look for a ServerInterceptor instance in the registry automatically otherwise it will skip that checking.

true

boolean

consumerStrategy (consumer)

This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected, all requests will be accumulated in the list, then transferred to the flow, and the accumulated responses will be sent to the sender. If a propagation strategy is selected, request is sent to the stream, and the response will be immediately sent back to the sender.

Enum values:

PROPAGATION

GrpcConsumerStrategy

forwardOnCompleted (consumer)

Determines if onCompleted events should be pushed to the Camel route.

false

boolean

forwardOnError (consumer)

Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body.

false

boolean

maxConcurrentCallsPerConnection (consumer)

The maximum number of concurrent calls permitted for each incoming server connection.

2147483647

int

routeControlledStreamObserver (consumer)

Lets the route to take control over stream observer. If this value is set to true, then the response observer of gRPC call will be set with the name GrpcConstants.GRPC_RESPONSE_OBSERVER in the Exchange object. Please note that the stream observer’s onNext(), onError(), onCompleted() methods should be called in the route.

false

boolean

bridgeErrorHandler (consumer (advanced))

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

exceptionHandler (consumer (advanced))

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

ExceptionHandler

exchangePattern (consumer (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

ExchangePattern

autoDiscoverClientInterceptors (producer)

Setting the autoDiscoverClientInterceptors mechanism, if true, the component will look for a ClientInterceptor instance in the registry automatically otherwise it will skip that checking.

true

boolean

method (producer)

gRPC method name.

String

producerStrategy (producer)

The mode used to communicate with a remote gRPC server. In SIMPLE mode a single exchange is translated into a remote procedure call. In STREAMING mode all exchanges will be sent within the same request (input and output of the recipient gRPC service must be of type 'stream').

Enum values:

SIMPLE

GrpcProducerStrategy

streamRepliesTo (producer)

When using STREAMING client mode, it indicates the endpoint where responses should be forwarded.

String

userAgent (producer)

The user agent header passed to the server.

String

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

synchronous (advanced)

Sets whether synchronous processing should be strictly used.

false

boolean

authenticationType (security)

Authentication method type in advance to the SSL/TLS negotiation.

Enum values:

NONE

GrpcAuthType

jwtAlgorithm (security)

JSON Web Token sign algorithm.

Enum values:

HMAC256

JwtAlgorithm

jwtIssuer (security)

JSON Web Token issuer.

String

jwtSecret (security)

JSON Web Token secret.

String

jwtSubject (security)

JSON Web Token subject.

String

keyCertChainResource (security)

The X.509 certificate chain file resource in PEM format link.

String

keyPassword (security)

The PKCS#8 private key file password.

String

keyResource (security)

The PKCS#8 private key file resource in PEM format link.

String

negotiationType (security)

Identifies the security negotiation type used for HTTP/2 communication.

Enum values:

PLAINTEXT

NegotiationType

serviceAccountResource (security)

Service Account key file in JSON format resource link supported by the Google Cloud SDK.

String

trustCertCollectionResource (security)

The trusted certificates collection file resource in PEM format for verifying the remote endpoint’s certificate.

String