org.springframework.data.gemfire.config.annotation

Annotation Type CacheServerApplication

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

The CacheServerApplication annotation enables an embedded GemFire CacheServer instance in a Spring Data GemFire based application. In addition, this also implies an embedded GemFire peer Cache must exist and therefore will be configured, constructed and initialized as a Spring bean in the application context.

Since:

1.9.0

Author:

John Blum

See Also:

Configuration, Import, CacheServerConfiguration, EnableCacheServers, EnableCacheServer, ResourceManager, CacheServer, ClientSubscriptionConfig

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoStartup Configures whether the CacheServer should start automatically at runtime.
String	bindAddress Configures the ip address or host name that this cache server will listen on.
boolean	copyOnRead Indicates whether the "copy on read" is enabled for this cache.
float	criticalHeapPercentage Configures the percentage of heap at or above which the cache is considered in danger of becoming inoperable.
boolean	enableAutoReconnect By default, a GemFire member (both locators and servers) will attempt to reconnect and reinitialize the cache after it has been forced out of the distributed system by a network partition event or has otherwise been shunned by other members.
float	evictionHeapPercentage Configures the percentage of heap at or above which the eviction should begin on Regions configured for HeapLRU eviction.
String	hostnameForClients Configures the ip address or host name that server locators will tell clients that this cache server is listening on.
long	loadPollInterval Configures the frequency in milliseconds to poll the load probe on this cache server.
String	locators Configures the list of GemFire Locators defining the cluster to which this GemFire cache data node should connect.
int	lockLease Configures the length, in seconds, of distributed lock leases obtained by this cache.
int	lockTimeout Configures the number of seconds a cache operation will wait to obtain a distributed lock lease.
String	logLevel Configures the log level used to output log messages at GemFire cache runtime.
int	maxConnections Configures the maximum allowed client connections.
int	maxMessageCount Configures he maximum number of messages that can be enqueued in a client-queue.
int	maxThreads Configures the maximum number of threads allowed in this cache server to service client requests.
int	maxTimeBetweenPings Configures the maximum amount of time between client pings.
int	messageSyncInterval Configures the frequency (in seconds) at which a message will be sent by the primary cache-server to all the secondary cache-server nodes to remove the events which have already been dispatched from the queue.
int	messageTimeToLive Configures the time (in seconds ) after which a message in the client queue will expire.
String	name Configures the name of this GemFire member in the cluster (distributed system).
int	port Configures the port on which this cache server listens for clients.
int	searchTimeout Configures the number of seconds a cache get operation can spend searching for a value before it times out.
int	socketBufferSize Configures the configured buffer size of the socket connection for this CacheServer.
int	subscriptionCapacity Configures the capacity of the client queue.
String	subscriptionDiskStoreName Configures the disk store name for overflow.
SubscriptionEvictionPolicy	subscriptionEvictionPolicy Configures the eviction policy that is executed when capacity of the client queue is reached.
boolean	useBeanFactoryLocator Determines whether the Spring BeanFactory locator should be enabled to lookup the Spring BeanFactory to auto-wire and configure/initialize GemFire components created in a non-Spring managed, GemFire context.
boolean	useClusterConfiguration Configures whether this GemFire cache member node would pull it's configuration meta-data from the cluster-based Cluster Configuration service.

Element Detail

autoStartup

public abstract boolean autoStartup

Configures whether the CacheServer should start automatically at runtime. Default is {@literal true).

Default:

true

bindAddress

public abstract String bindAddress

Configures the ip address or host name that this cache server will listen on.

See Also:

CacheServer.DEFAULT_BIND_ADDRESS

Default:

""

copyOnRead

public abstract boolean copyOnRead

Indicates whether the "copy on read" is enabled for this cache. Default is false.

Default:

false

criticalHeapPercentage

public abstract float criticalHeapPercentage

Configures the percentage of heap at or above which the cache is considered in danger of becoming inoperable.

See Also:

ResourceManager.DEFAULT_CRITICAL_PERCENTAGE

Default:

0.0f

enableAutoReconnect

public abstract boolean enableAutoReconnect

By default, a GemFire member (both locators and servers) will attempt to reconnect and reinitialize the cache after it has been forced out of the distributed system by a network partition event or has otherwise been shunned by other members. Use this property to enable the auto-reconnect behavior. Default is false.

Default:

false

evictionHeapPercentage

public abstract float evictionHeapPercentage

Configures the percentage of heap at or above which the eviction should begin on Regions configured for HeapLRU eviction.

See Also:

ResourceManager.DEFAULT_EVICTION_PERCENTAGE

Default:

0.0f

hostnameForClients

public abstract String hostnameForClients

Configures the ip address or host name that server locators will tell clients that this cache server is listening on.

See Also:

CacheServer.DEFAULT_HOSTNAME_FOR_CLIENTS

Default:

""

loadPollInterval

public abstract long loadPollInterval

Configures the frequency in milliseconds to poll the load probe on this cache server.

See Also:

CacheServer.DEFAULT_LOAD_POLL_INTERVAL

Default:

5000L

locators

public abstract String locators

Configures the list of GemFire Locators defining the cluster to which this GemFire cache data node should connect.

Default:

""

lockLease

public abstract int lockLease

Configures the length, in seconds, of distributed lock leases obtained by this cache. Default is 120 seconds.

Default:

120

lockTimeout

public abstract int lockTimeout

Configures the number of seconds a cache operation will wait to obtain a distributed lock lease. Default is 60 seconds

Default:

60

logLevel

public abstract String logLevel

Configures the log level used to output log messages at GemFire cache runtime. Default is config.

Default:

"config"

maxConnections

public abstract int maxConnections

Configures the maximum allowed client connections.

See Also:

CacheServer.DEFAULT_MAX_CONNECTIONS

Default:

800

maxMessageCount

public abstract int maxMessageCount

Configures he maximum number of messages that can be enqueued in a client-queue.

See Also:

CacheServer.DEFAULT_MAXIMUM_MESSAGE_COUNT

Default:

230000

maxThreads

public abstract int maxThreads

Configures the maximum number of threads allowed in this cache server to service client requests.

See Also:

CacheServer.DEFAULT_MAX_THREADS

Default:

0

maxTimeBetweenPings

public abstract int maxTimeBetweenPings

Configures the maximum amount of time between client pings.

See Also:

CacheServer.DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS

Default:

60000

messageSyncInterval

public abstract int messageSyncInterval

Configures the frequency (in seconds) at which a message will be sent by the primary cache-server to all the secondary cache-server nodes to remove the events which have already been dispatched from the queue. Default is 1 second.

Default:

1

messageTimeToLive

public abstract int messageTimeToLive

Configures the time (in seconds ) after which a message in the client queue will expire.

See Also:

CacheServer.DEFAULT_MESSAGE_TIME_TO_LIVE

Default:

180

name

public abstract String name

Configures the name of this GemFire member in the cluster (distributed system). Default is SpringBasedCacheClientApplication.

Default:

"SpringBasedCacheServerApplication"

port

public abstract int port

Configures the port on which this cache server listens for clients.

See Also:

CacheServer.DEFAULT_PORT

Default:

40404

searchTimeout

public abstract int searchTimeout

Configures the number of seconds a cache get operation can spend searching for a value before it times out. Default is 300 seconds.

Default:

300

socketBufferSize

public abstract int socketBufferSize

Configures the configured buffer size of the socket connection for this CacheServer.

See Also:

CacheServer.DEFAULT_SOCKET_BUFFER_SIZE

Default:

32768

subscriptionCapacity

public abstract int subscriptionCapacity

Configures the capacity of the client queue.

See Also:

ClientSubscriptionConfig.DEFAULT_CAPACITY

Default:

1

subscriptionDiskStoreName

public abstract String subscriptionDiskStoreName

Configures the disk store name for overflow.

Default:

""

subscriptionEvictionPolicy

public abstract SubscriptionEvictionPolicy subscriptionEvictionPolicy

Configures the eviction policy that is executed when capacity of the client queue is reached. Defaults to SubscriptionEvictionPolicy.NONE.

Default:

org.springframework.data.gemfire.server.SubscriptionEvictionPolicy.NONE

useBeanFactoryLocator

public abstract boolean useBeanFactoryLocator

Determines whether the Spring BeanFactory locator should be enabled to lookup the Spring BeanFactory to auto-wire and configure/initialize GemFire components created in a non-Spring managed, GemFire context. Defaults to false.

Default:

false

useClusterConfiguration

public abstract boolean useClusterConfiguration

Configures whether this GemFire cache member node would pull it's configuration meta-data from the cluster-based Cluster Configuration service. Default is false.

Default:

false