org.springframework.data.gemfire.client

Class ClientCacheFactoryBean

java.lang.Object

org.springframework.data.gemfire.CacheFactoryBean

org.springframework.data.gemfire.client.ClientCacheFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<com.gemstone.gemfire.cache.Cache>, InitializingBean, PersistenceExceptionTranslator

public class ClientCacheFactoryBean
extends CacheFactoryBean

FactoryBean dedicated to creating GemFire client caches.

See Also:

CacheFactoryBean, GemFireCache, ClientCache, ClientCacheFactory

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.gemfire.CacheFactoryBean

CacheFactoryBean.DynamicRegionSupport, CacheFactoryBean.JndiDataSource

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	readyForEvents

Fields inherited from class org.springframework.data.gemfire.CacheFactoryBean

beanClassLoader, beanFactory, beanFactoryLocator, beanName, cache, cacheXml, close, copyOnRead, criticalHeapPercentage, dynamicRegionSupport, enableAutoReconnect, evictionHeapPercentage, gatewayConflictResolver, jndiDataSources, lazyInitialize, lockLease, lockTimeout, log, messageSyncInterval, pdxDiskStoreName, pdxIgnoreUnreadFields, pdxPersistent, pdxReadSerialized, pdxSerializer, properties, searchTimeout, transactionListeners, transactionWriter, useBeanFactoryLocator, useClusterConfiguration

Constructor Summary

Constructors

Constructor and Description
ClientCacheFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
protected <T extends com.gemstone.gemfire.cache.GemFireCache> T	createCache(Object factory) Creates a new GemFire cache instance using the provided factory.
protected Object	createFactory(Properties gemfireProperties) Creates an instance of GemFire factory initialized with the given GemFire System Properties to create an instance of a GemFire cache.
protected <T extends com.gemstone.gemfire.cache.GemFireCache> T	fetchCache() Fetches an existing GemFire ClientCache instance from the ClientCacheFactory.
Boolean	getEnableAutoReconnect() Gets the value for the auto-reconnect setting.
Class<? extends com.gemstone.gemfire.cache.GemFireCache>	getObjectType()
Boolean	getReadyForEvents() Gets the value for the readyForEvents property.
Boolean	getUseClusterConfiguration() Gets the value fo the use-shared-configuration GemFire setting.
protected <T extends com.gemstone.gemfire.cache.GemFireCache> T	postProcess(T cache) Register for events after Pool and Regions have been created and iff non-durable client...
protected void	postProcessPropertiesBeforeInitialization(Properties gemfireProperties)
protected Object	prepareFactory(Object factory) Initializes the GemFire factory used to create the GemFire client cache instance.
protected Properties	resolveProperties() Resolves the GemFire System properties used to configure the GemFire ClientCache instance.
void	setEnableAutoReconnect(Boolean enableAutoReconnect) Controls whether auto-reconnect functionality introduced in GemFire 8 is enabled or not.
void	setPool(com.gemstone.gemfire.cache.client.Pool pool) Sets the pool used by this client.
void	setPoolName(String poolName) Sets the pool name used by this client.
void	setReadyForEvents(Boolean readyForEvents) Set the readyForEvents flag.
void	setUseClusterConfiguration(Boolean useClusterConfiguration) Sets the state of the use-shared-configuration GemFire distribution config setting.

Methods inherited from class org.springframework.data.gemfire.CacheFactoryBean

afterPropertiesSet, destroy, getBeanClassLoader, getBeanFactory, getBeanFactoryLocator, getBeanName, getCacheXml, getCopyOnRead, getCriticalHeapPercentage, getDynamicRegionSupport, getEvictionHeapPercentage, getGatewayConflictResolver, getJndiDataSources, getLockLease, getLockTimeout, getMessageSyncInterval, getObject, getPdxDiskStoreName, getPdxIgnoreUnreadFields, getPdxPersistent, getPdxReadSerialized, getPdxSerializer, getProperties, getSearchTimeout, getTransactionListeners, getTransactionWriter, isLazyInitialize, isPdxOptionsSpecified, isSingleton, resolveCache, setBeanClassLoader, setBeanFactory, setBeanName, setCacheXml, setClose, setCopyOnRead, setCriticalHeapPercentage, setDynamicRegionSupport, setEvictionHeapPercentage, setGatewayConflictResolver, setJndiDataSources, setLazyInitialize, setLockLease, setLockTimeout, setMessageSyncInterval, setPdxDiskStoreName, setPdxIgnoreUnreadFields, setPdxPersistent, setPdxReadSerialized, setPdxSerializer, setProperties, setSearchTimeout, setTransactionListeners, setTransactionWriter, setUseBeanFactoryLocator, translateExceptionIfPossible

Methods inherited from class java.lang.Object

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

Field Detail

readyForEvents

protected Boolean readyForEvents

Constructor Detail

ClientCacheFactoryBean

public ClientCacheFactoryBean()

Method Detail

postProcessPropertiesBeforeInitialization

protected void postProcessPropertiesBeforeInitialization(Properties gemfireProperties)

Overrides:

postProcessPropertiesBeforeInitialization in class CacheFactoryBean

fetchCache

protected <T extends com.gemstone.gemfire.cache.GemFireCache> T fetchCache()

Fetches an existing GemFire ClientCache instance from the ClientCacheFactory.

Overrides:

fetchCache in class CacheFactoryBean

Type Parameters:

T - is Class type extension of GemFireCache.

Returns:

the existing GemFire ClientCache instance if available.

Throws:

com.gemstone.gemfire.cache.CacheClosedException - if an existing GemFire Cache instance does not exist.

IllegalStateException - if the GemFire cache instance is not a ClientCache.

See Also:

GemFireCache, ClientCacheFactory.getAnyInstance()

resolveProperties

protected Properties resolveProperties()

Resolves the GemFire System properties used to configure the GemFire ClientCache instance.

Overrides:

resolveProperties in class CacheFactoryBean

Returns:

a Properties object containing GemFire System properties used to configure the GemFire ClientCache instance.

See Also:

CacheFactoryBean.getProperties()

createFactory

protected Object createFactory(Properties gemfireProperties)

Creates an instance of GemFire factory initialized with the given GemFire System Properties to create an instance of a GemFire cache.

Overrides:

createFactory in class CacheFactoryBean

Parameters:

gemfireProperties - a Properties object containing GemFire System properties.

Returns:

an instance of a GemFire factory used to create a GemFire cache instance.

See Also:

Properties, ClientCacheFactory

prepareFactory

protected Object prepareFactory(Object factory)

Initializes the GemFire factory used to create the GemFire client cache instance. Sets PDX options specified by the user.

Overrides:

prepareFactory in class CacheFactoryBean

Parameters:

factory - the GemFire factory used to create an instance of the GemFire client cache.

Returns:

the initialized GemFire client cache factory.

See Also:

CacheFactoryBean.isPdxOptionsSpecified()

createCache

protected <T extends com.gemstone.gemfire.cache.GemFireCache> T createCache(Object factory)

Creates a new GemFire cache instance using the provided factory.

Overrides:

createCache in class CacheFactoryBean

Type Parameters:

T - parameterized Class type extension of GemFireCache.

Parameters:

factory - the appropriate GemFire factory used to create a cache instance.

Returns:

an instance of the GemFire cache.

See Also:

GemFireCache, ClientCacheFactory.create()

postProcess

protected <T extends com.gemstone.gemfire.cache.GemFireCache> T postProcess(T cache)
                                                                 throws IOException

Register for events after Pool and Regions have been created and iff non-durable client...

Overrides:

postProcess in class CacheFactoryBean

Type Parameters:

T - parameterized Class type extension of GemFireCache.

Parameters:

cache - the GemFire cache instance to process.

Returns:

the processed cache instance after ready for events.

Throws:

IOException - if an error occurs during post processing.

See Also:

CacheFactoryBean.postProcess(com.gemstone.gemfire.cache.GemFireCache), readyForEvents(com.gemstone.gemfire.cache.GemFireCache), GemFireCache, ClientCache

setEnableAutoReconnect

public final void setEnableAutoReconnect(Boolean enableAutoReconnect)

Description copied from class: CacheFactoryBean

Controls whether auto-reconnect functionality introduced in GemFire 8 is enabled or not.

Overrides:

setEnableAutoReconnect in class CacheFactoryBean

Parameters:

enableAutoReconnect - a boolean value to enable/disable auto-reconnect functionality.

getEnableAutoReconnect

public final Boolean getEnableAutoReconnect()

Description copied from class: CacheFactoryBean

Gets the value for the auto-reconnect setting.

Overrides:

getEnableAutoReconnect in class CacheFactoryBean

Returns:

a boolean value indicating whether auto-reconnect was specified (non-null) and whether it was enabled or not.

getObjectType

public Class<? extends com.gemstone.gemfire.cache.GemFireCache> getObjectType()

Specified by:

getObjectType in interface FactoryBean<com.gemstone.gemfire.cache.Cache>

Overrides:

getObjectType in class CacheFactoryBean

setPool

public void setPool(com.gemstone.gemfire.cache.client.Pool pool)

Sets the pool used by this client.

Parameters:

pool - the GemFire pool used by the Client Cache to obtain connections to the GemFire cluster.

setPoolName

public void setPoolName(String poolName)

Sets the pool name used by this client.

Parameters:

poolName - set the name of the GemFire Pool used by the GemFire Client Cache.

setReadyForEvents

public void setReadyForEvents(Boolean readyForEvents)

Set the readyForEvents flag.

Parameters:

readyForEvents - sets a boolean flag to notify the server that this durable client is ready to receive updates.

See Also:

getReadyForEvents()

getReadyForEvents

public Boolean getReadyForEvents()

Gets the value for the readyForEvents property.

Returns:

a boolean value indicating the state of the 'readyForEvents' property.

setUseClusterConfiguration

public final void setUseClusterConfiguration(Boolean useClusterConfiguration)

Description copied from class: CacheFactoryBean

Sets the state of the use-shared-configuration GemFire distribution config setting.

Overrides:

setUseClusterConfiguration in class CacheFactoryBean

Parameters:

useClusterConfiguration - a boolean value to set the use-shared-configuration GemFire distribution property.

getUseClusterConfiguration

public final Boolean getUseClusterConfiguration()

Description copied from class: CacheFactoryBean

Gets the value fo the use-shared-configuration GemFire setting.

Overrides:

getUseClusterConfiguration in class CacheFactoryBean

Returns:

a boolean value indicating whether shared configuration use has been enabled or not.