org.springframework.data.gemfire.config.annotation

Annotation Type EnablePool

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

The EnablePool annotation configures a Spring Configuration annotated class with a "named" GemFire client Pool bean in the application context. This annotation is used in conjunction with the ClientCacheApplication annotation to add an additional Pool to a GemFire cache client application configured with Spring (Data GemFire). To add more than 1 Pool to your application, this annotation can be nested in the EnablePools annotation.

Since:

1.9.0

Author:

John Blum

See Also:

Pool, PoolFactory, AddPoolConfiguration, EnablePools, PoolConfigurer

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Specifies the name of the GemFire client Pool.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	freeConnectionTimeout Configures the free connection timeout for this pool.
long	idleTimeout Configures the amount of time a connection can be idle before expiring the connection.
int	loadConditioningInterval Configures the load conditioning interval for this pool.
EnablePool.Locator[]	locators Configures the GemFire Locators to which this cache client will connect.
String	locatorsString A String containing a comma-delimited list of hosts and ports defining the connection endpoints of GemFire Locators in the cluster.
int	maxConnections Configures the max number of client to server connections that the pool will create.
int	minConnections Configures the minimum number of connections to keep available at all times.
boolean	multiUserAuthentication If set to true then the created pool can be used by multiple users.
long	pingInterval Configures how often to ping servers to verify that they are still alive.
boolean	prSingleHopEnabled By default prSingleHopEnabled is true in which case the client is aware of the location of partitions on servers hosting Regions with DataPolicy.PARTITION.
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).
int	retryAttempts Configures the number of times to retry a request after timeout/exception.
String	serverGroup Configures the group that all servers this pool connects to must belong to.
EnablePool.Server[]	servers Configures the GemFire CacheServers to which this cache client will connect.
String	serversString A String containing a comma-delimited list of hosts and ports defining the connection endpoints of GemFire Servers in the cluster.
int	socketBufferSize Configures the socket buffer size for each connection made in this pool.
int	statisticInterval Configures how often to send client statistics to the server.
int	subscriptionAckInterval Configures the interval in milliseconds to wait before sending acknowledgements to the cache server for events received from the server subscriptions.
boolean	subscriptionEnabled If set to true then the created pool will have server-to-client subscriptions enabled.
int	subscriptionMessageTrackingTimeout Configures the messageTrackingTimeout attribute 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 this pools server-to-client subscriptions.
boolean	threadLocalConnections Configures the thread local connections policy for this pool.

Element Detail

name

public abstract String name

Specifies the name of the GemFire client Pool.

freeConnectionTimeout

public abstract int freeConnectionTimeout

Configures the free connection timeout for this pool.

See Also:

PoolFactory.DEFAULT_FREE_CONNECTION_TIMEOUT

Default:

10000

idleTimeout

public abstract long idleTimeout

Configures the amount of time a connection can be idle before expiring the connection.

See Also:

PoolFactory.DEFAULT_IDLE_TIMEOUT

Default:

5000L

loadConditioningInterval

public abstract int loadConditioningInterval

Configures the load conditioning interval for this pool.

See Also:

PoolFactory.DEFAULT_LOAD_CONDITIONING_INTERVAL

Default:

300000

locators

public abstract EnablePool.Locator[] locators

Configures the GemFire Locators to which this cache client will connect.

Default:

{}

locatorsString

public abstract String locatorsString

A String containing a comma-delimited list of hosts and ports defining the connection endpoints of GemFire Locators in the cluster. The String must be formatted as: 'host1[port], host2[port], ..., hostN[port]'.

Default:

""

maxConnections

public abstract int maxConnections

Configures the max number of client to server connections that the pool will create.

See Also:

PoolFactory.DEFAULT_MAX_CONNECTIONS

Default:

-1

minConnections

public abstract int minConnections

Configures the minimum number of connections to keep available at all times.

See Also:

PoolFactory.DEFAULT_MIN_CONNECTIONS

Default:

1

multiUserAuthentication

public abstract boolean multiUserAuthentication

If set to true then the created pool can be used by multiple users.

See Also:

PoolFactory.DEFAULT_MULTIUSER_AUTHENTICATION

Default:

false

pingInterval

public abstract long pingInterval

Configures how often to ping servers to verify that they are still alive.

See Also:

PoolFactory.DEFAULT_PING_INTERVAL

Default:

10000L

prSingleHopEnabled

public abstract boolean prSingleHopEnabled

By default prSingleHopEnabled is true in which case the client is aware of the location of partitions on servers hosting Regions with DataPolicy.PARTITION.

See Also:

PoolFactory.DEFAULT_PR_SINGLE_HOP_ENABLED

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

See Also:

PoolFactory.DEFAULT_READ_TIMEOUT

Default:

10000

retryAttempts

public abstract int retryAttempts

Configures the number of times to retry a request after timeout/exception.

See Also:

PoolFactory.DEFAULT_RETRY_ATTEMPTS

Default:

-1

serverGroup

public abstract String serverGroup

Configures the group that all servers this pool connects to must belong to.

See Also:

PoolFactory.DEFAULT_SERVER_GROUP

Default:

""

servers

public abstract EnablePool.Server[] servers

Configures the GemFire CacheServers to which this cache client will connect.

Default:

{}

serversString

public abstract String serversString

A String containing a comma-delimited list of hosts and ports defining the connection endpoints of GemFire Servers in the cluster. The String must be formatted as: 'host1[port], host2[port], ..., hostN[port]'.

Default:

""

socketBufferSize

public abstract int socketBufferSize

Configures the socket buffer size for each connection made in this pool.

See Also:

PoolFactory.DEFAULT_SOCKET_BUFFER_SIZE

Default:

32768

statisticInterval

public abstract int statisticInterval

Configures how often to send client statistics to the server.

See Also:

PoolFactory.DEFAULT_STATISTIC_INTERVAL

Default:

-1

subscriptionAckInterval

public abstract int subscriptionAckInterval

Configures the interval in milliseconds to wait before sending acknowledgements to the cache server for events received from the server subscriptions.

See Also:

PoolFactory.DEFAULT_SUBSCRIPTION_ACK_INTERVAL

Default:

100

subscriptionEnabled

public abstract boolean subscriptionEnabled

If set to true then the created pool will have server-to-client subscriptions enabled.

See Also:

PoolFactory.DEFAULT_SUBSCRIPTION_ENABLED

Default:

false

subscriptionMessageTrackingTimeout

public abstract int subscriptionMessageTrackingTimeout

Configures the messageTrackingTimeout attribute which is the time-to-live period, in milliseconds, for subscription events the client has received from the server.

See Also:

PoolFactory.DEFAULT_SUBSCRIPTION_MESSAGE_TRACKING_TIMEOUT

Default:

900000

subscriptionRedundancy

public abstract int subscriptionRedundancy

Configures the redundancy level for this pools server-to-client subscriptions.

See Also:

PoolFactory.DEFAULT_SUBSCRIPTION_REDUNDANCY

Default:

0

threadLocalConnections

public abstract boolean threadLocalConnections

Configures the thread local connections policy for this pool.

See Also:

PoolFactory.DEFAULT_THREAD_LOCAL_CONNECTIONS

Default:

false