public class ClientCacheFactoryBean extends CacheFactoryBean implements ApplicationListener<ContextRefreshedEvent>
ApplicationListener
,
ContextRefreshedEvent
,
CacheFactoryBean
,
ConnectionEndpoint
,
ConnectionEndpointList
,
GemFireCache
,
ClientCache
,
ClientCacheFactory
,
Pool
,
PoolManager
,
DistributedSystem
,
PdxSerializer
CacheFactoryBean.DynamicRegionSupport, CacheFactoryBean.JndiDataSource
beanFactoryLocator, log
Constructor and Description |
---|
ClientCacheFactoryBean() |
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 |
close(com.gemstone.gemfire.cache.GemFireCache cache) |
protected <T extends com.gemstone.gemfire.cache.GemFireCache> |
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> |
fetchCache()
Fetches an existing GemFire ClientCache instance from the ClientCacheFactory.
|
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 com.gemstone.gemfire.cache.GemFireCache> |
getObjectType() |
Long |
getPingInterval() |
com.gemstone.gemfire.cache.client.Pool |
getPool()
Gets the
Pool used by this cache client to obtain connections to the GemFire cluster. |
String |
getPoolName()
Gets the name of the GemFire
Pool used by this GemFire cache client. |
Boolean |
getPrSingleHopEnabled() |
Integer |
getReadTimeout() |
Boolean |
getReadyForEvents()
Gets the user-specified value for the readyForEvents property.
|
Integer |
getRetryAttempts() |
String |
getServerGroup() |
protected ConnectionEndpointList |
getServers() |
Integer |
getSocketBufferSize() |
Integer |
getStatisticsInterval() |
Integer |
getSubscriptionAckInterval() |
Boolean |
getSubscriptionEnabled() |
Integer |
getSubscriptionMessageTrackingTimeout() |
Integer |
getSubscriptionRedundancy() |
Boolean |
getThreadLocalConnections() |
Boolean |
getUseClusterConfiguration()
Gets the value of the use-shared-configuration GemFire 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 GemFire cluster that this client cache is ready to receive events iff the client is non-durable.
|
protected void |
postProcessBeforeCacheInitialization(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 |
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(com.gemstone.gemfire.cache.client.Pool pool)
Sets the
Pool used by this cache client to obtain connections to the GemFire cluster. |
void |
setPoolName(String poolName)
Sets the name of the
Pool used by this cache client to obtain connections to the GemFire cluster. |
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 |
setServerGroup(String serverGroup) |
void |
setServers(ConnectionEndpoint[] servers) |
void |
setServers(Iterable<ConnectionEndpoint> servers) |
void |
setSocketBufferSize(Integer socketBufferSize) |
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 GemFire distribution config setting.
|
afterPropertiesSet, destroy, getBeanClassLoader, getBeanFactory, getBeanFactoryLocator, getBeanName, getCache, getCacheXml, getClose, getCopyOnRead, getCriticalHeapPercentage, getDynamicRegionSupport, getEvictionHeapPercentage, getGatewayConflictResolver, getJndiDataSources, getLockLease, getLockTimeout, getMessageSyncInterval, getObject, getPdxDiskStoreName, getPdxIgnoreUnreadFields, getPdxPersistent, getPdxReadSerialized, getPdxSerializer, getPhase, getProperties, getSearchTimeout, getTransactionListeners, getTransactionWriter, isPdxOptionsSpecified, isSingleton, isUseBeanFactoryLocator, postProcess, resolveCache, setBeanClassLoader, setBeanFactory, setBeanName, setCache, setCacheXml, setClose, setCopyOnRead, setCriticalHeapPercentage, setDynamicRegionSupport, setEvictionHeapPercentage, setGatewayConflictResolver, setJndiDataSources, setLockLease, setLockTimeout, setMessageSyncInterval, setPdxDiskStoreName, setPdxIgnoreUnreadFields, setPdxPersistent, setPdxReadSerialized, setPdxSerializer, setPhase, setProperties, setSearchTimeout, setTransactionListeners, setTransactionWriter, setUseBeanFactoryLocator, translateExceptionIfPossible
protected void postProcessBeforeCacheInitialization(Properties gemfireProperties)
postProcessBeforeCacheInitialization
in class CacheFactoryBean
protected <T extends com.gemstone.gemfire.cache.GemFireCache> T fetchCache()
fetchCache
in class CacheFactoryBean
T
- is Class type extension of GemFireCache.com.gemstone.gemfire.cache.CacheClosedException
- if an existing GemFire Cache instance does not exist.IllegalStateException
- if the GemFire cache instance is not a ClientCache.GemFireCache
,
ClientCacheFactory.getAnyInstance()
protected Properties resolveProperties()
resolveProperties
in class CacheFactoryBean
CacheFactoryBean.getProperties()
protected Object createFactory(Properties gemfireProperties)
createFactory
in class CacheFactoryBean
gemfireProperties
- a Properties object containing GemFire System properties.Properties
,
ClientCacheFactory
protected Object prepareFactory(Object factory)
prepareFactory
in class CacheFactoryBean
factory
- the GemFire factory used to create an instance of the GemFire client cache.CacheFactoryBean.isPdxOptionsSpecified()
protected <T extends com.gemstone.gemfire.cache.GemFireCache> T createCache(Object factory)
createCache
in class CacheFactoryBean
T
- parameterized Class type extension of GemFireCache
.factory
- the appropriate GemFire factory used to create a cache instance.ClientCacheFactory.create()
,
GemFireCache
public void onApplicationEvent(ContextRefreshedEvent event)
onApplicationEvent
in interface ApplicationListener<ContextRefreshedEvent>
event
- the ApplicationContextEvent fired when the ApplicationContext is refreshed.ClientCache.readyForEvents()
,
getReadyForEvents()
,
CacheFactoryBean.getObject()
protected void close(com.gemstone.gemfire.cache.GemFireCache cache)
close
in class CacheFactoryBean
public Class<? extends com.gemstone.gemfire.cache.GemFireCache> getObjectType()
getObjectType
in interface FactoryBean<com.gemstone.gemfire.cache.Cache>
getObjectType
in class CacheFactoryBean
public void addLocators(ConnectionEndpoint... locators)
public void addLocators(Iterable<ConnectionEndpoint> locators)
public void addServers(ConnectionEndpoint... servers)
public void addServers(Iterable<ConnectionEndpoint> servers)
public void setDurableClientId(String durableClientId)
durableClientId
- a String value indicating the durable client id.public String getDurableClientId()
public void setDurableClientTimeout(Integer durableClientTimeout)
durableClientTimeout
- an Integer value indicating the timeout in seconds for the server to keep
the durable client's queue around.public Integer getDurableClientTimeout()
public final void setEnableAutoReconnect(Boolean enableAutoReconnect)
CacheFactoryBean
setEnableAutoReconnect
in class CacheFactoryBean
enableAutoReconnect
- a boolean value to enable/disable auto-reconnect functionality.public final Boolean getEnableAutoReconnect()
CacheFactoryBean
getEnableAutoReconnect
in class CacheFactoryBean
public void setFreeConnectionTimeout(Integer freeConnectionTimeout)
public Integer getFreeConnectionTimeout()
public void setIdleTimeout(Long idleTimeout)
public Long getIdleTimeout()
public void setKeepAlive(Boolean keepAlive)
keepAlive
- a boolean value indicating to the server to keep the durable client's queues alive.public Boolean getKeepAlive()
public boolean isKeepAlive()
public void setLoadConditioningInterval(Integer loadConditioningInterval)
public Integer getLoadConditioningInterval()
public void setLocators(ConnectionEndpoint[] locators)
public void setLocators(Iterable<ConnectionEndpoint> locators)
protected ConnectionEndpointList getLocators()
public void setMaxConnections(Integer maxConnections)
public Integer getMaxConnections()
public void setMinConnections(Integer minConnections)
public Integer getMinConnections()
public void setMultiUserAuthentication(Boolean multiUserAuthentication)
public Boolean getMultiUserAuthentication()
public void setPool(com.gemstone.gemfire.cache.client.Pool pool)
Pool
used by this cache client to obtain connections to the GemFire cluster.pool
- the GemFire Pool
used by this ClientCache
to obtain connections
to the GemFire cluster.IllegalArgumentException
- if the Pool
is null.public com.gemstone.gemfire.cache.client.Pool getPool()
Pool
used by this cache client to obtain connections to the GemFire cluster.Pool
used by this ClientCache
to obtain connections
to the GemFire cluster.public void setPoolName(String poolName)
Pool
used by this cache client to obtain connections to the GemFire cluster.poolName
- set the name of the GemFire Pool
used by this GemFire ClientCache
.IllegalArgumentException
- if the Pool
name is unspecified.public String getPoolName()
Pool
used by this GemFire cache client.Pool
used by this GemFire cache client.public void setPingInterval(Long pingInterval)
public Long getPingInterval()
public void setPrSingleHopEnabled(Boolean prSingleHopEnabled)
public Boolean getPrSingleHopEnabled()
public void setReadTimeout(Integer readTimeout)
public Integer getReadTimeout()
public void setReadyForEvents(Boolean readyForEvents)
readyForEvents
- sets a boolean flag to notify the server that this durable client
is ready to receive updates.getReadyForEvents()
public Boolean getReadyForEvents()
public boolean isReadyForEvents()
CacheUtils.isDurable(ClientCache)
,
getReadyForEvents()
public void setRetryAttempts(Integer retryAttempts)
public Integer getRetryAttempts()
public void setServerGroup(String serverGroup)
public String getServerGroup()
public void setServers(ConnectionEndpoint[] servers)
public void setServers(Iterable<ConnectionEndpoint> servers)
protected ConnectionEndpointList getServers()
public void setSocketBufferSize(Integer socketBufferSize)
public Integer getSocketBufferSize()
public void setStatisticsInterval(Integer statisticsInterval)
public Integer getStatisticsInterval()
public void setSubscriptionAckInterval(Integer subscriptionAckInterval)
public Integer getSubscriptionAckInterval()
public void setSubscriptionEnabled(Boolean subscriptionEnabled)
public Boolean getSubscriptionEnabled()
public void setSubscriptionMessageTrackingTimeout(Integer subscriptionMessageTrackingTimeout)
public Integer getSubscriptionMessageTrackingTimeout()
public void setSubscriptionRedundancy(Integer subscriptionRedundancy)
public Integer getSubscriptionRedundancy()
public void setThreadLocalConnections(Boolean threadLocalConnections)
public Boolean getThreadLocalConnections()
public final void setUseClusterConfiguration(Boolean useClusterConfiguration)
CacheFactoryBean
setUseClusterConfiguration
in class CacheFactoryBean
useClusterConfiguration
- a boolean value to set the use-shared-configuration GemFire distribution property.public final Boolean getUseClusterConfiguration()
CacheFactoryBean
getUseClusterConfiguration
in class CacheFactoryBean
Copyright © 2011–2019 Pivotal Software, Inc.. All rights reserved.