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<Cache>, InitializingBean, PersistenceExceptionTranslator

public class ClientCacheFactoryBean
extends CacheFactoryBean

FactoryBean dedicated to creating client caches (caches for client JVMs). Acts an utility class (as client caches are a subset with a particular configuration of the generic cache).

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, beanName, cache, cacheXml, close, copyOnRead, criticalHeapPercentage, dynamicRegionSupport, enableAutoReconnect, evictionHeapPercentage, factoryLocator, gatewayConflictResolver, jndiDataSources, lazyInitialize, lockLease, lockTimeout, log, messageSyncInterval, pdxDiskStoreName, pdxIgnoreUnreadFields, pdxPersistent, pdxReadSerialized, pdxSerializer, properties, searchTimeout, transactionListeners, transactionWriter, useBeanFactoryLocator, useClusterConfiguration, VALID_JNDI_DATASOURCE_TYPE_NAMES

Constructor Summary

Constructors

Constructor and Description
ClientCacheFactoryBean()

Method Summary

Modifier and Type	Method and Description
protected void	applyPdxOptions(Object factory) Sets the PDX properties for the given object.
protected GemFireCache	createCache(Object factory)
protected Object	createFactory(Properties gemfireProperties)
protected GemFireCache	fetchCache()
Boolean	getEnableAutoReconnect() Gets the value for the auto-reconnect setting.
Boolean	getReadyForEvents() Gets the value for the readyForEvents property.
Boolean	getUseClusterConfiguration() Gets the value fo the use-shared-configuration GemFire setting.
protected void	postProcessPropertiesBeforeInitialization(Properties gemfireProperties)
void	setEnableAutoReconnect(Boolean enableAutoReconnect) Controls whether auto-reconnect functionality introduced in GemFire 8 is enabled or not.
void	setPool(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, getObjectType, getPdxDiskStoreName, getPdxIgnoreUnreadFields, getPdxPersistent, getPdxReadSerialized, getPdxSerializer, getProperties, getSearchTimeout, getTransactionListeners, getTransactionWriter, isLazyInitialize, isSingleton, registerTransactionListeners, registerTransactionWriter, 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

createCache

protected GemFireCache createCache(Object factory)

Overrides:

createCache in class CacheFactoryBean

createFactory

protected Object createFactory(Properties gemfireProperties)

Overrides:

createFactory in class CacheFactoryBean

fetchCache

protected GemFireCache fetchCache()

Overrides:

fetchCache in class CacheFactoryBean

applyPdxOptions

protected void applyPdxOptions(Object factory)

Description copied from class: CacheFactoryBean

Sets the PDX properties for the given object. Note this is implementation specific as it depends on the type of the factory passed in.

Overrides:

applyPdxOptions in class CacheFactoryBean

Parameters:

factory - the GemFire CacheFactory used to apply the PDX configuration settings.

postProcessPropertiesBeforeInitialization

protected void postProcessPropertiesBeforeInitialization(Properties gemfireProperties)

Overrides:

postProcessPropertiesBeforeInitialization in class CacheFactoryBean

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.

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.

setPool

public void setPool(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.

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.

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.