Package com.oracle.coherence.grpc.proxy.common

Class BaseGrpcServiceImpl

java.lang.Object

com.oracle.coherence.grpc.proxy.common.BaseGrpcServiceImpl

All Implemented Interfaces:

GrpcService

Direct Known Subclasses:

BaseNamedCacheServiceImpl, ProxyServiceGrpcImpl

public class BaseGrpcServiceImpl
extends Object
implements GrpcService

A base class for gRPC services.

The asynchronous processing of CompletionStages is done using an DaemonPoolExecutor so as not to consume or block threads in the Fork Join Pool. The DaemonPoolExecutor is configurable so that its thread counts can be controlled.

Since:

23.03

Author:

Jonathan Knight 2023.02.03

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseGrpcServiceImpl.DefaultDependencies	The default BaseGrpcServiceImpl.Dependencies implementation.
static interface	BaseGrpcServiceImpl.Dependencies	The dependencies to configure a BaseGrpcServiceImpl.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_TRANSFER_THRESHOLD	The default transfer threshold.
protected final Function<String,ConfigurableCacheFactory>	f_cacheFactorySupplier	The function used to obtain ConfigurableCacheFactory instances for a given scope name.
protected final BaseGrpcServiceImpl.Dependencies	f_dependencies	The service BaseGrpcServiceImpl.Dependencies.
protected final Executor	f_executor	The Executor to use to hand off asynchronous tasks.
protected final GrpcProxyMetrics	f_metrics	The proxy service metrics.
protected final NamedSerializerFactory	f_serializerProducer	The factory to use to lookup named Serializer instances.
static final String	INVALID_CACHE_NAME_MESSAGE	Error message used when the cache name is missing for a request.
protected long	transferThreshold	The transfer threshold used for paged requests.
protected static final Void	VOID	A Void value to make it obvious the return value in Void methods.

Constructor Summary

Constructors

Constructor	Description
BaseGrpcServiceImpl(BaseGrpcServiceImpl.Dependencies dependencies, String sMBeanName, String sPoolName)	Create a BaseGrpcServiceImpl.

Method Summary

Modifier and Type	Method	Description
protected static Executor	createDefaultExecutor(String sName)	Create the default Executor.
protected NamedCache<Binary,Binary>	getCache(String sScope, String sCacheName, boolean fPassThru)	Obtain an NamedCache.
ConfigurableCacheFactory	getCCF(String sScope)	Return the ConfigurableCacheFactory for the specified scope name.
BaseGrpcServiceImpl.Dependencies	getDependencies()	Return the service dependencies.
Executor	getExecutor()	Return the Executor this service is using for async-requests.
GrpcProxyMetrics	getMetrics()	Obtain the gRPC metrics instance for this service.
protected NamedCache<Binary,Binary>	getPassThroughCache(String scope, String cacheName)	Obtain an NamedCache.
Serializer	getSerializer(String sFormat, ClassLoader loader)	Return a named serializer.
protected Serializer	getSerializer(String sFormatRequest, String sFormatProxy, Supplier<Serializer> supplierSerializer, Supplier<ClassLoader> supplierLoader)
long	getTransferThreshold()	Return the transfer threshold.

Methods inherited from class java.lang.Object

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

Field Details

VOID

protected static final Void VOID

A Void value to make it obvious the return value in Void methods.

DEFAULT_TRANSFER_THRESHOLD

public static final long DEFAULT_TRANSFER_THRESHOLD

The default transfer threshold.

See Also:

• Constant Field Values

INVALID_CACHE_NAME_MESSAGE

public static final String INVALID_CACHE_NAME_MESSAGE

Error message used when the cache name is missing for a request.

See Also:

• Constant Field Values

f_dependencies

protected final BaseGrpcServiceImpl.Dependencies f_dependencies

The service BaseGrpcServiceImpl.Dependencies.

f_cacheFactorySupplier

protected final Function<String,ConfigurableCacheFactory> f_cacheFactorySupplier

The function used to obtain ConfigurableCacheFactory instances for a given scope name.

f_serializerProducer

protected final NamedSerializerFactory f_serializerProducer

The factory to use to lookup named Serializer instances.

f_executor

protected final Executor f_executor

The Executor to use to hand off asynchronous tasks.

f_metrics

protected final GrpcProxyMetrics f_metrics

The proxy service metrics.

transferThreshold

protected long transferThreshold

The transfer threshold used for paged requests.

Constructor Details

BaseGrpcServiceImpl

public BaseGrpcServiceImpl(BaseGrpcServiceImpl.Dependencies dependencies,
 String sMBeanName,
 String sPoolName)

Create a BaseGrpcServiceImpl.

Parameters:

dependencies - the BaseGrpcServiceImpl.Dependencies to use to configure the service

Method Details

getDependencies

public BaseGrpcServiceImpl.Dependencies getDependencies()

Return the service dependencies.

Specified by:

getDependencies in interface GrpcService

Returns:

the service dependencies

getMetrics

public GrpcProxyMetrics getMetrics()

Obtain the gRPC metrics instance for this service.

Returns:

the gRPC metrics instance for this service

getExecutor

public Executor getExecutor()

Return the Executor this service is using for async-requests.

Returns:

the Executor this service is using for async-requests

getTransferThreshold

public long getTransferThreshold()

Return the transfer threshold.

Returns:

the transferThreshold

getCCF

public ConfigurableCacheFactory getCCF(String sScope)

Return the ConfigurableCacheFactory for the specified scope name.

Specified by:

getCCF in interface GrpcService

Parameters:

sScope - the scope name for the ConfigurableCacheFactory to find

Returns:

the ConfigurableCacheFactory with the specified scope name

getPassThroughCache

protected NamedCache<Binary,Binary> getPassThroughCache(String scope,
 String cacheName)

Obtain an NamedCache.

Parameters:

scope - the scope name to use to obtain the CCF to get the cache from

cacheName - the name of the cache

Returns:

the NamedCache with the specified name

getCache

protected NamedCache<Binary,Binary> getCache(String sScope,
 String sCacheName,
 boolean fPassThru)

Obtain an NamedCache.

Parameters:

sScope - the scope name to use to obtain the CCF to get the cache from

sCacheName - the name of the cache

fPassThru - true to use a binary pass-thru cache

Returns:

the NamedCache with the specified name

createDefaultExecutor

protected static Executor createDefaultExecutor(String sName)

Create the default Executor.

Returns:

the default Executor

getSerializer

protected Serializer getSerializer(String sFormatRequest,
 String sFormatProxy,
 Supplier<Serializer> supplierSerializer,
 Supplier<ClassLoader> supplierLoader)

getSerializer

public Serializer getSerializer(String sFormat,
 ClassLoader loader)

Return a named serializer.

Specified by:

getSerializer in interface GrpcService

Parameters:

sFormat - the name of the serializer

loader - the class loader to use to create the serializer

Returns:

a named serializer

Throws:

io.grpc.StatusRuntimeException - if no serializer is configured with the specified name