Package org.springframework.data.gemfire.client

Class ClientCacheFactoryBean

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<GemFireCache>

org.springframework.data.gemfire.AbstractBasicCacheFactoryBean

org.springframework.data.gemfire.AbstractConfigurableCacheFactoryBean

org.springframework.data.gemfire.AbstractResolvableCacheFactoryBean

org.springframework.data.gemfire.CacheFactoryBean

org.springframework.data.gemfire.client.ClientCacheFactoryBean

All Implemented Interfaces:

EventListener, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, FactoryBean<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
• SocketFactory
• DistributedSystem
• PdxSerializer
• FactoryBean
• ApplicationContext
• ApplicationListener
• ApplicationContextEvent
• ContextRefreshedEvent
• CacheFactoryBean
• ClientCacheConfigurer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientCacheFactoryBean.ClientCacheFactoryToPdxConfigurerAdapter

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

CacheFactoryBean.CacheFactoryToPdxConfigurerAdapter, CacheFactoryBean.JndiDataSource

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

AbstractBasicCacheFactoryBean.CacheFactoryInitializer<T>, AbstractBasicCacheFactoryBean.PdxConfigurer<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final PoolResolver	DEFAULT_POOL_RESOLVER

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

DEFAULT_SINGLETON

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

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
ClientCacheFactoryBean()

Method Summary

Modifier and Type	Method	Description
void	addLocators(Iterable<ConnectionEndpoint> locators)
void	addLocators(ConnectionEndpoint... locators)
void	addServers(Iterable<ConnectionEndpoint> servers)
void	addServers(ConnectionEndpoint... servers)
protected void	applyCacheConfigurers()	Applies the composite ClientCacheConfigurers to this ClientCacheFactoryBean before the ClientCache is created.
protected void	applyClientCacheConfigurers(Iterable<ClientCacheConfigurer> clientCacheConfigurers)	Apples the Iterable of ClientCacheConfigurers to this ClientCacheFactoryBean before the ClientCache is created.
protected void	applyClientCacheConfigurers(ClientCacheConfigurer... clientCacheConfigurers)	Applies the array of ClientCacheConfigurers to this ClientCacheFactoryBean before the ClientCache is created.
protected void	close(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 ClientCacheFactory	configurePdx(ClientCacheFactory clientCacheFactory)	Configures the ClientCache to use PDX serialization.
protected ClientCacheFactory	configurePool(ClientCacheFactory clientCacheFactory)	Configure the DEFAULT Pool of the ClientCacheFactory using a given Pool instance or a named Pool instance.
protected <T extends 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 Apache Geode Properties used to construct, configure and initialize a new ClientCache instance.
protected <T extends GemFireCache> T	doFetchCache()	Fetches an existing ClientCache instance from the ClientCacheFactory.
protected Class<? extends GemFireCache>	doGetObjectType()	Returns the type of GemFireCache constructed by this ClientCacheFactoryBean.
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.
final 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()
Long	getPingInterval()
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-configured value for deciding that this client is ready to receive events from the server(s).
Integer	getRetryAttempts()
Integer	getServerConnectionTimeout()
String	getServerGroup()
protected ConnectionEndpointList	getServers()
Integer	getSocketBufferSize()
Integer	getSocketConnectTimeout()
SocketFactory	getSocketFactory()
Integer	getStatisticsInterval()
Integer	getSubscriptionAckInterval()
Boolean	getSubscriptionEnabled()
Integer	getSubscriptionMessageTrackingTimeout()
Integer	getSubscriptionRedundancy()
Boolean	getThreadLocalConnections()
final 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 Apache Geode cluster that this ClientCache is ready to receive events iff the client is non-durable.
protected Pool	resolvePool()	Resolves the Pool used to configure the ClientCache, DEFAULT Pool.
protected Properties	resolveProperties()	Resolves the Apache Geode Properties used to configure the ClientCache.
void	setClientCacheConfigurers(List<ClientCacheConfigurer> clientCacheConfigurers)	Null-safe operation to set an List of ClientCacheConfigurers to apply additional configuration to this ClientCacheFactoryBean when using Annotation-based configuration.
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	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.
final 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(Iterable<ConnectionEndpoint> locators)
void	setLocators(ConnectionEndpoint[] locators)
void	setMaxConnections(Integer maxConnections)
void	setMinConnections(Integer minConnections)
void	setMultiUserAuthentication(Boolean multiUserAuthentication)
void	setPingInterval(Long pingInterval)
void	setPool(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(Iterable<ConnectionEndpoint> servers)
void	setServers(ConnectionEndpoint[] servers)
void	setSocketBufferSize(Integer socketBufferSize)
void	setSocketConnectTimeout(Integer socketConnectTimeout)
void	setSocketFactory(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)
final 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

applyPeerCacheConfigurers, applyPeerCacheConfigurers, configurePdx, configureSecurity, getCompositePeerCacheConfigurer, getGatewayConflictResolver, getJndiDataSources, getLockLease, getLockTimeout, getMessageSyncInterval, getSearchTimeout, getSecurityManager, postProcess, setGatewayConflictResolver, setJndiDataSources, setLockLease, setLockTimeout, setMessageSyncInterval, setPeerCacheConfigurers, setPeerCacheConfigurers, setSearchTimeout, setSecurityManager

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

doGetObject, init, initializeFactory, postProcess, resolveCache

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

afterPropertiesSet, destroy, getBeanFactoryLocator, getCacheXml, getOptionalBeanFactoryLocator, getOptionalCacheXml, getProperties, isCacheXmlPresent, isCacheXmlResolvableAsAFile, isUseBeanFactoryLocator, loadCacheXml, setAndGetProperties, setBeanFactoryLocator, setCacheXml, setProperties, setUseBeanFactoryLocator

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

configureHeapPercentages, configureOffHeapPercentages, configurePdx, fetchCache, getCache, getCacheFactoryInitializer, getCopyOnRead, getCriticalHeapPercentage, getCriticalOffHeapPercentage, getEvictionHeapPercentage, getEvictionOffHeapPercentage, getObject, getObjectType, getOptionalCache, getPdxDiskStoreName, getPdxIgnoreUnreadFields, getPdxPersistent, getPdxReadSerialized, getPdxSerializer, getPhase, getTransactionListeners, getTransactionWriter, isClose, isCopyOnRead, isNotClosed, registerTransactionListeners, registerTransactionWriter, setCache, setCacheFactoryInitializer, setClose, setCopyOnRead, setCriticalHeapPercentage, setCriticalOffHeapPercentage, setEvictionHeapPercentage, setEvictionOffHeapPercentage, setPdxDiskStoreName, setPdxIgnoreUnreadFields, setPdxPersistent, setPdxReadSerialized, setPdxSerializer, setPhase, setTransactionListeners, setTransactionWriter, translateExceptionIfPossible

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

getBeanClassLoader, getBeanFactory, getBeanName, getLog, getOptionalLog, isDebugLoggingEnabled, isErrorLoggingEnabled, isInfoLoggingEnabled, isSingleton, isWarnLoggingEnabled, 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

Field Details

DEFAULT_POOL_RESOLVER

protected static final PoolResolver DEFAULT_POOL_RESOLVER

Constructor Details

ClientCacheFactoryBean

public ClientCacheFactoryBean()

Method Details

applyCacheConfigurers

protected void applyCacheConfigurers()

Applies the composite ClientCacheConfigurers to this ClientCacheFactoryBean before the ClientCache is created.

Overrides:

applyCacheConfigurers in class CacheFactoryBean

See Also:

• getCompositeClientCacheConfigurer()
• applyClientCacheConfigurers(ClientCacheConfigurer...)

applyClientCacheConfigurers

protected void applyClientCacheConfigurers(ClientCacheConfigurer... clientCacheConfigurers)

Applies the array of ClientCacheConfigurers to this ClientCacheFactoryBean before the ClientCache is created.

Parameters:

clientCacheConfigurers - array of ClientCacheConfigurers applied to this ClientCacheFactoryBean.

See Also:

• ClientCacheConfigurer
• applyClientCacheConfigurers(Iterable)

applyClientCacheConfigurers

protected void applyClientCacheConfigurers(Iterable<ClientCacheConfigurer> clientCacheConfigurers)

Apples the Iterable of ClientCacheConfigurers to this ClientCacheFactoryBean before the ClientCache is created.

Parameters:

clientCacheConfigurers - Iterable of ClientCacheConfigurers applied to this ClientCacheFactoryBean.

See Also:

• ClientCacheConfigurer
• Iterable

doFetchCache

protected <T extends GemFireCache> T doFetchCache()

Fetches an existing ClientCache instance from the ClientCacheFactory.

Overrides:

doFetchCache in class CacheFactoryBean

Type Parameters:

T - parameterized Class type extension of GemFireCache.

Returns:

an existing ClientCache instance if available.

Throws:

CacheClosedException - if an existing ClientCache instance does not exist.

See Also:

• ClientCacheFactory.getAnyInstance()
• GemFireCache
• AbstractBasicCacheFactoryBean.getCache()

doGetObjectType

protected Class<? extends GemFireCache> doGetObjectType()

Returns the type of GemFireCache constructed by this ClientCacheFactoryBean. Returns ClientCache Class.

Overrides:

doGetObjectType in class CacheFactoryBean

Returns:

the type of GemFireCache constructed by this ClientCacheFactoryBean.

See Also:

• FactoryBean.getObjectType()

resolveProperties

@NonNull
protected Properties resolveProperties()

Resolves the Apache Geode Properties used to configure the ClientCache.

Overrides:

resolveProperties in class AbstractConfigurableCacheFactoryBean

Returns:

the resolved Apache Geode Properties used to configure the ClientCache.

See Also:

• DistributedSystem.getProperties()

createFactory

@NonNull
protected Object createFactory(@NonNull
 Properties gemfireProperties)

Constructs a new instance of ClientCacheFactory initialized with the given Apache Geode Properties used to construct, configure and initialize a new ClientCache instance.

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 Apache Geode Properties.

See Also:

• ClientCacheFactory
• Properties

configureFactory

@NonNull
protected Object configureFactory(@NonNull
 Object factory)

Configures the ClientCacheFactory used to create the ClientCache.

Overrides:

configureFactory in class CacheFactoryBean

Parameters:

factory - ClientCacheFactory used to create the ClientCache.

Returns:

the configured ClientCacheFactory.

See Also:

• ClientCacheFactory
• configurePool(ClientCacheFactory)
• AbstractBasicCacheFactoryBean.configurePdx(PdxConfigurer)

configurePdx

@NonNull
protected ClientCacheFactory configurePdx(@NonNull
 ClientCacheFactory clientCacheFactory)

Configures the ClientCache to use PDX serialization.

Parameters:

clientCacheFactory - ClientCacheFactory to configure with PDX.

Returns:

the given ClientCacheFactory.

See Also:

• ClientCacheFactoryBean.ClientCacheFactoryToPdxConfigurerAdapter
• ClientCacheFactory
• AbstractBasicCacheFactoryBean.configurePdx(PdxConfigurer)

configurePool

@NonNull
protected ClientCacheFactory configurePool(@NonNull
 ClientCacheFactory clientCacheFactory)

Configure the DEFAULT Pool of the ClientCacheFactory using a given Pool instance or a named Pool instance.

Parameters:

clientCacheFactory - ClientCacheFactory used to configure the DEFAULT Pool.

See Also:

• ClientCacheFactory
• Pool

resolvePool

@Nullable
protected Pool resolvePool()

Resolves the Pool used to configure the ClientCache, DEFAULT Pool.

Returns:

the resolved Pool used to configure the ClientCache, DEFAULT Pool.

See Also:

• PoolManager.find(String)
• Pool
• getPoolName()
• getPool()
• findPool(String)
• isPoolNameResolvable(String)

createCache

@NonNull
protected <T extends GemFireCache> T createCache(@NonNull
 Object factory)

Creates a new ClientCache instance using the provided factory.

Overrides:

createCache in class CacheFactoryBean

Type Parameters:

T - parameterized Class type extending GemFireCache.

Parameters:

factory - instance of ClientCacheFactory.

Returns:

a new instance of ClientCache created by the provided factory.

See Also:

• ClientCacheFactory.create()
• ClientCache
• GemFireCache

onApplicationEvent

public void onApplicationEvent(@NonNull
 ContextRefreshedEvent event)

Inform the Apache Geode cluster that this ClientCache 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()
• AbstractBasicCacheFactoryBean.fetchCache()

close

protected void close(@NonNull
 GemFireCache cache)

Null-safe internal method used to close the ClientCache and preserve durability.

Overrides:

close in class AbstractBasicCacheFactoryBean

Parameters:

cache - GemFireCache to close.

See Also:

• ClientCache.close(boolean)
• isKeepAlive()

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> clientCacheConfigurers)

Null-safe operation to set an List of ClientCacheConfigurers to apply additional configuration to this ClientCacheFactoryBean when using Annotation-based configuration.

Parameters:

clientCacheConfigurers - List of ClientCacheConfigurers used to apply additional configuration to this ClientCacheFactoryBean.

See Also:

• ClientCacheConfigurer
• setClientCacheConfigurers(ClientCacheConfigurer...)

getCompositeClientCacheConfigurer

@NonNull
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
 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 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-configured value for deciding that this client is ready to receive events from the server(s).

Returns:

a Boolean indicating whether this client is ready to receive events from the server(s).

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
 SocketFactory socketFactory)

getSocketFactory

@NonNull
public 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.