com.tangosol.coherence.config.scheme

Interface ObservableCachingScheme

All Superinterfaces:

BackingMapManagerBuilder, CachingScheme, MapBuilder, NamedCacheBuilder, Scheme, ServiceScheme

All Known Implementing Classes:

AbstractCachingScheme, AbstractCompositeScheme, AbstractJournalScheme, AbstractLocalCachingScheme, BackingMapScheme, ClassScheme, ContinuousQueryCacheScheme, CustomScheme, DistributedScheme, ExternalScheme, FlashJournalScheme, LocalScheme, NearScheme, OptimisticScheme, OverflowScheme, PagedExternalScheme, PagedTopicScheme, ProxyScheme, RamJournalScheme, ReadWriteBackingMapScheme, RemoteCacheScheme, ReplicatedScheme, TransactionalScheme, ViewScheme

public interface ObservableCachingScheme
extends CachingScheme

An ObservableCachingScheme is a CachingScheme that supports defining and adding MapListeners to realized Maps and NamedCaches.

Since:

Coherence 12.1.2

Author:

bo 2012.11.06

Nested Class Summary

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

MapBuilder.Dependencies

Field Summary

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

DELIM_APPLICATION_SCOPE, DELIM_DOMAIN_PARTITION

Method Summary

Modifier and Type	Method and Description
void	establishMapListeners(Map map, com.tangosol.config.expression.ParameterResolver resolver, MapBuilder.Dependencies dependencies) Establishes an appropriate MapListener (provided by the getListenerBuilder()) on the ObservableMap that was produced by the ObservableCachingScheme.
ParameterizedBuilder<MapListener>	getListenerBuilder() Obtains a ParameterizedBuilder for a MapListener that can be used for building MapListeners those of which may be later added to the Maps or NamedCaches realized by the CachingScheme.

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

getEventInterceptorBuilders, getScopedServiceName, getServiceBuilder, getServiceName, getServiceType, isAutoStart

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

getSchemeName, isAnonymous

Methods inherited from interface com.tangosol.coherence.config.builder.NamedCacheBuilder

realizeCache

Methods inherited from interface com.tangosol.coherence.config.builder.MapBuilder

realizeMap

Methods inherited from interface com.tangosol.coherence.config.builder.BackingMapManagerBuilder

realizeBackingMapManager

Method Detail

getListenerBuilder

ParameterizedBuilder<MapListener> getListenerBuilder()

Obtains a ParameterizedBuilder for a MapListener that can be used for building MapListeners those of which may be later added to the Maps or NamedCaches realized by the CachingScheme.

Returns:

a ParameterizedBuilder for MapListeners

establishMapListeners

void establishMapListeners(Map map,
                           com.tangosol.config.expression.ParameterResolver resolver,
                           MapBuilder.Dependencies dependencies)

Establishes an appropriate MapListener (provided by the getListenerBuilder()) on the ObservableMap that was produced by the ObservableCachingScheme.

This method will automatically inject the following types and named values into realized classes that have been annotated with @Injectable.

1. BackingMapManagerContext (optionally named "manager-context")
2. ConfigurableCacheFactory
3. Cache Name (as a String.class named "cache-name")
4. Context ClassLoader (optionally named "class-loader")
5. ResourceRegistry
6. CacheConfig
7. together with any other resource, named or otherwise, available in the ResourceRegistry provided by the ConfigurableCacheFactory.

Parameters:

map - an ObservableMap to which to add a MapListener (if the map is not observable, no listeners are added)

resolver - the ParameterResolver to use for resolving builder parameters

dependencies - the MapBuilder dependencies from which to obtain builder information

See Also:

Injectable