org.springframework.data.gemfire.config.annotation

Annotation Type ClientCacheApplication

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Configuration
 @Import(value=ClientCacheConfiguration.class)
public @interface ClientCacheApplication

The ClientCacheApplication annotation enables a Spring Data for Apache Geode based application to become an Apache Geode cache client by creating a ClientCache instance.

Since:

1.9.0

Author:

John Blum

See Also:

Documented, Inherited, Retention, Target, Region, ClientCache, Pool, PoolFactory, SocketFactory, ResourceManager, BeanFactory, Configuration, Import, ClientCacheConfiguration, GemfireBeanFactoryLocator

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	copyOnRead Configures cache copy-on-read functionality, which copies the value when it is read from the cache.
float	criticalHeapPercentage Configures the percentage of heap at or above which the cache is considered to be in danger of becoming inoperable.
float	criticalOffHeapPercentage Configures the percentage of off-heap at or above which the cache is considered to be in danger of becoming inoperable.
String	durableClientId Configures the ID for a durable client in a client/server topology.
int	durableClientTimeout Configures the number of seconds that a durable client can remain disconnected from a server cluster and for the servers to continue to accumulate (durable) events for the client while offline.
float	evictionHeapPercentage Configures the percentage of heap at or above which eviction should begin on Regions configured for Heap LRU eviction.
float	evictionOffHeapPercentage Configures the percentage of off-heap at or above which eviction should begin on Regions configured for Heap LRU eviction.
int	freeConnectionTimeout Configures the free connection timeout for the DEFAULT Pool.
long	idleTimeout Configures the amount of time that a connection can remain idle before expiring the connection.
boolean	keepAlive Configures whether to keep the client event queues alive on the server when the client is disconnected.
int	loadConditioningInterval Configures the load conditioning interval for the DEFAULT Pool.
ClientCacheApplication.Locator[]	locators Configures the Locators to which this cache client will connect.
String	logLevel Deprecated. Apache Geode cache logging can only be configured using a logging provider (e.g. Log4j).
int	maxConnections Configures the maximum number of connections between the client and server that the DEFAULT Pool will create.
int	minConnections Configures the minimum number of connections between the client and server to keep alive and available at all times.
boolean	multiUserAuthentication If set to true then the DEFAULT Pool can be used by multiple users.
String	name Configures the name of this Apache Geode member in the cluster (distributed system).
long	pingInterval Configures how often to ping servers and verify that the servers are still alive and responsive.
boolean	prSingleHopEnabled Configures prSingleHopEnabled functionality for the DEFAULT Pool.
int	readTimeout Configures the number of milliseconds to wait for a response from a server before timing out the operation and trying another server (if any are available).
boolean	readyForEvents Configures whether to notify servers (cluster) at runtime after startup that this durable client is ready to receive updates and events.
int	retryAttempts Configures the number of times to retry a request after timeout or an Exception occurs while performing the cache operation between the client and server.
int	serverConnectionTimeout Configures the server connection timeout for the DEFAULT Pool.
String	serverGroup Configures the name of the group that all servers in which the DEFAULT Pool connects to must belong to.
ClientCacheApplication.Server[]	servers Configures the CacheServers to which this cache client will connect.
int	socketBufferSize Configures the Socket buffer size used for each connection made in the DEFAULT Pool.
int	socketConnectTimeout Configures the Socket connect timeout used by the DEFAULT Pool.
String	socketFactoryBeanName Configures the SocketFactory bean name used by the DEFAULT Pool to create Socket connections to both Locators (if configured using locators()) and Servers in the Apache Geodce cluster.
int	statisticInterval Configures how often to send client statistics to the server.
int	subscriptionAckInterval Configures the interval in milliseconds to wait before sending acknowledgements from the client to the server for events received from server subscriptions.
boolean	subscriptionEnabled Configures server-to-client subscriptions when set to true (enabled) in the DEFAULT Pool.
int	subscriptionMessageTrackingTimeout Configures the message tracking timeout attribute of the DEFAULT Pool, which is the time-to-live period in milliseconds for subscription events the client has received from the server.
int	subscriptionRedundancy Configures the redundancy-level for the DEFAULT Pool's server-to-client subscriptions.
boolean	threadLocalConnections Deprecated.
boolean	useBeanFactoryLocator Configures whether the GemfireBeanFactoryLocator should be enabled to lookup the Spring BeanFactory to auto-wire, configure and initialize Apache Geode components created in a non-Spring managed, Apache Geode context (for example: cache.xml).

Element Detail

copyOnRead

public abstract boolean copyOnRead

Configures cache copy-on-read functionality, which copies the value when it is read from the cache. Defaults to false. Use spring.data.gemfire.cache.copy-on-read property in application.properties.

Default:

false

criticalHeapPercentage

public abstract float criticalHeapPercentage

Configures the percentage of heap at or above which the cache is considered to be in danger of becoming inoperable. Defaults to ResourceManager.DEFAULT_CRITICAL_PERCENTAGE. Use spring.data.gemfire.cache.critical-heap-percentage property in application.properties.

Default:

0.0f

criticalOffHeapPercentage

public abstract float criticalOffHeapPercentage

Configures the percentage of off-heap at or above which the cache is considered to be in danger of becoming inoperable. Defaults to 0.0. Use spring.data.gemfire.cache.critical-off-heap-percentage property in application.properties.

Default:

0.0f

durableClientId

public abstract String durableClientId

Configures the ID for a durable client in a client/server topology. If set, the durable client ID indicates a client is durable so messages persist while the client is offline. The ID is used by servers to identify clients and reestablish any messaging that was interrupted by client downtime. Use spring.data.gemfire.cache.client.durable-client-id property in application.properties.

Default:

""

durableClientTimeout

public abstract int durableClientTimeout

Configures the number of seconds that a durable client can remain disconnected from a server cluster and for the servers to continue to accumulate (durable) events for the client while offline. Defaults to 300 seconds, or 5 minutes. Use spring.data.gemfire.cache.client.durable-client-timeout property in application.properties.

Default:

300

evictionHeapPercentage

public abstract float evictionHeapPercentage

Configures the percentage of heap at or above which eviction should begin on Regions configured for Heap LRU eviction. Defaults to ResourceManager.DEFAULT_EVICTION_PERCENTAGE. Use spring.data.gemfire.cache.eviction-heap-percentage property in application.properties.

Default:

0.0f

evictionOffHeapPercentage

public abstract float evictionOffHeapPercentage

Configures the percentage of off-heap at or above which eviction should begin on Regions configured for Heap LRU eviction. Defaults to 0.0. Use spring.data.gemfire.cache.eviction-off-heap-percentage property in application.properties.

Default:

0.0f

freeConnectionTimeout

public abstract int freeConnectionTimeout

Configures the free connection timeout for the DEFAULT Pool. Defaults to PoolFactory.DEFAULT_FREE_CONNECTION_TIMEOUT. Use either the spring.data.gemfire.pool.default.free-connection-timeout property or the spring.data.gemfire.pool.free-connection-timeout property in application.properties.

Default:

10000

idleTimeout

public abstract long idleTimeout

Configures the amount of time that a connection can remain idle before expiring the connection. Defaults to PoolFactory.DEFAULT_IDLE_TIMEOUT. Use either the spring.data.gemfire.pool.default.idle-timeout property or the spring.data.gemfire.pool.idle-timeout property in application.properties.

Default:

5000L

keepAlive

public abstract boolean keepAlive

Configures whether to keep the client event queues alive on the server when the client is disconnected. Defaults to false. Use spring.data.gemfire.cache.client.keep-alive property in application.properties.

Default:

false

loadConditioningInterval

public abstract int loadConditioningInterval

Configures the load conditioning interval for the DEFAULT Pool. Defaults to PoolFactory.DEFAULT_LOAD_CONDITIONING_INTERVAL. Use either the spring.data.gemfire.pool.default.load-conditioning-interval property or the spring.data.gemfire.pool.load-conditioning-interval property in application.properties.

Default:

300000

locators

public abstract ClientCacheApplication.Locator[] locators

Configures the Locators to which this cache client will connect. Use either the spring.data.gemfire.pool.default.locators property or the spring.data.gemfire.pool.locators property in application.properties.

Default:

{}

logLevel

@Deprecated
public abstract String logLevel

Deprecated. Apache Geode cache logging can only be configured using a logging provider (e.g. Log4j).

Configures the log-level used to output log messages at runtime. Defaults to config. Use spring.data.gemfire.cache.log-level property in application.properties.

Default:

"config"

maxConnections

public abstract int maxConnections

Configures the maximum number of connections between the client and server that the DEFAULT Pool will create. Defaults to PoolFactory.DEFAULT_MAX_CONNECTIONS. Use either the spring.data.gemfire.pool.default.max-connections property or the spring.data.gemfire.pool.max-connections property in application.properties.

Default:

-1

minConnections

public abstract int minConnections

Configures the minimum number of connections between the client and server to keep alive and available at all times. Defaults to PoolFactory.DEFAULT_MIN_CONNECTIONS. Use either the spring.data.gemfire.pool.default.min-connections property or the spring.data.gemfire.pool.min-connections property in application.properties.

Default:

1

multiUserAuthentication

public abstract boolean multiUserAuthentication

If set to true then the DEFAULT Pool can be used by multiple users. Defaults to PoolFactory.DEFAULT_MULTIUSER_AUTHENTICATION. Use either the spring.data.gemfire.pool.default.multi-user-authentication property or the spring.data.gemfire.pool.multi-user-authentication property in application.properties.

Default:

false

name

public abstract String name

Configures the name of this Apache Geode member in the cluster (distributed system). Defaults to SpringBasedClientCacheApplication. Use either spring.data.gemfire.name or the spring.data.gemfire.cache.name property in application.properties.

Default:

"SpringBasedClientCacheApplication"

pingInterval

public abstract long pingInterval

Configures how often to ping servers and verify that the servers are still alive and responsive. Defaults to PoolFactory.DEFAULT_PING_INTERVAL. Use either the spring.data.gemfire.pool.default.ping-interval property or the spring.data.gemfire.pool.ping-interval property in application.properties.

Default:

10000L

prSingleHopEnabled

public abstract boolean prSingleHopEnabled

Configures prSingleHopEnabled functionality for the DEFAULT Pool. When true the client will be aware of the location of all partitions on servers hosting DataPolicy.PARTITION Regions. Defaults to PoolFactory.DEFAULT_PR_SINGLE_HOP_ENABLED. Use either the spring.data.gemfire.pool.default.pr-single-hop-enabled property or the spring.data.gemfire.pool.pr-single-hop-enabled property in application.properties.

Default:

true

readTimeout

public abstract int readTimeout

Configures the number of milliseconds to wait for a response from a server before timing out the operation and trying another server (if any are available). Defaults to PoolFactory.DEFAULT_READ_TIMEOUT. Use either the spring.data.gemfire.pool.default.read-timeout property or the spring.data.gemfire.pool.read-timeout property in application.properties.

Default:

10000

readyForEvents

public abstract boolean readyForEvents

Configures whether to notify servers (cluster) at runtime after startup that this durable client is ready to receive updates and events. Defaults to false. Use either the spring.data.gemfire.pool.default.ready-for-events property or the spring.data.gemfire.pool.ready-for-events property in application.properties.

Default:

false

retryAttempts

public abstract int retryAttempts

Configures the number of times to retry a request after timeout or an Exception occurs while performing the cache operation between the client and server. Defaults to PoolFactory.DEFAULT_RETRY_ATTEMPTS. Use either the spring.data.gemfire.pool.default.retry-attempts property or the spring.data.gemfire.pool.retry-attempts property in application.properties.

Default:

-1

serverConnectionTimeout

public abstract int serverConnectionTimeout

Configures the server connection timeout for the DEFAULT Pool. If the Pool has a max connections setting, operations will block if there are no free connections to a specific server. The server connection timeout specifies how long those operations will block waiting for a free connection tro a specific server before receiving an AllConnectionsInUseException. If max connections is not set then this setting has no effect. This setting differs from freeConnectionTimeout(), which sets the wait time for any server connection in the DEFAULT Pool, whereas this setting sets the wait time for a free connection to a specific server. Defaults to PoolFactory.DEFAULT_SERVER_CONNECTION_TIMEOUT. Use either the spring.data.gemfire.pool.default.server-connection-timeout property or the spring.data.gemfire.pool.server-connection-timeout property in application.properties.

Default:

0

serverGroup

public abstract String serverGroup

Configures the name of the group that all servers in which the DEFAULT Pool connects to must belong to. Defaults to PoolFactory.DEFAULT_SERVER_GROUP. Use either the spring.data.gemfire.pool.default.server-group property or the spring.data.gemfire.pool.server-group property in application.properties.

Default:

""

servers

public abstract ClientCacheApplication.Server[] servers

Configures the CacheServers to which this cache client will connect. Use either the spring.data.gemfire.pool.default.servers property or the spring.data.gemfire.pool.servers property in application.properties.

Default:

{}

socketBufferSize

public abstract int socketBufferSize

Configures the Socket buffer size used for each connection made in the DEFAULT Pool. Defaults to PoolFactory.DEFAULT_SOCKET_BUFFER_SIZE. Use either the spring.data.gemfire.pool.default.socket-buffer-size property or the spring.data.gemfire.pool.socket-buffer-size property in application.properties.

Default:

32768

socketConnectTimeout

public abstract int socketConnectTimeout

Configures the Socket connect timeout used by the DEFAULT Pool. Configures the number of milliseconds used as the Socket timeout when the client connects to the servers and Locators in the cluster. A timeout of zero is interpreted as an infinite timeout. The connection will then block until established or an error occurs. Defaults to PoolFactory.DEFAULT_SOCKET_CONNECT_TIMEOUT. Use either the spring.data.gemfire.pool.default.socket-connect-timeout property or the spring.data.gemfire.pool.socket-connect-timeout property in application.properties.

Default:

59000

socketFactoryBeanName

public abstract String socketFactoryBeanName

Configures the SocketFactory bean name used by the DEFAULT Pool to create Socket connections to both Locators (if configured using locators()) and Servers in the Apache Geodce cluster. Defaults to unset. Use either the spring.data.gemfire.pool.default.socket-factory-bean-name property or the spring.data.gemfire.pool.socket-factory-bean-name property in application.properties.

Default:

""

statisticInterval

public abstract int statisticInterval

Configures how often to send client statistics to the server. Defaults to PoolFactory.DEFAULT_STATISTIC_INTERVAL. Use either the spring.data.gemfire.pool.default.statistic-interval property or the spring.data.gemfire.pool.statistic-interval property in application.properties.

Default:

-1

subscriptionAckInterval

public abstract int subscriptionAckInterval

Configures the interval in milliseconds to wait before sending acknowledgements from the client to the server for events received from server subscriptions. Defaults to PoolFactory.DEFAULT_SUBSCRIPTION_ACK_INTERVAL. Use either the spring.data.gemfire.pool.default.subscription-ack-interval property or the spring.data.gemfire.pool.subscription-ack-interval property in application.properties.

Default:

100

subscriptionEnabled

public abstract boolean subscriptionEnabled

Configures server-to-client subscriptions when set to true (enabled) in the DEFAULT Pool. Defaults to PoolFactory.DEFAULT_SUBSCRIPTION_ENABLED. Use either the spring.data.gemfire.pool.default.subscription-enabled property or the spring.data.gemfire.pool.subscription-enabled property in application.properties.

Default:

false

subscriptionMessageTrackingTimeout

public abstract int subscriptionMessageTrackingTimeout

Configures the message tracking timeout attribute of the DEFAULT Pool, which is the time-to-live period in milliseconds for subscription events the client has received from the server. Defaults to PoolFactory.DEFAULT_SUBSCRIPTION_MESSAGE_TRACKING_TIMEOUT. Use either the spring.data.gemfire.pool.default.subscription-message-tracking-timeout property or the spring.data.gemfire.pool.subscription-message-tracking-timeout property in application.properties.

Default:

900000

subscriptionRedundancy

public abstract int subscriptionRedundancy

Configures the redundancy-level for the DEFAULT Pool's server-to-client subscriptions. Defaults to PoolFactory.DEFAULT_SUBSCRIPTION_REDUNDANCY. Use either the spring.data.gemfire.pool.default.subscription-redundancy property or the spring.data.gemfire.pool.subscription-redundancy property in application.properties.

Default:

0

threadLocalConnections

@Deprecated
public abstract boolean threadLocalConnections

Deprecated.

Configures the ThreadLocal connection policy for the DEFAULT Pool. Defaults to PoolFactory.DEFAULT_THREAD_LOCAL_CONNECTIONS. Use either the spring.data.gemfire.pool.default.thread-local-connections property or the spring.data.gemfire.pool.thread-local-connections property in application.properties.

Default:

false

useBeanFactoryLocator

public abstract boolean useBeanFactoryLocator

Configures whether the GemfireBeanFactoryLocator should be enabled to lookup the Spring BeanFactory to auto-wire, configure and initialize Apache Geode components created in a non-Spring managed, Apache Geode context (for example: cache.xml). Defaults to false. Use spring.data.gemfire.use-bean-factory-locator property in application.properties.

Default:

false