Package com.tangosol.coherence.config.scheme

Interface ServiceScheme

All Superinterfaces:
Scheme
All Known Subinterfaces:
CachingScheme, NamedQueueScheme<Q>, NamedTopicScheme, ObservableCachingScheme, QueueScheme<C,S>, TopicScheme<C,S>
All Known Implementing Classes:
AbstractCachingScheme, AbstractCompositeScheme, AbstractJournalScheme, AbstractLocalCachingScheme, AbstractServiceScheme, BackingMapScheme, BaseGrpcCacheScheme, BaseGrpcScheme, BaseGrpcTopicScheme, CaffeineScheme, ClassScheme, ContinuousQueryCacheScheme, CustomScheme, DistributedScheme, ExternalScheme, FlashJournalScheme, InvocationScheme, LocalScheme, NearScheme, OptimisticScheme, OverflowScheme, PagedExternalScheme, PagedQueueScheme, PagedTopicScheme, PagedTopicStorageScheme, ProxyScheme, RamJournalScheme, ReadWriteBackingMapScheme, RemoteCacheScheme, RemoteInvocationScheme, RemoteTopicScheme, ReplicatedScheme, SimpleDequeScheme, TransactionalScheme, ViewScheme, WrapperCachingScheme
public interface ServiceScheme extends Scheme
This interface exposes service related scheme information. Other schemes, such as CachingScheme, extend this class to add support for caches and maps.
Since:
Coherence 12.1.2
Author:
pfm 2011.12.30

  • Field Details

  • Method Details

    • isAutoStart

      boolean isAutoStart()
      Return true if the service has auto-start enabled.
      Returns:
      the auto-start flag.

    • getServiceName

      String getServiceName()
      Return the service name.
      Returns:
      the service name

    • getScopedServiceName

      String getScopedServiceName()
      Return the service name with any scoping applied. The scoped name in general has the following format: 
         [<domain-partition-name>'/'] [<application-scope>':'] <service-name>
      Returns:
      the scoped service name

    • getScopedServiceNameForProperty

      default String getScopedServiceNameForProperty()
      Return a scoped service name to use as the string parameter for PROP_SERVICE_PARTITIONS.

      When present, replace DELIM_DOMAIN_PARTITION and DELIM_APPLICATION_SCOPE in scoped service name with character period. For example, scoped service name tenant/appscope:PartitionedCache is transformed to tenant.appscope.PartitionedCache.

      Returns:
      transformed scoped service name
      Since:
      24.09

    • getServiceType

      String getServiceType()
      Return the service type.
      Returns:
      the service type

    • getServiceBuilder

      ServiceBuilder getServiceBuilder()
      Return the ServiceBuilder that is needed to build a service.
      Returns:
      the ServiceBuilder or null if the scheme does not support services.

    • getEventInterceptorBuilders

      List<NamedEventInterceptorBuilder> getEventInterceptorBuilders()
      Obtains the List of NamedEventInterceptorBuilders that have been defined for the ServiceScheme.

      Note: For those ServiceSchemes don't support event interceptors, the returned value must be an empty list.

      Returns:
      an List over NamedEventInterceptorBuilders

    • getNamedCollectionBuilder

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

    • getScopePrefix

      static String getScopePrefix(String sScopeName, com.tangosol.application.ContainerContext context)
      Return a scope name prefixed with any tenancy name.
      Parameters:
      sScopeName - the scope name to prefix
      context - an optional container name to use to obtain the domain partition
      Returns:
      a scope name with a domain partition prefix, or the plain scope name if there is no domain partition

    • getScopedServiceName

      static String getScopedServiceName(String sScopeName, String sServiceName)
      Return a scoped service name
      Parameters:
      sScopeName - the optional scope name
      sServiceName - the service name
      Returns:
      the scoped service name