ClientCacheFactoryBean (Spring Data for Apache Geode Parent 2.4.3 API)

java.lang.Object
- org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<org.apache.geode.cache.GemFireCache>
- - org.springframework.data.gemfire.CacheFactoryBean
  - - org.springframework.data.gemfire.client.ClientCacheFactoryBean

All Implemented Interfaces:

EventListener, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<org.apache.geode.cache.GemFireCache>, InitializingBean, ApplicationListener<ContextRefreshedEvent>, Phased, PersistenceExceptionTranslator
```
public class ClientCacheFactoryBean
extends CacheFactoryBean
implements ApplicationListener<ContextRefreshedEvent>
```
Spring FactoryBean used to construct, configure and initialize a ClientCache.

Since:

1.0.0

Author:

Costin Leau, Lyndon Adams, John Blum

See Also:

InetSocketAddress, Properties, GemFireCache, ClientCache, ClientCacheFactory, Pool, DistributedSystem, PdxSerializer, BeanFactory, FactoryBean, ApplicationContext, ApplicationListener, ContextRefreshedEvent, CacheFactoryBean, ClientCacheConfigurer

Nested Class Summary
- Nested classes/interfaces inherited from class org.springframework.data.gemfire.CacheFactoryBean
  CacheFactoryBean.CacheFactoryInitializer<T>, CacheFactoryBean.JndiDataSource

Field Summary

Fields
Modifier and Type Field and Description

protected static PoolResolver DEFAULT_POOL_RESOLVER
- Fields inherited from class org.springframework.data.gemfire.CacheFactoryBean
  beanFactoryLocator
- Fields inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport
  DEFAULT_SINGLETON
- Fields inherited from interface org.springframework.beans.factory.FactoryBean
  OBJECT_TYPE_ATTRIBUTE

Fields
Modifier and Type	Field and Description
`protected static PoolResolver`	`DEFAULT_POOL_RESOLVER`

Constructor Summary

Constructors
Constructor and Description

ClientCacheFactoryBean()

Constructors
Constructor and Description
`ClientCacheFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLocators(ConnectionEndpoint... locators)`
`void`	`addLocators(Iterable<ConnectionEndpoint> locators)`
`void`	`addServers(ConnectionEndpoint... servers)`
`void`	`addServers(Iterable<ConnectionEndpoint> servers)`
`protected void`	`applyCacheConfigurers()` Applies the composite `ClientCacheConfigurers` to this `ClientCacheFactoryBean`.
`protected void`	`applyClientCacheConfigurers(ClientCacheConfigurer... clientCacheConfigurers)` Null-safe operation to apply the given array of `ClientCacheConfigurers` to this `ClientCacheFactoryBean`.
`protected void`	`applyClientCacheConfigurers(Iterable<ClientCacheConfigurer> clientCacheConfigurers)` Null-safe operation to apply the given `Iterable` of `ClientCacheConfigurers` to this `ClientCacheFactoryBean`.
`protected void`	`close(org.apache.geode.cache.GemFireCache cache)` Null-safe internal method used to close the `ClientCache` and preserve durability.
`protected Object`	`configureFactory(Object factory)` Configures the `ClientCacheFactory` used to create the `ClientCache`.
`protected <T extends org.apache.geode.cache.GemFireCache> T`	`createCache(Object factory)` Creates a new `ClientCache` instance using the provided factory.
`protected Object`	`createFactory(Properties gemfireProperties)` Constructs a new instance of `ClientCacheFactory` initialized with the given Pivotal GemFire/Apache Geode `Properties` used to construct, configure and initialize an instance of a `ClientCache`.
`protected <T extends org.apache.geode.cache.GemFireCache> T`	`fetchCache()` Fetches an existing `ClientCache` instance from the `ClientCacheFactory`.
`protected <T extends org.apache.geode.cache.GemFireCache> T`	`getCache()` Returns a direct reference to the constructed, configured an initialized `Cache` created by this `CacheFactoryBean`.
`ClientCacheConfigurer`	`getCompositeClientCacheConfigurer()` Returns a reference to the Composite `ClientCacheConfigurer` used to apply additional configuration to this `ClientCacheFactoryBean` on Spring container initialization.
`String`	`getDurableClientId()` Gets the value of the GemFire System property 'durable-client-id' indicating to the server whether this client is durable.
`Integer`	`getDurableClientTimeout()` Get the value of the GemFire System property 'durable-client-timeout' indicating to the server how long to track events for the durable client when disconnected.
`Boolean`	`getEnableAutoReconnect()` Gets the value for the auto-reconnect setting.
`Integer`	`getFreeConnectionTimeout()`
`Long`	`getIdleTimeout()`
`Boolean`	`getKeepAlive()` Gets the user specified value for whether the server(s) should keep the durable client's queue alive for the duration of the timeout when the client voluntarily disconnects.
`Integer`	`getLoadConditioningInterval()`
`protected ConnectionEndpointList`	`getLocators()`
`Integer`	`getMaxConnections()`
`Integer`	`getMinConnections()`
`Boolean`	`getMultiUserAuthentication()`
`Class<? extends org.apache.geode.cache.GemFireCache>`	`getObjectType()` Returns the `Class` type of the `GemFireCache` produced by this `ClientCacheFactoryBean`.
`Long`	`getPingInterval()`
`org.apache.geode.cache.client.Pool`	`getPool()` Gets the `Pool` used by this `ClientCache` to obtain connections to the Apache Geode cluster.
`String`	`getPoolName()` Gets the `name` of the `Pool` used by this `ClientCache` to obtain connections to the Apache Geode cluster.
`PoolResolver`	`getPoolResolver()` Gets the configured `PoolResolver` used by this `ClientCache` to resolve `Pool` objects.
`Boolean`	`getPrSingleHopEnabled()`
`Integer`	`getReadTimeout()`
`Boolean`	`getReadyForEvents()` Gets the user-specified value for the readyForEvents property.
`Integer`	`getRetryAttempts()`
`Integer`	`getServerConnectionTimeout()`
`String`	`getServerGroup()`
`protected ConnectionEndpointList`	`getServers()`
`Integer`	`getSocketBufferSize()`
`Integer`	`getSocketConnectTimeout()`
`org.apache.geode.cache.client.SocketFactory`	`getSocketFactory()`
`Integer`	`getStatisticsInterval()`
`Integer`	`getSubscriptionAckInterval()`
`Boolean`	`getSubscriptionEnabled()`
`Integer`	`getSubscriptionMessageTrackingTimeout()`
`Integer`	`getSubscriptionRedundancy()`
`Boolean`	`getThreadLocalConnections()`
`Boolean`	`getUseClusterConfiguration()` Return the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.
`boolean`	`isKeepAlive()` Determines whether the server(s) should keep the durable client's queue alive for the duration of the timeout when the client voluntarily disconnects.
`boolean`	`isReadyForEvents()` Determines whether this GemFire cache client is ready for events.
`void`	`onApplicationEvent(ContextRefreshedEvent event)` Inform the Pivotal GemFire/Apache Geode cluster that this cache client is ready to receive events iff the client is non-durable.
`protected Properties`	`resolveProperties()` Resolves the Pivotal GemFire/Apache Geode `Properties` used to configure the `ClientCache`.
`protected void`	`setCache(org.apache.geode.cache.GemFireCache cache)` Sets a reference to the constructed, configured an initialized `Cache` created by this `CacheFactoryBean`.
`void`	`setClientCacheConfigurers(ClientCacheConfigurer... clientCacheConfigurers)` Null-safe operation to set an array of `ClientCacheConfigurers` used to apply additional configuration to this `ClientCacheFactoryBean` when using Annotation-based configuration.
`void`	`setClientCacheConfigurers(List<ClientCacheConfigurer> peerCacheConfigurers)` Null-safe operation to set an `Iterable` of `ClientCacheConfigurers` to apply additional configuration to this `ClientCacheFactoryBean` when using Annotation-based configuration.
`void`	`setDurableClientId(String durableClientId)` Set the GemFire System property 'durable-client-id' to indicate to the server that this client is durable.
`void`	`setDurableClientTimeout(Integer durableClientTimeout)` Set the GemFire System property 'durable-client-timeout' indicating to the server how long to track events for the durable client when disconnected.
`void`	`setEnableAutoReconnect(Boolean enableAutoReconnect)` Controls whether auto-reconnect functionality introduced in GemFire 8 is enabled or not.
`void`	`setFreeConnectionTimeout(Integer freeConnectionTimeout)`
`void`	`setIdleTimeout(Long idleTimeout)`
`void`	`setKeepAlive(Boolean keepAlive)` Sets whether the server(s) should keep the durable client's queue alive for the duration of the timeout when the client voluntarily disconnects.
`void`	`setLoadConditioningInterval(Integer loadConditioningInterval)`
`void`	`setLocators(ConnectionEndpoint[] locators)`
`void`	`setLocators(Iterable<ConnectionEndpoint> locators)`
`void`	`setMaxConnections(Integer maxConnections)`
`void`	`setMinConnections(Integer minConnections)`
`void`	`setMultiUserAuthentication(Boolean multiUserAuthentication)`
`void`	`setPingInterval(Long pingInterval)`
`void`	`setPool(org.apache.geode.cache.client.Pool pool)` Sets the `Pool` used by this `ClientCache` to obtain connections to the Apache Geode cluster.
`void`	`setPoolName(String poolName)` Sets the `name` of the `Pool` used by this `ClientCache` to obtain connections to the Apache Geode cluster.
`void`	`setPoolResolver(PoolResolver poolResolver)` Sets (configures) the `PoolResolver` used by this `ClientCache` to resolve `Pool` objects.
`void`	`setPrSingleHopEnabled(Boolean prSingleHopEnabled)`
`void`	`setReadTimeout(Integer readTimeout)`
`void`	`setReadyForEvents(Boolean readyForEvents)` Sets the readyForEvents property to indicate whether the cache client should notify the server that it is ready to receive updates.
`void`	`setRetryAttempts(Integer retryAttempts)`
`void`	`setServerConnectionTimeout(Integer serverConnectionTimeout)`
`void`	`setServerGroup(String serverGroup)`
`void`	`setServers(ConnectionEndpoint[] servers)`
`void`	`setServers(Iterable<ConnectionEndpoint> servers)`
`void`	`setSocketBufferSize(Integer socketBufferSize)`
`void`	`setSocketConnectTimeout(Integer socketConnectTimeout)`
`void`	`setSocketFactory(org.apache.geode.cache.client.SocketFactory socketFactory)`
`void`	`setStatisticsInterval(Integer statisticsInterval)`
`void`	`setSubscriptionAckInterval(Integer subscriptionAckInterval)`
`void`	`setSubscriptionEnabled(Boolean subscriptionEnabled)`
`void`	`setSubscriptionMessageTrackingTimeout(Integer subscriptionMessageTrackingTimeout)`
`void`	`setSubscriptionRedundancy(Integer subscriptionRedundancy)`
`void`	`setThreadLocalConnections(Boolean threadLocalConnections)`
`void`	`setUseClusterConfiguration(Boolean useClusterConfiguration)` Sets the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.

Methods inherited from class org.springframework.data.gemfire.CacheFactoryBean
afterPropertiesSet, applyPeerCacheConfigurers, applyPeerCacheConfigurers, destroy, getBeanFactoryLocator, getCacheFactoryInitializer, getCacheXml, getCompositePeerCacheConfigurer, getCopyOnRead, getCriticalHeapPercentage, getCriticalOffHeapPercentage, getEvictionHeapPercentage, getEvictionOffHeapPercentage, getGatewayConflictResolver, getJndiDataSources, getLockLease, getLockTimeout, getMessageSyncInterval, getObject, getPdxDiskStoreName, getPdxIgnoreUnreadFields, getPdxPersistent, getPdxReadSerialized, getPdxSerializer, getPhase, getProperties, getSearchTimeout, getSecurityManager, getTransactionListeners, getTransactionWriter, initializeFactory, isClose, isUseBeanFactoryLocator, postProcess, postProcess, resolveCache, setAndGetProperties, setCacheFactoryInitializer, setCacheXml, setClose, setCopyOnRead, setCriticalHeapPercentage, setCriticalOffHeapPercentage, setEvictionHeapPercentage, setEvictionOffHeapPercentage, setGatewayConflictResolver, setJndiDataSources, setLockLease, setLockTimeout, setMessageSyncInterval, setPdxDiskStoreName, setPdxIgnoreUnreadFields, setPdxPersistent, setPdxReadSerialized, setPdxSerializer, setPeerCacheConfigurers, setPeerCacheConfigurers, setPhase, setProperties, setSearchTimeout, setSecurityManager, setTransactionListeners, setTransactionWriter, setUseBeanFactoryLocator, translateExceptionIfPossible

Methods inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport
getBeanClassLoader, getBeanFactory, getBeanName, getLog, isSingleton, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarning, logWarning, newLog, setBeanClassLoader, setBeanFactory, setBeanName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.context.ApplicationListener
forPayload

- Field Detail
  - DEFAULT_POOL_RESOLVER
```
protected static final PoolResolver DEFAULT_POOL_RESOLVER
```
- Constructor Detail
  - ClientCacheFactoryBean
```
public ClientCacheFactoryBean()
```
- Method Detail
  - applyCacheConfigurers
```
protected void applyCacheConfigurers()
```
    Applies the composite ClientCacheConfigurers to this ClientCacheFactoryBean.
    
    Overrides:
    
    applyCacheConfigurers in class CacheFactoryBean
    
    See Also:
    
    getCompositeClientCacheConfigurer(), applyClientCacheConfigurers(ClientCacheConfigurer...)
  - applyClientCacheConfigurers
```
protected void applyClientCacheConfigurers(ClientCacheConfigurer... clientCacheConfigurers)
```
    Null-safe operation to apply the given array of ClientCacheConfigurers to this ClientCacheFactoryBean.
    
    Parameters:
    
    clientCacheConfigurers - array of ClientCacheConfigurers applied to this ClientCacheFactoryBean.
    
    See Also:
    
    ClientCacheConfigurer, applyClientCacheConfigurers(Iterable)
  - applyClientCacheConfigurers
```
protected void applyClientCacheConfigurers(Iterable<ClientCacheConfigurer> clientCacheConfigurers)
```
    Null-safe operation to apply the given Iterable of ClientCacheConfigurers to this ClientCacheFactoryBean.
    
    Parameters:
    
    clientCacheConfigurers - Iterable of ClientCacheConfigurers applied to this ClientCacheFactoryBean.
    
    See Also:
    
    ClientCacheConfigurer, Iterable
  - fetchCache
```
protected <T extends org.apache.geode.cache.GemFireCache> T fetchCache()
```
    Fetches an existing ClientCache instance from the ClientCacheFactory.
    
    Overrides:
    
    fetchCache in class CacheFactoryBean
    
    Type Parameters:
    
    T - parameterized Class type extension of GemFireCache.
    
    Returns:
    
    an existing ClientCache instance if available.
    
    Throws:
    
    org.apache.geode.cache.CacheClosedException - if an existing ClientCache instance does not exist.
    
    See Also:
    
    ClientCacheFactory.getAnyInstance(), GemFireCache, getCache()
  - resolveProperties
```
protected Properties resolveProperties()
```
    Resolves the Pivotal GemFire/Apache Geode Properties used to configure the ClientCache.
    
    Overrides:
    
    resolveProperties in class CacheFactoryBean
    
    Returns:
    
    the resolved Pivotal GemFire/Apache Geode Properties used to configure the ClientCache.
    
    See Also:
    
    DistributedSystem.getProperties(), getDistributedSystem()
  - createFactory
```
protected Object createFactory(Properties gemfireProperties)
```
    Constructs a new instance of ClientCacheFactory initialized with the given Pivotal GemFire/Apache Geode Properties used to construct, configure and initialize an instance of a ClientCache.
    
    Overrides:
    
    createFactory in class CacheFactoryBean
    
    Parameters:
    
    gemfireProperties - Properties used by the ClientCacheFactory to configure the ClientCache.
    
    Returns:
    
    a new instance of ClientCacheFactory initialized with the given Pivotal GemFire/Apache Geode Properties.
    
    See Also:
    
    ClientCacheFactory, Properties
  - configureFactory
```
protected Object configureFactory(Object factory)
```
    Configures the ClientCacheFactory used to create the ClientCache. Sets PDX options specified by the user. Sets Pool options specified by the user.
    
    Overrides:
    
    configureFactory in class CacheFactoryBean
    
    Parameters:
    
    factory - ClientCacheFactory used to create the ClientCache.
    
    Returns:
    
    the configured ClientCacheFactory.
    
    See Also:
    
    configurePdx(ClientCacheFactory)
  - createCache
```
protected <T extends org.apache.geode.cache.GemFireCache> T createCache(Object factory)
```
    Creates a new ClientCache instance using the provided factory.
    
    Overrides:
    
    createCache in class CacheFactoryBean
    
    Type Parameters:
    
    T - parameterized Class type extension of GemFireCache.
    
    Parameters:
    
    factory - instance of ClientCacheFactory.
    
    Returns:
    
    a new instance of ClientCache created by the provided factory.
    
    See Also:
    
    ClientCacheFactory.create(), GemFireCache
  - onApplicationEvent
```
public void onApplicationEvent(ContextRefreshedEvent event)
```
    Inform the Pivotal GemFire/Apache Geode cluster that this cache client is ready to receive events iff the client is non-durable.
    
    Specified by:
    
    onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>
    
    Parameters:
    
    event - ApplicationContextEvent fired when the ApplicationContext is refreshed.
    
    See Also:
    
    ClientCache.readyForEvents(), isReadyForEvents(), fetchCache()
  - close
```
protected void close(org.apache.geode.cache.GemFireCache cache)
```
    Null-safe internal method used to close the ClientCache and preserve durability.
    
    Overrides:
    
    close in class CacheFactoryBean
    
    Parameters:
    
    cache - GemFireCache to close.
    
    See Also:
    
    ClientCache.close(boolean), isKeepAlive()
  - setCache
```
protected void setCache(org.apache.geode.cache.GemFireCache cache)
```
    Description copied from class: CacheFactoryBean
    
    Sets a reference to the constructed, configured an initialized Cache created by this CacheFactoryBean.
    
    Overrides:
    
    setCache in class CacheFactoryBean
    
    Parameters:
    
    cache - Cache created by this CacheFactoryBean.
    
    See Also:
    
    Cache
  - getCache
```
protected <T extends org.apache.geode.cache.GemFireCache> T getCache()
```
    Description copied from class: CacheFactoryBean
    
    Returns a direct reference to the constructed, configured an initialized Cache created by this CacheFactoryBean.
    
    Overrides:
    
    getCache in class CacheFactoryBean
    
    Returns:
    
    a direct reference to the Cache created by this CacheFactoryBean.
    
    See Also:
    
    Cache
  - getObjectType
```
public Class<? extends org.apache.geode.cache.GemFireCache> getObjectType()
```
    Returns the Class type of the GemFireCache produced by this ClientCacheFactoryBean.
    
    Specified by:
    
    getObjectType in interface FactoryBean<org.apache.geode.cache.GemFireCache>
    
    Overrides:
    
    getObjectType in class CacheFactoryBean
    
    Returns:
    
    the Class type of the GemFireCache produced by this ClientCacheFactoryBean.
    
    See Also:
    
    FactoryBean.getObjectType()
  - addLocators
```
public void addLocators(ConnectionEndpoint... locators)
```
  - addLocators
```
public void addLocators(Iterable<ConnectionEndpoint> locators)
```
  - addServers
```
public void addServers(ConnectionEndpoint... servers)
```
  - addServers
```
public void addServers(Iterable<ConnectionEndpoint> servers)
```
  - setClientCacheConfigurers
```
public void setClientCacheConfigurers(ClientCacheConfigurer... clientCacheConfigurers)
```
    Null-safe operation to set an array of ClientCacheConfigurers used to apply additional configuration to this ClientCacheFactoryBean when using Annotation-based configuration.
    
    Parameters:
    
    clientCacheConfigurers - array of ClientCacheConfigurers used to apply additional configuration to this ClientCacheFactoryBean.
    
    See Also:
    
    ClientCacheConfigurer, setClientCacheConfigurers(List)
  - setClientCacheConfigurers
```
public void setClientCacheConfigurers(List<ClientCacheConfigurer> peerCacheConfigurers)
```
    Null-safe operation to set an Iterable of ClientCacheConfigurers to apply additional configuration to this ClientCacheFactoryBean when using Annotation-based configuration.
    
    Parameters:
    
    peerCacheConfigurers - Iterable of ClientCacheConfigurers used to apply additional configuration to this ClientCacheFactoryBean.
    
    See Also:
    
    ClientCacheConfigurer
  - getCompositeClientCacheConfigurer
```
public ClientCacheConfigurer getCompositeClientCacheConfigurer()
```
    Returns a reference to the Composite ClientCacheConfigurer used to apply additional configuration to this ClientCacheFactoryBean on Spring container initialization.
    
    Returns:
    
    the Composite ClientCacheConfigurer.
    
    See Also:
    
    ClientCacheConfigurer
  - setDurableClientId
```
public void setDurableClientId(String durableClientId)
```
    Set the GemFire System property 'durable-client-id' to indicate to the server that this client is durable.
    
    Parameters:
    
    durableClientId - a String value indicating the durable client id.
  - getDurableClientId
```
public String getDurableClientId()
```
    Gets the value of the GemFire System property 'durable-client-id' indicating to the server whether this client is durable.
    
    Returns:
    
    a String value indicating the durable client id.
  - setDurableClientTimeout
```
public void setDurableClientTimeout(Integer durableClientTimeout)
```
    Set the GemFire System property 'durable-client-timeout' indicating to the server how long to track events for the durable client when disconnected.
    
    Parameters:
    
    durableClientTimeout - an Integer value indicating the timeout in seconds for the server to keep the durable client's queue around.
  - getDurableClientTimeout
```
public Integer getDurableClientTimeout()
```
    Get the value of the GemFire System property 'durable-client-timeout' indicating to the server how long to track events for the durable client when disconnected.
    
    Returns:
    
    an Integer value indicating the timeout in seconds for the server to keep the durable client's queue around.
  - 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.
  - setFreeConnectionTimeout
```
public void setFreeConnectionTimeout(Integer freeConnectionTimeout)
```
  - getFreeConnectionTimeout
```
public Integer getFreeConnectionTimeout()
```
  - setIdleTimeout
```
public void setIdleTimeout(Long idleTimeout)
```
  - getIdleTimeout
```
public Long getIdleTimeout()
```
  - setKeepAlive
```
public void setKeepAlive(Boolean keepAlive)
```
    Sets whether the server(s) should keep the durable client's queue alive for the duration of the timeout when the client voluntarily disconnects.
    
    Parameters:
    
    keepAlive - a boolean value indicating to the server to keep the durable client's queues alive.
  - getKeepAlive
```
public Boolean getKeepAlive()
```
    Gets the user specified value for whether the server(s) should keep the durable client's queue alive for the duration of the timeout when the client voluntarily disconnects.
    
    Returns:
    
    a boolean value indicating whether the server should keep the durable client's queues alive.
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Determines whether the server(s) should keep the durable client's queue alive for the duration of the timeout when the client voluntarily disconnects.
    
    Returns:
    
    a boolean value indicating whether the server should keep the durable client's queues alive.
  - setLoadConditioningInterval
```
public void setLoadConditioningInterval(Integer loadConditioningInterval)
```
  - getLoadConditioningInterval
```
public Integer getLoadConditioningInterval()
```
  - setLocators
```
public void setLocators(ConnectionEndpoint[] locators)
```
  - setLocators
```
public void setLocators(Iterable<ConnectionEndpoint> locators)
```
  - getLocators
```
protected ConnectionEndpointList getLocators()
```
  - setMaxConnections
```
public void setMaxConnections(Integer maxConnections)
```
  - getMaxConnections
```
public Integer getMaxConnections()
```
  - setMinConnections
```
public void setMinConnections(Integer minConnections)
```
  - getMinConnections
```
public Integer getMinConnections()
```
  - setMultiUserAuthentication
```
public void setMultiUserAuthentication(Boolean multiUserAuthentication)
```
  - getMultiUserAuthentication
```
public Boolean getMultiUserAuthentication()
```
  - setPool
```
public void setPool(@Nullable
                    org.apache.geode.cache.client.Pool pool)
```
    Sets the Pool used by this ClientCache to obtain connections to the Apache Geode cluster.
    
    Parameters:
    
    pool - Pool used by this ClientCache to obtain connections to the Apache Geode cluster.
    
    See Also:
    
    Pool
  - getPool
```
@Nullable
public org.apache.geode.cache.client.Pool getPool()
```
    Gets the Pool used by this ClientCache to obtain connections to the Apache Geode cluster.
    
    Returns:
    
    Pool used by this ClientCache to obtain connections to the Apache Geode cluster.
    
    See Also:
    
    Pool
  - setPoolName
```
public void setPoolName(@Nullable
                        String poolName)
```
    Sets the name of the Pool used by this ClientCache to obtain connections to the Apache Geode cluster.
    
    Parameters:
    
    poolName - name of the Pool used by this ClientCache to obtain connections to the Apache Geode cluster.
  - getPoolName
```
@Nullable
public String getPoolName()
```
    Gets the name of the Pool used by this ClientCache to obtain connections to the Apache Geode cluster.
    
    Returns:
    
    name of the Pool used by this ClientCache to obtain connections to the Apache Geode cluster.
  - setPoolResolver
```
public void setPoolResolver(@Nullable
                            PoolResolver poolResolver)
```
    Sets (configures) the PoolResolver used by this ClientCache to resolve Pool objects. The Pool objects may be managed or un-managed depending on the PoolResolver implementation.
    
    Parameters:
    
    poolResolver - PoolResolver used to resolve the configured Pool.
    
    See Also:
    
    PoolResolver
  - getPoolResolver
```
@NonNull
public PoolResolver getPoolResolver()
```
    Gets the configured PoolResolver used by this ClientCache to resolve Pool objects.
    
    Returns:
    
    the configured PoolResolver. If no PoolResolver was configured, then return the default, PoolManagerPoolResolver.
    
    See Also:
    
    PoolResolver, PoolManagerPoolResolver
  - setPingInterval
```
public void setPingInterval(Long pingInterval)
```
  - getPingInterval
```
public Long getPingInterval()
```
  - setPrSingleHopEnabled
```
public void setPrSingleHopEnabled(Boolean prSingleHopEnabled)
```
  - getPrSingleHopEnabled
```
public Boolean getPrSingleHopEnabled()
```
  - setReadTimeout
```
public void setReadTimeout(Integer readTimeout)
```
  - getReadTimeout
```
public Integer getReadTimeout()
```
  - setReadyForEvents
```
public void setReadyForEvents(Boolean readyForEvents)
```
    Sets the readyForEvents property to indicate whether the cache client should notify the server that it is ready to receive updates.
    
    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 user-specified value for the readyForEvents property.
    
    Returns:
    
    a boolean value indicating the state of the 'readyForEvents' property.
  - isReadyForEvents
```
public boolean isReadyForEvents()
```
    Determines whether this GemFire cache client is ready for events. If 'readyForEvents' was explicitly set, then it takes precedence over all other considerations (e.g. durability).
    
    Returns:
    
    a boolean value indicating whether this GemFire cache client is ready for events.
    
    See Also:
    
    CacheUtils.isDurable(ClientCache), getReadyForEvents()
  - setRetryAttempts
```
public void setRetryAttempts(Integer retryAttempts)
```
  - getRetryAttempts
```
public Integer getRetryAttempts()
```
  - setServerConnectionTimeout
```
public void setServerConnectionTimeout(Integer serverConnectionTimeout)
```
  - getServerConnectionTimeout
```
public Integer getServerConnectionTimeout()
```
  - setServerGroup
```
public void setServerGroup(String serverGroup)
```
  - getServerGroup
```
public String getServerGroup()
```
  - setServers
```
public void setServers(ConnectionEndpoint[] servers)
```
  - setServers
```
public void setServers(Iterable<ConnectionEndpoint> servers)
```
  - getServers
```
protected ConnectionEndpointList getServers()
```
  - setSocketBufferSize
```
public void setSocketBufferSize(Integer socketBufferSize)
```
  - getSocketBufferSize
```
public Integer getSocketBufferSize()
```
  - setSocketConnectTimeout
```
public void setSocketConnectTimeout(Integer socketConnectTimeout)
```
  - getSocketConnectTimeout
```
public Integer getSocketConnectTimeout()
```
  - setSocketFactory
```
public void setSocketFactory(@Nullable
                             org.apache.geode.cache.client.SocketFactory socketFactory)
```
  - getSocketFactory
```
@NonNull
public org.apache.geode.cache.client.SocketFactory getSocketFactory()
```
  - setStatisticsInterval
```
public void setStatisticsInterval(Integer statisticsInterval)
```
  - getStatisticsInterval
```
public Integer getStatisticsInterval()
```
  - setSubscriptionAckInterval
```
public void setSubscriptionAckInterval(Integer subscriptionAckInterval)
```
  - getSubscriptionAckInterval
```
public Integer getSubscriptionAckInterval()
```
  - setSubscriptionEnabled
```
public void setSubscriptionEnabled(Boolean subscriptionEnabled)
```
  - getSubscriptionEnabled
```
public Boolean getSubscriptionEnabled()
```
  - setSubscriptionMessageTrackingTimeout
```
public void setSubscriptionMessageTrackingTimeout(Integer subscriptionMessageTrackingTimeout)
```
  - getSubscriptionMessageTrackingTimeout
```
public Integer getSubscriptionMessageTrackingTimeout()
```
  - setSubscriptionRedundancy
```
public void setSubscriptionRedundancy(Integer subscriptionRedundancy)
```
  - getSubscriptionRedundancy
```
public Integer getSubscriptionRedundancy()
```
  - setThreadLocalConnections
```
public void setThreadLocalConnections(Boolean threadLocalConnections)
```
  - getThreadLocalConnections
```
public Boolean getThreadLocalConnections()
```
  - setUseClusterConfiguration
```
public final void setUseClusterConfiguration(Boolean useClusterConfiguration)
```
    Description copied from class: CacheFactoryBean
    
    Sets the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.
    
    Overrides:
    
    setUseClusterConfiguration in class CacheFactoryBean
    
    Parameters:
    
    useClusterConfiguration - boolean value to set the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.
  - getUseClusterConfiguration
```
public final Boolean getUseClusterConfiguration()
```
    Description copied from class: CacheFactoryBean
    
    Return the state of the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.
    
    Overrides:
    
    getUseClusterConfiguration in class CacheFactoryBean
    
    Returns:
    
    the current boolean value for the use-shared-configuration Pivotal GemFire/Apache Geode distribution configuration setting.

Class ClientCacheFactoryBean

Nested Class Summary

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

Field Summary

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

Fields inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

Fields inherited from interface org.springframework.beans.factory.FactoryBean

Constructor Summary

Method Summary

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

Methods inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.context.ApplicationListener

Field Detail

DEFAULT_POOL_RESOLVER

Constructor Detail

ClientCacheFactoryBean

Method Detail

applyCacheConfigurers

applyClientCacheConfigurers

applyClientCacheConfigurers

fetchCache

resolveProperties

createFactory

configureFactory

createCache

onApplicationEvent

close

setCache

getCache

getObjectType

addLocators

addLocators

addServers

addServers

setClientCacheConfigurers

setClientCacheConfigurers

getCompositeClientCacheConfigurer

setDurableClientId

getDurableClientId

setDurableClientTimeout

getDurableClientTimeout

setEnableAutoReconnect

getEnableAutoReconnect

setFreeConnectionTimeout

getFreeConnectionTimeout

setIdleTimeout

getIdleTimeout

setKeepAlive

getKeepAlive

isKeepAlive

setLoadConditioningInterval

getLoadConditioningInterval

setLocators

setLocators

getLocators

setMaxConnections

getMaxConnections

setMinConnections

getMinConnections

setMultiUserAuthentication

getMultiUserAuthentication

setPool

getPool

setPoolName

getPoolName

setPoolResolver

getPoolResolver

setPingInterval

getPingInterval

setPrSingleHopEnabled

getPrSingleHopEnabled

setReadTimeout

getReadTimeout

setReadyForEvents

getReadyForEvents

isReadyForEvents

setRetryAttempts

getRetryAttempts

setServerConnectionTimeout