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, InitializingBean, ImportAware

@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.0.0

Author:

John Blum

See Also:

ClientCache, Pool, BeanDefinition, BeanDefinitionBuilder, Bean, Configuration, AnnotationMetadata, CacheFactoryBean, ClientCacheFactoryBean, AbstractCacheConfiguration, ClientCacheConfigurer, ClientRegionPoolBeanFactoryPostProcessor, ConnectionEndpoint, ConnectionEndpointList

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

Constructor Summary

Constructors

Constructor and Description
ClientCacheConfiguration()

Method Summary

Modifier and Type	Method and 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.
protected String	durableClientId()
protected Integer	durableClientTimeout()
protected Integer	freeConnectionTimeout()
ClientCacheFactoryBean	gemfireCache() Bean declaration for a single, peer ClientCache instance.
protected Class	getAnnotationType() Returns the 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 instance of ClientCacheFactoryBean used to create a peer ClientCache.
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 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, cacheXml, close, configureCacheFactoryBean, configurePdx, configureTheRest, constructCacheFactoryBean, copyOnRead, criticalHeapPercentage, dynamicRegionSupport, evictionHeapPercentage, gatewayConflictResolver, gemfireProperties, getAnnotationTypeName, getAnnotationTypeSimpleName, isCacheServerApplication, isCacheServerOrPeerCacheApplication, isClientCacheApplication, isClientPeerOrServerCacheApplication, isPeerCacheApplication, isTypedCacheApplication, jndiDataSources, locators, logLevel, mappingContext, mcastPort, name, newPdxSerializer, newPdxSerializer, pdxDiskStoreName, pdxIgnoreUnreadFields, pdxPersistent, pdxReadSerialized, pdxSerializer, resolvePdxSerializer, setImportMetadata, startLocator, transactionListeners, transactionWriter, useBeanFactoryLocator

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

afterPropertiesSet, beanClassLoader, beanFactory, evaluationContext, hasValue, hasValue, hasValue, newEvaluationContext, register, register, setBeanClassLoader, setBeanFactory

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

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 bean 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 getAnnotationType()

Returns the cache application Annotation type pertaining to this configuration.

Specified by:

getAnnotationType in class AbstractCacheConfiguration

Returns:

the 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