Package emissary.grpc

Class GrpcRoutingPlace

java.lang.Object

emissary.directory.DirectoryProviderPlace

emissary.place.ServiceProviderPlace

emissary.grpc.GrpcRoutingPlace

All Implemented Interfaces:

IGrpcRoutingPlace, IServiceProviderPlace, ServiceProviderPlaceMBean

Direct Known Subclasses:

GrpcConnectionPlace, GrpcSampleServicePlace

public abstract class GrpcRoutingPlace
extends ServiceProviderPlace
implements IGrpcRoutingPlace

Place for processing data using gRPC connections to external services. Supports multiple end-points with shared configurations, where each endpoint is identified by a given target ID.

Configuration Keys:

• GRPC_HOST_{Target-ID} - gRPC service hostname or DNS target, where Target-ID is the unique identifier for the given host:port
• GRPC_PORT_{Target-ID} - gRPC service port, where Target-ID is the unique identifier for the given host:port
• See ConnectionFactory for supported pooling and gRPC channel configuration keys and defaults.
• See RetryHandler for supported retry configuration keys and defaults.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,org.apache.commons.pool2.ObjectPool<io.grpc.ManagedChannel>>	channelPoolTable
static String	GRPC_HOST
static String	GRPC_PORT
protected GrpcInvoker	grpcInvoker
protected Map<String,String>	hostnameTable
protected Map<String,Integer>	portNumberTable

Fields inherited from class emissary.place.ServiceProviderPlace

configG, configLocs, heavyDutyMethodImplemented, kff, placeLocation, processMethodImplemented, slogger

Fields inherited from class emissary.directory.DirectoryProviderPlace

denyList, dirPlace, keys, localDirPlace, logger, myKey, placeName, serviceCost, serviceDescription, serviceQuality

Fields inherited from interface emissary.place.IServiceProviderPlace

DOT, SPROUT_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GrpcRoutingPlace()
protected	GrpcRoutingPlace(Configurator configs)
protected	GrpcRoutingPlace(InputStream configStream)
protected	GrpcRoutingPlace(InputStream configStream, String placeLocation)
protected	GrpcRoutingPlace(InputStream configStream, String theDir, String thePlaceLocation)
protected	GrpcRoutingPlace(String thePlaceLocation)
protected	GrpcRoutingPlace(String configFile, String placeLocation)
protected	GrpcRoutingPlace(String configFile, String theDir, String thePlaceLocation)

Method Summary

Modifier and Type	Method	Description
String	getHostname(String targetId)
protected Map<String,String>	getHostnameConfigs()
int	getPortNumber(String targetId)
protected Map<String,Integer>	getPortNumberConfigs()
protected <Q extends com.google.protobuf.GeneratedMessageV3,R extends com.google.protobuf.GeneratedMessageV3,S extends io.grpc.stub.AbstractBlockingStub<S>> R	invokeGrpc(String targetId, Function<io.grpc.ManagedChannel,S> stubFactory, BiFunction<S,Q,R> callLogic, Q request)	Wrapper method for GrpcInvoker.invoke(ObjectPool, Function, BiFunction, GeneratedMessageV3) that executes a unary gRPC call to a given endpoint.
protected <Q extends com.google.protobuf.GeneratedMessageV3,R extends com.google.protobuf.GeneratedMessageV3,S extends io.grpc.stub.AbstractFutureStub<S>> CompletableFuture<R>	invokeGrpcAsync(String targetId, Function<io.grpc.ManagedChannel,S> stubFactory, BiFunction<S,Q,com.google.common.util.concurrent.ListenableFuture<R>> callLogic, Q request)	Wrapper method for GrpcInvoker.invokeAsync(ObjectPool, Function, BiFunction, GeneratedMessageV3) that executes a unary gRPC call to a given endpoint and returns a future.
protected void	passivateConnection(io.grpc.ManagedChannel managedChannel)	Called after a gRPC call to clean up the channel.
protected <T> T	tableLookup(Map<String,T> table, String targetId)
protected abstract boolean	validateConnection(io.grpc.ManagedChannel managedChannel)	Validates whether a given ManagedChannel is capable of successfully communicating with its associated gRPC server.

Methods inherited from class emissary.place.ServiceProviderPlace

agentProcessCall, agentProcessHeavyDuty, agentProcessHeavyDuty, changesPrimaryView, createsExtractedRecords, dumpPlaceStats, dumpRunningConfig, getAgent, getAlternateViewsModified, getConfigurator, getFileTypes, getOutputForms, getParametersModified, getPlaceStats, getResourceLimitMillis, getRunningConfig, getTld, initKff, process, processHeavyDuty, rehash, setConfigLocations, setPlaceLocation, setupPlace, setupPlace, sproutsChildren, verifyProcessImplementationProvided

Methods inherited from class emissary.directory.DirectoryProviderPlace

addKey, addServiceProxy, configureServicePlace, deregisterFromDirectory, getDirectoryEntry, getKey, getKeys, getPlaceName, getPrimaryProxy, getProxies, isDenied, nextKeys, nukeMyProxies, register, register, registerWithDirectory, removeKey, removeServiceProxy, setLogger, setupPlacePostHook, shutDown, toString, unbindFromNamespace

Methods inherited from class java.lang.Object

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

Methods inherited from interface emissary.place.IServiceProviderPlace

addKey, addServiceProxy, agentProcessCall, agentProcessHeavyDuty, agentProcessHeavyDuty, getAgent, getDirectoryEntry, getKey, getKeys, getPlaceName, getPrimaryProxy, getProxies, getResourceLimitMillis, isDenied, loadConfigurator, loadConfigurator, loadConfigurator, loadConfigurator, nextKeys, process, processHeavyDuty, removeKey, removeServiceProxy, setConfigLocations, setPlaceLocation, shutDown

Field Detail

GRPC_HOST

public static final String GRPC_HOST

See Also:

Constant Field Values

GRPC_PORT

public static final String GRPC_PORT

See Also:

Constant Field Values

grpcInvoker

protected GrpcInvoker grpcInvoker

hostnameTable

protected final Map<String,String> hostnameTable

portNumberTable

protected final Map<String,Integer> portNumberTable

channelPoolTable

protected final Map<String,org.apache.commons.pool2.ObjectPool<io.grpc.ManagedChannel>> channelPoolTable

Constructor Detail

GrpcRoutingPlace

protected GrpcRoutingPlace()
                    throws IOException

Throws:

IOException

GrpcRoutingPlace

protected GrpcRoutingPlace(String thePlaceLocation)
                    throws IOException

Throws:

IOException

GrpcRoutingPlace

protected GrpcRoutingPlace(InputStream configStream)
                    throws IOException

Throws:

IOException

GrpcRoutingPlace

protected GrpcRoutingPlace(String configFile,
                           String placeLocation)
                    throws IOException

Throws:

IOException

GrpcRoutingPlace

protected GrpcRoutingPlace(InputStream configStream,
                           String placeLocation)
                    throws IOException

Throws:

IOException

GrpcRoutingPlace

protected GrpcRoutingPlace(String configFile,
                           @Nullable
                           String theDir,
                           String thePlaceLocation)
                    throws IOException

Throws:

IOException

GrpcRoutingPlace

protected GrpcRoutingPlace(InputStream configStream,
                           @Nullable
                           String theDir,
                           String thePlaceLocation)
                    throws IOException

Throws:

IOException

GrpcRoutingPlace

protected GrpcRoutingPlace(@Nullable
                           Configurator configs)
                    throws IOException

Throws:

IOException

Method Detail

getHostnameConfigs

protected Map<String,String> getHostnameConfigs()

getPortNumberConfigs

protected Map<String,Integer> getPortNumberConfigs()

validateConnection

protected abstract boolean validateConnection(io.grpc.ManagedChannel managedChannel)

Validates whether a given ManagedChannel is capable of successfully communicating with its associated gRPC server.

Parameters:

managedChannel - the gRPC channel to validate

Returns:

true if the channel is healthy and the server responds successfully, else false

passivateConnection

protected void passivateConnection(io.grpc.ManagedChannel managedChannel)

Called after a gRPC call to clean up the channel. No-op by default, since gRPC channels are designed to remain ready for reuse. Override this if using a stub that requires channels be reset or cleared between uses.

Parameters:

managedChannel - the gRPC channel to clean up

invokeGrpc

protected <Q extends com.google.protobuf.GeneratedMessageV3,R extends com.google.protobuf.GeneratedMessageV3,S extends io.grpc.stub.AbstractBlockingStub<S>> R invokeGrpc(String targetId,
                                                                                                                                                                                      Function<io.grpc.ManagedChannel,S> stubFactory,
                                                                                                                                                                                      BiFunction<S,Q,R> callLogic,
                                                                                                                                                                                      Q request)

Wrapper method for GrpcInvoker.invoke(ObjectPool, Function, BiFunction, GeneratedMessageV3) that executes a unary gRPC call to a given endpoint.

Type Parameters:

Q - the protobuf request type

R - the protobuf response type

S - the gRPC stub type

Parameters:

targetId - the identifier used in the configs for the given gRPC endpoint

stubFactory - function that creates the appropriate gRPC stub from a ManagedChannel

callLogic - function that performs the actual gRPC call using the stub and request

request - the protobuf request message to send

Returns:

the response returned by the gRPC call

invokeGrpcAsync

protected <Q extends com.google.protobuf.GeneratedMessageV3,R extends com.google.protobuf.GeneratedMessageV3,S extends io.grpc.stub.AbstractFutureStub<S>> CompletableFuture<R> invokeGrpcAsync(String targetId,
                                                                                                                                                                                                            Function<io.grpc.ManagedChannel,S> stubFactory,
                                                                                                                                                                                                            BiFunction<S,Q,com.google.common.util.concurrent.ListenableFuture<R>> callLogic,
                                                                                                                                                                                                            Q request)

Wrapper method for GrpcInvoker.invokeAsync(ObjectPool, Function, BiFunction, GeneratedMessageV3) that executes a unary gRPC call to a given endpoint and returns a future.

Type Parameters:

Q - the protobuf request type

R - the protobuf response type

S - the gRPC stub type

Parameters:

targetId - the identifier used in the configs for the given gRPC endpoint

stubFactory - function that creates the appropriate gRPC stub from a ManagedChannel

callLogic - function that performs the actual gRPC call using the stub and request

request - the protobuf request message to send

Returns:

the future that waits for the response returned by the gRPC call

getHostname

public String getHostname(String targetId)

getPortNumber

public int getPortNumber(String targetId)

tableLookup

protected <T> T tableLookup(Map<String,T> table,
                            String targetId)