Package org.springframework.data.gemfire.config.annotation

Class ClientCacheConfiguration

java.lang.Object

org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

org.springframework.data.gemfire.config.annotation.AbstractCacheConfiguration

org.springframework.data.gemfire.config.annotation.ClientCacheConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportAware, EnvironmentAware

@Configuration
public class ClientCacheConfiguration
extends AbstractCacheConfiguration

Spring Configuration class used to construct, configure and initialize a ClientCache instance in a Spring application context.

Since:

1.9.0

Author:

John Blum

See Also:

• Annotation
• ClientCache
• Pool
• SocketFactory
• CacheServer
• BeanFactory
• BeanDefinition
• BeanDefinitionBuilder
• Bean
• Configuration
• AnnotationAttributes
• AnnotationMetadata
• CacheFactoryBean
• ClientCacheFactoryBean
• AbstractCacheConfiguration
• ClientCacheConfigurer
• ClientRegionPoolBeanFactoryPostProcessor

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

AbstractAnnotationConfigSupport.TypeResolver<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DEFAULT_NAME
protected static final boolean	DEFAULT_READY_FOR_EVENTS

Fields inherited from class org.springframework.data.gemfire.config.annotation.AbstractCacheConfiguration

DEFAULT_CLOSE, DEFAULT_COPY_ON_READ, DEFAULT_LOCATORS, DEFAULT_LOG_LEVEL, DEFAULT_MCAST_PORT, DEFAULT_USE_BEAN_FACTORY_LOCATOR

Fields inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

INFRASTRUCTURE_ROLES, ORG_SPRINGFRAMEWORK_DATA_GEMFIRE_PACKAGE, ORG_SPRINGFRAMEWORK_PACKAGE, SPRING_DATA_GEMFIRE_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
ClientCacheConfiguration()

Method Summary

Modifier and Type	Method	Description
protected void	configureCache(AnnotationMetadata importMetadata)	Configures ClientCache specific settings.
protected void	configureInfrastructure(AnnotationMetadata importMetadata)	Configures Spring container infrastructure components and beans used by Spring Data GemFire to enable Pivotal GemFire or Apache Geode to function properly inside a Spring context.
ClientCacheFactoryBean	gemfireCache()	Bean declaration for a single, peer ClientCache instance.
protected Class<? extends Annotation>	getAnnotationType()	Returns the cache application Annotation type pertaining to this configuration.
protected BeanFactory	getBeanFactory()	Returns a reference to the Spring BeanFactory in the current application context.
protected String	getDurableClientId()
protected Integer	getDurableClientTimeout()
protected Integer	getFreeConnectionTimeout()
protected Long	getIdleTimeout()
protected Boolean	getKeepAlive()
protected Integer	getLoadConditioningInterval()
protected Integer	getMaxConnections()
protected Integer	getMinConnections()
protected Boolean	getMultiUserAuthentication()
protected Long	getPingInterval()
protected Iterable<ConnectionEndpoint>	getPoolLocators()
protected Iterable<ConnectionEndpoint>	getPoolServers()
protected Boolean	getPrSingleHopEnabled()
protected Integer	getReadTimeout()
protected boolean	getReadyForEvents()
protected Integer	getRetryAttempts()
protected Integer	getServerConnectionTimeout()
protected String	getServerGroup()
protected Integer	getSocketBufferSize()
protected Integer	getSocketConnectTimeout()
protected String	getSocketFactoryBeanName()
protected Integer	getStatisticsInterval()
protected Integer	getSubscriptionAckInterval()
protected Boolean	getSubscriptionEnabled()
protected Integer	getSubscriptionMessageTrackingTimeout()
protected Integer	getSubscriptionRedundancy()
protected Boolean	getThreadLocalConnections()
protected <T extends CacheFactoryBean> T	newCacheFactoryBean()	Constructs a new instance of ClientCacheFactoryBean used to create a peer ClientCache.
protected ConnectionEndpoint	newConnectionEndpoint(String host, Integer port)
String	toString()	Returns a String containing the name of the Spring-configured Apache Geode ClientCache application.

Methods inherited from class org.springframework.data.gemfire.config.annotation.AbstractCacheConfiguration

add, configureCacheFactoryBean, configureOptional, constructCacheFactoryBean, gemfireProperties, getCacheXml, getCopyOnRead, getCriticalHeapPercentage, getCriticalOffHeapPercentage, getEvictionHeapPercentage, getEvictionOffHeapPercentage, getGatewayConflictResolver, getJndiDataSources, getTransactionListeners, getTransactionWriter, isCacheServerApplication, isCacheServerOrPeerCacheApplication, isClientCacheApplication, isClientPeerOrServerCacheApplication, isClose, isPeerCacheApplication, isTypedCacheApplication, locators, logLevel, mcastPort, name, setImportMetadata, startLocator, useBeanFactoryLocator

Methods inherited from class org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport

arrayOfPropertyNamesFor, arrayOfPropertyNamesFor, asArrayProperty, cacheClientProperty, cacheCompressionProperty, cacheOffHeapProperty, cachePeerProperty, cacheProperty, cacheServerProperty, clusterProperty, diskStoreProperty, entitiesProperty, gatewayReceiverProperty, gatewaySenderProperty, getAnnotationAttributes, getAnnotationAttributes, getAnnotationAttributes, getAnnotationTypeName, getAnnotationTypeSimpleName, getBeanClassLoader, getEnvironment, getEvaluationContext, getLog, hasValue, hasValue, hasValue, httpServiceProperty, isAnnotationPresent, isAnnotationPresent, isNotInfrastructureBean, isNotInfrastructureBean, isNotInfrastructureClass, isNotInfrastructureClass, isNotInfrastructureRole, isUserLevelMethod, locatorProperty, logDebug, logDebug, logError, logError, loggingProperty, logInfo, logInfo, logWarning, logWarning, managementProperty, managerProperty, memcachedServiceProperty, namedCacheServerProperty, namedDiskStoreProperty, namedGatewaySenderProperty, namedPoolProperty, newEvaluationContext, newLog, pdxProperty, poolProperty, propertyName, redisServiceProperty, register, register, requireProperty, resolveAnnotation, resolveBeanClass, resolveBeanClass, resolveBeanClass, resolveBeanClassLoader, resolveBeanClassLoader, resolveBeanClassName, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, resolveProperty, safeResolveType, securityProperty, serviceProperty, setBeanClassLoader, setBeanFactory, setEnvironment, sslProperty, statsProperty

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_READY_FOR_EVENTS

protected static final boolean DEFAULT_READY_FOR_EVENTS

See Also:

• Constant Field Values

DEFAULT_NAME

protected static final String DEFAULT_NAME

See Also:

• Constant Field Values

Constructor Details

ClientCacheConfiguration

public ClientCacheConfiguration()

Method Details

gemfireCache

@Bean
public ClientCacheFactoryBean gemfireCache()

Bean declaration for a single, peer ClientCache instance.

Returns:

a new instance of a peer ClientCache.

See Also:

• ClientCacheFactoryBean
• ClientCache
• GemFireCache
• AbstractCacheConfiguration.constructCacheFactoryBean()

newCacheFactoryBean

protected <T extends CacheFactoryBean> T newCacheFactoryBean()

Constructs a new instance of ClientCacheFactoryBean used to create a peer ClientCache.

Specified by:

newCacheFactoryBean in class AbstractCacheConfiguration

Type Parameters:

T - Class sub-type of CacheFactoryBean.

Returns:

a new instance of ClientCacheFactoryBean.

See Also:

• ClientCacheFactoryBean

configureInfrastructure

protected void configureInfrastructure(AnnotationMetadata importMetadata)

Configures Spring container infrastructure components and beans used by Spring Data GemFire to enable Pivotal GemFire or Apache Geode to function properly inside a Spring context. This overridden method configures and registers additional Spring components and beans applicable to ClientCaches.

Overrides:

configureInfrastructure in class AbstractCacheConfiguration

Parameters:

importMetadata - AnnotationMetadata containing annotation meta-data for the Spring Data GemFire cache application class.

See Also:

• AnnotationMetadata

configureCache

protected void configureCache(AnnotationMetadata importMetadata)

Configures ClientCache specific settings.

Overrides:

configureCache in class AbstractCacheConfiguration

Parameters:

importMetadata - AnnotationMetadata containing client cache meta-data used to configure the ClientCache.

See Also:

• AnnotationMetadata
• configureLocatorsAndServers(Map)

newConnectionEndpoint

protected ConnectionEndpoint newConnectionEndpoint(String host,
 Integer port)

getAnnotationType

protected Class<? extends Annotation> getAnnotationType()

Returns the cache application Annotation type pertaining to this configuration.

Specified by:

getAnnotationType in class AbstractAnnotationConfigSupport

Returns:

the cache application Annotation type used by this application.

getBeanFactory

protected BeanFactory getBeanFactory()

Returns a reference to the Spring BeanFactory in the current application context.

Overrides:

getBeanFactory in class AbstractAnnotationConfigSupport

Returns:

a reference to the Spring BeanFactory.

See Also:

• BeanFactory

getDurableClientId

protected String getDurableClientId()

getDurableClientTimeout

protected Integer getDurableClientTimeout()

getFreeConnectionTimeout

protected Integer getFreeConnectionTimeout()

getIdleTimeout

protected Long getIdleTimeout()

getKeepAlive

protected Boolean getKeepAlive()

getLoadConditioningInterval

protected Integer getLoadConditioningInterval()

getMaxConnections

protected Integer getMaxConnections()

getMinConnections

protected Integer getMinConnections()

getMultiUserAuthentication

protected Boolean getMultiUserAuthentication()

getPingInterval

protected Long getPingInterval()

getPoolLocators

protected Iterable<ConnectionEndpoint> getPoolLocators()

getPoolServers

protected Iterable<ConnectionEndpoint> getPoolServers()

getPrSingleHopEnabled

protected Boolean getPrSingleHopEnabled()

getReadTimeout

protected Integer getReadTimeout()

getReadyForEvents

protected boolean getReadyForEvents()

getRetryAttempts

protected Integer getRetryAttempts()

getServerConnectionTimeout

protected Integer getServerConnectionTimeout()

getServerGroup

protected String getServerGroup()

getSocketBufferSize

protected Integer getSocketBufferSize()

getSocketConnectTimeout

protected Integer getSocketConnectTimeout()

getSocketFactoryBeanName

protected String getSocketFactoryBeanName()

getStatisticsInterval

protected Integer getStatisticsInterval()

getSubscriptionAckInterval

protected Integer getSubscriptionAckInterval()

getSubscriptionEnabled

protected Boolean getSubscriptionEnabled()

getSubscriptionMessageTrackingTimeout

protected Integer getSubscriptionMessageTrackingTimeout()

getSubscriptionRedundancy

protected Integer getSubscriptionRedundancy()

getThreadLocalConnections

protected Boolean getThreadLocalConnections()

toString

public String toString()

Returns a String containing the name of the Spring-configured Apache Geode ClientCache application.

Overrides:

toString in class AbstractCacheConfiguration

Returns:

a String containing the name of the Spring-configured Apache Geode ClientCache application.

See Also:

• Object.toString()