com.tangosol.coherence.config.scheme

Class PagedTopicScheme

java.lang.Object

com.tangosol.coherence.config.scheme.AbstractScheme

com.tangosol.coherence.config.scheme.AbstractServiceScheme<D>

com.tangosol.coherence.config.scheme.AbstractCachingScheme<com.tangosol.internal.net.service.grid.PartitionedCacheDependencies>

com.tangosol.coherence.config.scheme.DistributedScheme

com.tangosol.coherence.config.scheme.PagedTopicScheme

All Implemented Interfaces:

BackingMapManagerBuilder, MapBuilder, NamedCacheBuilder, NamedCollectionBuilder<NamedTopic>, ServiceBuilder, BundlingScheme, CachingScheme, ClusteredCachingScheme, NamedTopicScheme, ObservableCachingScheme, Scheme, ServiceScheme, TopicScheme<NamedTopic,CacheService>

public class PagedTopicScheme
extends DistributedScheme
implements NamedTopicScheme

A PagedTopicScheme is responsible for building a topic.

Since:

Coherence 14.1.1

Author:

jk 2015.05.21

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.coherence.config.scheme.DistributedScheme

DistributedScheme.BackupConfig

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

MapBuilder.Dependencies

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_NAME Default service name for PagedTopicScheme, overrides PagedTopicScheme service type which is DistributedCache.

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 and Description
PagedTopicScheme()

Method Summary

Modifier and Type	Method and Description
com.tangosol.internal.net.topic.impl.paged.Configuration	createConfiguration(com.tangosol.config.expression.ParameterResolver resolver, ClassLoader loader) Create a Configuration based on the values contained in this scheme.
CacheService	ensureConfiguredService(com.tangosol.config.expression.ParameterResolver resolver, MapBuilder.Dependencies deps) Ensure service and its topic configuration.
protected String	getDefaultServiceName() DefaultServiceName to use if none configured.
Seconds	getExpiryDelay(com.tangosol.config.expression.ParameterResolver resolver) Return the amount of time that elements offered to the queue remain visible to consumers.
long	getHighUnits(com.tangosol.config.expression.ParameterResolver resolver) Return the high-units
int	getPageSize(com.tangosol.config.expression.ParameterResolver resolver) Return the binary limit of the size of a page in a topic.
com.tangosol.config.expression.Expression<String>	getStorageAccessAuthorizer() Obtains the Expression defining the name of the StorageAccessAuthorizer.
CachingScheme	getStorageScheme() Return the BackingMapScheme used for the storage of this scheme.
CachingScheme	getStorageScheme(com.tangosol.config.expression.ParameterResolver resolver) Return the BackingMapScheme used for the storage of this scheme.
com.tangosol.config.expression.Expression<Boolean>	getTransientExpression() Return the Expression transient. to use to determine whether the backing map is transient.
boolean	isRetainConsumed(com.tangosol.config.expression.ParameterResolver resolver) Determine whether to retain consumed values.
<V> NamedTopic	realize(ValueTypeAssertion<V> typeConstraint, com.tangosol.config.expression.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.
void	setEventInterceptorBuilders(List<NamedEventInterceptorBuilder> listBuilders) Sets the List of NamedEventInterceptorBuilders for the DistributedScheme.
void	setExpiryDelay(com.tangosol.config.expression.Expression<Seconds> expr) Set the amount of time that elements offered to the queue remain visible to consumers.
void	setHighUnits(com.tangosol.config.expression.Expression<com.oracle.coherence.common.util.MemorySize> expr) Set the high-units
void	setPageSize(com.tangosol.config.expression.Expression<com.oracle.coherence.common.util.MemorySize> expr) Set the page size.
void	setRetainConsumed(com.tangosol.config.expression.Expression<Boolean> expr) Set whether to retain consumed values.
void	setStorageAccessAuthorizer(com.tangosol.config.expression.Expression<String> exprStorageAccessAuthorizer) Sets the Expression defining the name of the StorageAccessAuthorizer.
void	setStorageScheme(CachingScheme scheme) Set the BackingMapScheme which builds the backing map for the internal caches used to implement this scheme.
void	setTransient(com.tangosol.config.expression.Expression<Boolean> expr) Set the transient flag.

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

getBackingMapScheme, getBackupMapConfig, getBundleManager, getEventInterceptorBuilders, getServiceType, isRunningClusterNeeded, setBackingMapScheme, setBackupMapConfig, setBundleManager

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

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.ServiceScheme

getEventInterceptorBuilders, getScopedServiceName, getServiceBuilder, getServiceName, getServiceType, isAutoStart

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

getSchemeName, isAnonymous

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME

Default service name for PagedTopicScheme, overrides PagedTopicScheme service type which is DistributedCache.

See Also:

Constant Field Values

Constructor Detail

PagedTopicScheme

public PagedTopicScheme()

Method Detail

getDefaultServiceName

protected String getDefaultServiceName()

DefaultServiceName to use if none configured.

Overrides:

getDefaultServiceName in class AbstractServiceScheme<com.tangosol.internal.net.service.grid.PartitionedCacheDependencies>

Returns:

default service name

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.

getStorageScheme

public CachingScheme getStorageScheme(com.tangosol.config.expression.ParameterResolver resolver)

Return the BackingMapScheme used for the storage of this scheme.

Parameters:

resolver - potentially override default unit-calculator of BINARY

Returns:

the scheme

getStorageScheme

public CachingScheme getStorageScheme()

Return the BackingMapScheme used for the storage of this scheme.

Returns:

the scheme

setStorageScheme

@Injectable(value="storage")
public void setStorageScheme(CachingScheme scheme)

Set the BackingMapScheme which builds the backing map for the internal caches used to implement this scheme.

Parameters:

scheme - the scheme builder

getPageSize

public int getPageSize(com.tangosol.config.expression.ParameterResolver resolver)

Return the binary limit of the size of a page in a topic. Contains the target number of bytes that can be placed in a page before the page is deemed to be full. Legal values are positive integers.

Parameters:

resolver - the ParameterResolver

Returns:

the page size

setPageSize

@Injectable(value="page-size")
public void setPageSize(com.tangosol.config.expression.Expression<com.oracle.coherence.common.util.MemorySize> expr)

Set the page size.

Parameters:

expr - the page high units expression

getHighUnits

public long getHighUnits(com.tangosol.config.expression.ParameterResolver resolver)

Return the high-units

Parameters:

resolver - the ParameterResolver

Returns:

the unit factor

setHighUnits

@Injectable(value="high-units")
public void setHighUnits(com.tangosol.config.expression.Expression<com.oracle.coherence.common.util.MemorySize> expr)

Set the high-units

Parameters:

expr - the high-units expression

getTransientExpression

public com.tangosol.config.expression.Expression<Boolean> getTransientExpression()

Return the Expression transient. to use to determine whether the backing map is transient.

Returns:

the Expression transient. to use to determine whether the backing map is transient

setTransient

@Injectable
public void setTransient(com.tangosol.config.expression.Expression<Boolean> expr)

Set the transient flag.

Parameters:

expr - true to make the backing map transient.

getStorageAccessAuthorizer

public com.tangosol.config.expression.Expression<String> getStorageAccessAuthorizer()

Obtains the Expression defining the name of the StorageAccessAuthorizer.

Returns:

the name of the StorageAccessAuthorizer or null if one has not been configured.

setStorageAccessAuthorizer

@Injectable(value="storage-authorizer")
public void setStorageAccessAuthorizer(com.tangosol.config.expression.Expression<String> exprStorageAccessAuthorizer)

Sets the Expression defining the name of the StorageAccessAuthorizer.

Parameters:

exprStorageAccessAuthorizer - the Expression

getExpiryDelay

public Seconds getExpiryDelay(com.tangosol.config.expression.ParameterResolver resolver)

Return the amount of time that elements offered to the queue remain visible to consumers.

Parameters:

resolver - the ParameterResolver

Returns:

the amount of time that elements offered to the queue remain visible to consumers

setExpiryDelay

@Injectable
public void setExpiryDelay(com.tangosol.config.expression.Expression<Seconds> expr)

Set the amount of time that elements offered to the queue remain visible to consumers.

Parameters:

expr - the element expiry delay expression

isRetainConsumed

public boolean isRetainConsumed(com.tangosol.config.expression.ParameterResolver resolver)

Determine whether to retain consumed values.

Parameters:

resolver - the ParameterResolver

Returns:

true if the topic should retain consumed values

setRetainConsumed

@Injectable(value="retain-consumed")
public void setRetainConsumed(com.tangosol.config.expression.Expression<Boolean> expr)

Set whether to retain consumed values.

Parameters:

expr - the retain consumed values expression

setEventInterceptorBuilders

@Injectable(value="interceptors")
public void setEventInterceptorBuilders(List<NamedEventInterceptorBuilder> listBuilders)

Description copied from class: DistributedScheme

Sets the List of NamedEventInterceptorBuilders for the DistributedScheme.

Overrides:

setEventInterceptorBuilders in class DistributedScheme

Parameters:

listBuilders - the List of NamedEventInterceptorBuilders

realize

public <V> NamedTopic realize(ValueTypeAssertion<V> typeConstraint,
                              com.tangosol.config.expression.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:

V - the element type of NamedCollection

Parameters:

typeConstraint - type constraint assertion for elements of this NamedCollection

resolver - the ParameterResolver

deps - the MapBuilder dependencies

Returns:

a NamedCollection

ensureConfiguredService

public CacheService ensureConfiguredService(com.tangosol.config.expression.ParameterResolver resolver,
                                            MapBuilder.Dependencies deps)

Ensure service and its topic configuration. PagedTopicConfiguration is registered in corresponding service's resource registry.

Specified by:

ensureConfiguredService in interface TopicScheme<NamedTopic,CacheService>

Parameters:

resolver - the ParameterResolver

deps - the MapBuilder dependencies

Returns:

corresponding CacheService for this scheme

createConfiguration

public com.tangosol.internal.net.topic.impl.paged.Configuration createConfiguration(com.tangosol.config.expression.ParameterResolver resolver,
                                                                                    ClassLoader loader)

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

Parameters:

resolver - the ParameterResolver to use to resolve configuration values

loader - the ClassLoader to use

Returns:

a Configuration based on the values contained in this scheme