ClientCacheConfiguration (Spring Data GemFire 1.9.23.RELEASE API)

java.lang.Object
- org.springframework.data.gemfire.config.annotation.AbstractCacheConfiguration
- - org.springframework.data.gemfire.config.annotation.ClientCacheConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportAware
```
@Configuration
public class ClientCacheConfiguration
extends AbstractCacheConfiguration
```
Spring Configuration class used to configure, construct and initialize a GemFire ClientCache instance in a Spring application context.

Since:

1.0.0

Author:

John Blum

See Also:

Bean, Configuration, AbstractCacheConfiguration, ClientCache

Field Summary

Fields
Modifier and Type Field and Description

protected static String DEFAULT_NAME

protected static 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
Modifier and Type	Field and Description
`protected static String`	`DEFAULT_NAME`
`protected static boolean`	`DEFAULT_READY_FOR_EVENTS`

Constructor Summary

Constructors
Constructor and Description

ClientCacheConfiguration()

Constructors
Constructor and Description
`ClientCacheConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`configureCache(AnnotationMetadata importMetadata)` Configures GemFire `ClientCache` specific settings.
`protected void`	`configureInfrastructure(AnnotationMetadata importMetadata)` Configures Spring container infrastructure components used by Spring Data GemFire to enable GemFire to function properly inside a Spring context.
`protected void`	`configureLocatorsAndServers(Map<String,Object> clientCacheApplicationAttributes)` Uses the list of GemFire Locator and Server connection endpoint definitions and meta-data to configure the GemFire client `Pool` used to communicate with the servers in the GemFire cluster.
`protected String`	`durableClientId()`
`protected Integer`	`durableClientTimeout()`
`protected Integer`	`freeConnectionTimeout()`
`ClientCacheFactoryBean`	`gemfireCache()`
`protected Class`	`getAnnotationType()` Returns the GemFire cache application `Annotation` type pertaining to this configuration.
`protected Long`	`idleTimeout()`
`protected Boolean`	`keepAlive()`
`protected Integer`	`loadConditioningInterval()`
`protected Integer`	`maxConnections()`
`protected Integer`	`minConnections()`
`protected Boolean`	`multiUserAuthentication()`
`protected <T extends CacheFactoryBean> T`	`newCacheFactoryBean()` Constructs a new, uninitialized instance of the `CacheFactoryBean` based on the Spring application's GemFire cache type (i.e. client or peer) preference specified via annotation.
`protected ConnectionEndpoint`	`newConnectionEndpoint(String host, Integer port)`
`protected Long`	`pingInterval()`
`protected Iterable<ConnectionEndpoint>`	`poolLocators()`
`protected Iterable<ConnectionEndpoint>`	`poolServers()`
`protected Boolean`	`prSingleHopEnabled()`
`protected Integer`	`readTimeout()`
`protected boolean`	`readyForEvents()`
`protected void`	`registerClientRegionPoolBeanFactoryPostProcessor(AnnotationMetadata importMetadata)`
`protected Integer`	`retryAttempts()`
`protected String`	`serverGroup()`
`protected Integer`	`socketBufferSize()`
`protected Integer`	`statisticsInterval()`
`protected Integer`	`subscriptionAckInterval()`
`protected Boolean`	`subscriptionEnabled()`
`protected Integer`	`subscriptionMessageTrackingTimeout()`
`protected Integer`	`subscriptionRedundancy()`
`protected Boolean`	`threadLocalConnections()`
`String`	`toString()`

Methods inherited from class org.springframework.data.gemfire.config.annotation.AbstractCacheConfiguration
add, beanClassLoader, beanFactory, cacheXml, close, configureOther, configurePdx, constructCacheFactoryBean, copyOnRead, criticalHeapPercentage, dynamicRegionSupport, evictionHeapPercentage, gatewayConflictResolver, gemfireProperties, getAnnotationTypeName, getAnnotationTypeSimpleName, hasValue, hasValue, hasValue, isCacheServerApplication, isCacheServerOrPeerCacheApplication, isClientCacheApplication, isClientPeerOrServerCacheApplication, isPeerCacheApplication, isTypedCacheApplication, jndiDataSources, locators, logLevel, mappingContext, mcastPort, name, newPdxSerializer, pdxDiskStoreName, pdxIgnoreUnreadFields, pdxPersistent, pdxReadSerialized, pdxSerializer, register, registerCustomEditorBeanFactoryPostProcessor, registerDefinedIndexesApplicationListener, registerDiskStoreDirectoryBeanPostProcessor, registerPdxDiskStoreAwareBeanFactoryPostProcessor, resolvePdxSerializer, setBeanClassLoader, setBeanFactory, setCommonCacheConfiguration, setImportMetadata, startLocator, transactionListeners, transactionWriter, useBeanFactoryLocator

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

- Field Detail
  - 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 Detail
  - ClientCacheConfiguration
```
public ClientCacheConfiguration()
```
- Method Detail
  - gemfireCache
```
@Bean
public ClientCacheFactoryBean gemfireCache()
```
  - newCacheFactoryBean
```
protected <T extends CacheFactoryBean> T newCacheFactoryBean()
```
    Constructs a new, uninitialized instance of the CacheFactoryBean based on the Spring application's GemFire cache type (i.e. client or peer) preference specified via annotation.
    
    Specified by:
    
    newCacheFactoryBean in class AbstractCacheConfiguration
    
    Type Parameters:
    
    T - Class type of the CacheFactoryBean.
    
    Returns:
    
    a new instance of an appropriate CacheFactoryBean given the Spring application's GemFire cache type preference (i.e client or peer) specified with the corresponding annotation (e.g. ClientCacheApplication or PeerCacheApplication).
    
    See Also:
    
    ClientCacheFactoryBean, CacheFactoryBean
  - configureInfrastructure
```
protected void configureInfrastructure(AnnotationMetadata importMetadata)
```
    Configures Spring container infrastructure components used by Spring Data GemFire to enable GemFire to function properly inside a Spring context.
    
    Overrides:
    
    configureInfrastructure in class AbstractCacheConfiguration
    
    Parameters:
    
    importMetadata - AnnotationMetadata containing annotation meta-data for the Spring GemFire cache application class.
    
    See Also:
    
    AnnotationMetadata
  - registerClientRegionPoolBeanFactoryPostProcessor
```
protected void registerClientRegionPoolBeanFactoryPostProcessor(AnnotationMetadata importMetadata)
```
  - configureCache
```
protected void configureCache(AnnotationMetadata importMetadata)
```
    Configures GemFire ClientCache specific settings.
    
    Overrides:
    
    configureCache in class AbstractCacheConfiguration
    
    Parameters:
    
    importMetadata - AnnotationMetadata containing client cache meta-data used to configure the GemFire ClientCache.
    
    See Also:
    
    AnnotationMetadata
  - configureLocatorsAndServers
```
protected void configureLocatorsAndServers(Map<String,Object> clientCacheApplicationAttributes)
```
    Uses the list of GemFire Locator and Server connection endpoint definitions and meta-data to configure the GemFire client Pool used to communicate with the servers in the GemFire cluster.
    
    Parameters:
    
    clientCacheApplicationAttributes - ClientCacheApplication annotation containing Pool Locator/Server connection endpoint meta-data.
    
    See Also:
    
    ClientCacheApplication, Map
  - newConnectionEndpoint
```
protected ConnectionEndpoint newConnectionEndpoint(String host,
                                                   Integer port)
```
  - getAnnotationType
```
protected Class getAnnotationType()
```
    Returns the GemFire cache application Annotation type pertaining to this configuration.
    
    Specified by:
    
    getAnnotationType in class AbstractCacheConfiguration
    
    Returns:
    
    the GemFire cache application Annotation type used by this application.
    
    See Also:
    
    CacheServerApplication, ClientCacheApplication, PeerCacheApplication
  - durableClientId
```
protected String durableClientId()
```
  - durableClientTimeout
```
protected Integer durableClientTimeout()
```
  - freeConnectionTimeout
```
protected Integer freeConnectionTimeout()
```
  - idleTimeout
```
protected Long idleTimeout()
```
  - keepAlive
```
protected Boolean keepAlive()
```
  - loadConditioningInterval
```
protected Integer loadConditioningInterval()
```
  - maxConnections
```
protected Integer maxConnections()
```
  - minConnections
```
protected Integer minConnections()
```
  - multiUserAuthentication
```
protected Boolean multiUserAuthentication()
```
  - pingInterval
```
protected Long pingInterval()
```
  - poolLocators
```
protected Iterable<ConnectionEndpoint> poolLocators()
```
  - poolServers
```
protected Iterable<ConnectionEndpoint> poolServers()
```
  - prSingleHopEnabled
```
protected Boolean prSingleHopEnabled()
```
  - readTimeout
```
protected Integer readTimeout()
```
  - readyForEvents
```
protected boolean readyForEvents()
```
  - retryAttempts
```
protected Integer retryAttempts()
```
  - serverGroup
```
protected String serverGroup()
```
  - socketBufferSize
```
protected Integer socketBufferSize()
```
  - statisticsInterval
```
protected Integer statisticsInterval()
```
  - subscriptionAckInterval
```
protected Integer subscriptionAckInterval()
```
  - subscriptionEnabled
```
protected Boolean subscriptionEnabled()
```
  - subscriptionMessageTrackingTimeout
```
protected Integer subscriptionMessageTrackingTimeout()
```
  - subscriptionRedundancy
```
protected Integer subscriptionRedundancy()
```
  - threadLocalConnections
```
protected Boolean threadLocalConnections()
```
  - toString
```
public String toString()
```
    Description copied from class: AbstractCacheConfiguration
    
    Overrides:
    
    toString in class AbstractCacheConfiguration

Class ClientCacheConfiguration

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_READY_FOR_EVENTS

DEFAULT_NAME

Constructor Detail

ClientCacheConfiguration

Method Detail

gemfireCache

newCacheFactoryBean

configureInfrastructure

registerClientRegionPoolBeanFactoryPostProcessor

configureCache

configureLocatorsAndServers

newConnectionEndpoint

getAnnotationType

durableClientId

durableClientTimeout

freeConnectionTimeout

idleTimeout

keepAlive

loadConditioningInterval

maxConnections

minConnections

multiUserAuthentication

pingInterval

poolLocators

poolServers

prSingleHopEnabled

readTimeout

readyForEvents

retryAttempts

serverGroup

socketBufferSize

statisticsInterval

subscriptionAckInterval

subscriptionEnabled

subscriptionMessageTrackingTimeout

subscriptionRedundancy

threadLocalConnections

toString