Package com.tangosol.coherence.config.scheme

Class BaseGrpcTopicScheme

java.lang.Object

com.tangosol.coherence.config.scheme.AbstractScheme

com.tangosol.coherence.config.scheme.AbstractServiceScheme<com.tangosol.internal.net.grpc.DefaultRemoteGrpcTopicServiceDependencies>

com.tangosol.coherence.config.scheme.AbstractCachingScheme<com.tangosol.internal.net.grpc.DefaultRemoteGrpcTopicServiceDependencies>

com.tangosol.coherence.config.scheme.BaseGrpcScheme<com.tangosol.internal.net.grpc.DefaultRemoteGrpcTopicServiceDependencies,TopicService>

com.tangosol.coherence.config.scheme.BaseGrpcTopicScheme

All Implemented Interfaces:

BackingMapManagerBuilder, MapBuilder, NamedCacheBuilder, NamedCollectionBuilder<NamedTopic>, ServiceBuilder, CachingScheme, NamedTopicScheme, ObservableCachingScheme, Scheme, ServiceScheme, TopicScheme<NamedTopic,TopicService>

public class BaseGrpcTopicScheme
extends BaseGrpcScheme<com.tangosol.internal.net.grpc.DefaultRemoteGrpcTopicServiceDependencies,TopicService>
implements NamedTopicScheme

The BaseGrpcTopicScheme is responsible for building a remote gRPC topic service.

This class is sub-classed in the Coherence Java gRPC client module and that subclass does all the actual work. This allows the grpc remote scheme to be added to a cache configuration file even if the gRPC client is not on the class path and nothing will break.

Author:

Jonathan Knight 2025.01.01

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.coherence.config.builder.MapBuilder

MapBuilder.Dependencies

Field Summary

Fields inherited from class com.tangosol.coherence.config.scheme.AbstractServiceScheme

m_serviceDependencies

Fields inherited from interface com.tangosol.coherence.config.scheme.ServiceScheme

DELIM_APPLICATION_SCOPE, DELIM_DOMAIN_PARTITION

Constructor Summary

Constructors

Constructor	Description
BaseGrpcTopicScheme()	Constructs a BaseGrpcTopicScheme.

Method Summary

Modifier and Type	Method	Description
TopicDependencies	createConfiguration(ParameterResolver resolver, ClassLoader loader)	Create a TopicDependencies based on the values contained in this scheme.
TopicService	ensureConfiguredService(ParameterResolver resolver, MapBuilder.Dependencies deps)	Obtain a configured topic service.
protected Service	ensureService(String sService, Cluster cluster)	Call the Cluster.ensureService(String, String) method to obtain the service.
NamedCollectionBuilder	getNamedCollectionBuilder(Class<? extends NamedCollection> clz, com.oracle.coherence.common.util.Options<NamedCollection.Option> options)
String	getServiceType()	Return the service type.
<E> NamedTopic	realize(ValueTypeAssertion<E> assertion, ParameterResolver resolver, MapBuilder.Dependencies deps)	Realizes a NamedCollection (possibly "ensuring it") based on the state of the builder, the provided ParameterResolver and MapBuilder dependencies.
<T extends NamedCollection> boolean	realizes(Class<T> type)	Determines whether this NamedCollectionBuilder can realize a NamedCollection of the specified type.

Methods inherited from class com.tangosol.coherence.config.scheme.BaseGrpcScheme

getServiceProvider, isRunningClusterNeeded, setRemoteScopeName

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractCachingScheme

establishMapListeners, getDefaultParameterResolver, getListenerBuilder, realizeBackingMapManager, realizeCache, realizeMap, setListenerBuilder, validate

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractServiceScheme

getDefaultServiceName, getEventInterceptorBuilders, getScopedServiceName, getScopeName, getServiceBuilder, getServiceDependencies, getServiceName, getXml, injectScopeNameIntoService, isAutoStart, realizeService, setAutoStart, setScopeName, setServiceDependencies, setServiceName, setXml

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractScheme

getSchemeName, isAnonymous, setSchemeName, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.coherence.config.scheme.Scheme

getSchemeName, isAnonymous

Methods inherited from interface com.tangosol.coherence.config.scheme.ServiceScheme

getEventInterceptorBuilders, getScopedServiceName, getScopedServiceNameForProperty, getServiceBuilder, getServiceName, isAutoStart

Constructor Details

BaseGrpcTopicScheme

public BaseGrpcTopicScheme()

Constructs a BaseGrpcTopicScheme.

Method Details

realize

public <E> NamedTopic realize(ValueTypeAssertion<E> assertion,
 ParameterResolver resolver,
 MapBuilder.Dependencies deps)

Description copied from interface: NamedCollectionBuilder

Realizes a NamedCollection (possibly "ensuring it") based on the state of the builder, the provided ParameterResolver and MapBuilder dependencies.

The MapBuilder dependencies are required to satisfy the requirement when realizing a NamedCollection additionally involves realizing one or more internal Maps.

Specified by:

realize in interface NamedCollectionBuilder<NamedTopic>

Type Parameters:

E - the element type of NamedCollection

Parameters:

assertion - type constraint assertion for elements of this NamedCollection

resolver - the ParameterResolver

deps - the MapBuilder dependencies

Returns:

a NamedCollection

realizes

public <T extends NamedCollection> boolean realizes(Class<T> type)

Description copied from interface: NamedCollectionBuilder

Determines whether this NamedCollectionBuilder can realize a NamedCollection of the specified type.

Specified by:

realizes in interface NamedCollectionBuilder<NamedTopic>

Type Parameters:

T - the type of the class to verify

Parameters:

type - the Class of the type to verify

Returns:

true if this builder can realize a NamedCollection of the specified type.

createConfiguration

public TopicDependencies createConfiguration(ParameterResolver resolver,
 ClassLoader loader)

Description copied from interface: TopicScheme

Create a TopicDependencies based on the values contained in this scheme.

Specified by:

createConfiguration in interface TopicScheme<NamedTopic,TopicService>

Parameters:

resolver - the ParameterResolver to use to resolve configuration values

loader - the ClassLoader to use

Returns:

a TopicDependencies based on the values contained in this scheme

getNamedCollectionBuilder

public NamedCollectionBuilder getNamedCollectionBuilder(Class<? extends NamedCollection> clz,
 com.oracle.coherence.common.util.Options<NamedCollection.Option> options)

Specified by:

getNamedCollectionBuilder in interface ServiceScheme

getServiceType

public String getServiceType()

Description copied from interface: ServiceScheme

Return the service type.

Specified by:

getServiceType in interface ServiceScheme

Returns:

the service type

ensureService

protected Service ensureService(String sService,
 Cluster cluster)

Description copied from class: AbstractServiceScheme

Call the Cluster.ensureService(String, String) method to obtain the service.

Overrides:

ensureService in class AbstractServiceScheme<com.tangosol.internal.net.grpc.DefaultRemoteGrpcTopicServiceDependencies>

Parameters:

sService - the name of the service

cluster - the Cluster to obtain the service from

Returns:

the ensured service

ensureConfiguredService

public TopicService ensureConfiguredService(ParameterResolver resolver,
 MapBuilder.Dependencies deps)

Description copied from interface: TopicScheme

Obtain a configured topic service.

Specified by:

ensureConfiguredService in interface TopicScheme<NamedTopic,TopicService>

Parameters:

resolver - the ParameterResolver to use to resolve the service parameters

deps - the dependencies to use to configure the service

Returns:

a configured topic service