org.springframework.data.gemfire.config.annotation

Annotation Type EnableCacheServer

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Import(value=AddCacheServerConfiguration.class)
public @interface EnableCacheServer

The EnableCacheServer annotation configures a Spring Configuration annotated class with a GemFire CacheServer bean in the Spring application context. This annotation is used in conjunction with the CacheServerApplication, or PeerCacheApplication annotations to add an additional CacheServers to a GemFire peer cache application configured with Spring (Data GemFire). To add more than 1 CacheServer to your application, this annotation can be nested in the EnableCacheServers annotation.

Since:

1.9.0

Author:

John Blum

See Also:

CacheServer, AddCacheServerConfiguration, CacheServerConfigurer, EnableCacheServers

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.
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.
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	messageTimeToLive Configures the time (in seconds ) after which a message in the client queue will expire.
String	name Configures the name of the Spring bean defined in the Spring application context.
int	port Configures the port on which this cache server listens for clients.
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.

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:

""

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

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

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 the Spring bean defined in the Spring application context. Defaults to empty.

Default:

""

port

public abstract int port

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

See Also:

CacheServer.DEFAULT_PORT

Default:

40404

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