EnablePool (Spring Data for Pivotal GemFire 2.2.13.RELEASE API)

```
@TargetSE(valueSE=TYPESE)
 @RetentionSE(valueSE=RUNTIMESE)
 @InheritedSE
 @DocumentedSE
 @Import(value=AddPoolConfiguration.class)
public @interface EnablePool
```
EnablePool アノテーションは、アプリケーションコンテキストで「名前付き」Pivotal GemFire クライアント Pool Bean を使用して、Spring Configuration アノテーション付きクラスを構成します。このアノテーションは、Spring (データ GemFire) で構成された Pivotal GemFire キャッシュクライアントアプリケーションに Pool を追加するために、ClientCacheApplication アノテーションと組み合わせて使用されます。アプリケーションに 1 つ以上の Pool を追加するには、このアノテーションを EnablePools アノテーションにネストできます。
導入:
1.9.0
作成者:
John Blum
関連事項:
Pool, PoolFactory, AddPoolConfiguration, AddPoolsConfiguration, EnablePools, PoolConfigurer

必須定数のサマリー

必須要素
修飾子と型	必須要素と説明
`StringSE`	`name` Pivotal GemFire/Apache Geode のクライアント `Pool` の `name`SE を指定します。これは、Spring コンテナーに登録されている Bean の名前としても使用され、application.properties からの `Pool` プロパティの解決に使用される名前としても使用されます (例:

オプション要素の概要

オプション要素
修飾子と型	オプションの要素と説明
`int`	`freeConnectionTimeout` このプールの空き接続タイムアウトを設定します。
`long`	`idleTimeout` 接続が期限切れになるまでのアイドル時間を設定します。
`int`	`loadConditioningInterval` このプールの負荷調整間隔を設定します。
`EnablePool.Locator[]`	`locators` このキャッシュクライアントが接続する Pivotal GemFire `Locators` を構成します。
`StringSE`	`locatorsString` クラスター内の Pivotal GemFire ロケーターの接続エンドポイントを定義するホストとポートのコンマ区切りリストを含む `String`SE。
`int`	`maxConnections` プールが作成するクライアントからサーバーへの接続の最大数を設定します。
`int`	`minConnections` 常に利用可能な接続の最小数を設定します。
`boolean`	`multiUserAuthentication` true に設定すると、作成されたプールを複数のユーザーが使用できるようになります。
`long`	`pingInterval` サーバーがまだ稼働しているかどうかを確認するために、サーバーに ping を実行する頻度を設定します。
`boolean`	`prSingleHopEnabled` デフォルトでは `prSingleHopEnabled` は true であり、この場合、クライアントは `DataPolicy.PARTITION` を使用してリージョンをホストしているサーバー上のパーティションの場所を認識します。
`int`	`readTimeout` 操作がタイムアウトして別のサーバー (使用可能な場合) を試行する前に、サーバーからのレスポンスを待機するミリ秒数を設定します。
`int`	`retryAttempts` タイムアウト / 例外後にリクエストを再試行する回数を設定します。
`StringSE`	`serverGroup` このプールが接続するすべてのサーバーが属する必要があるグループを構成します。
`EnablePool.Server[]`	`servers` このキャッシュクライアントが接続する Pivotal GemFire `CacheServers` を構成します。
`StringSE`	`serversString` クラスター内の Pivotal GemFire サーバーの接続エンドポイントを定義するホストとポートのコンマ区切りリストを含む `String`SE。
`int`	`socketBufferSize` このプールで行われる各接続のソケットバッファサイズを構成します。
`int`	`socketConnectTimeout` この「名前付き」 `Pool` の `socket connect timeout`SE を構成します。
`int`	`statisticInterval` クライアント統計をサーバーに送信する頻度を設定します。
`int`	`subscriptionAckInterval` サーバーサブスクリプションから受信したイベントの確認応答をキャッシュサーバーに送信する前に待機する間隔をミリ秒単位で構成します。
`boolean`	`subscriptionEnabled` true に設定すると、作成されたプールでサーバーからクライアントへのサブスクリプションが有効になります。
`int`	`subscriptionMessageTrackingTimeout` クライアントがサーバーから受信したサブスクリプションイベントの有効期間 (ミリ秒単位) である messageTrackingTimeout 属性を構成します。
`int`	`subscriptionRedundancy` このプールのサーバーからクライアントへのサブスクリプションの冗長レベルを構成します。
`boolean`	`threadLocalConnections` このプールのスレッドローカル接続ポリシーを構成します。

- 要素の詳細
  - name
```
public abstract StringSE name
```
    Pivotal GemFire/Apache Geode のクライアント Pool の nameSE を指定します。これは、Spring コンテナーに登録されている Bean の名前としても使用され、この Pool に固有の application.properties からの Pool プロパティ (例: spring.data.gemfire.pool.<poolName>.max-connections) の解決に使用される名前としても使用されます。
- - freeConnectionTimeout
```
public abstract int freeConnectionTimeout
```
    このプールの空き接続タイムアウトを設定します。デフォルトは PoolFactory.DEFAULT_FREE_CONNECTION_TIMEOUT です。application.properties の spring.data.gemfire.pool.<poolName>.free-connection-timeout プロパティまたは spring.data.gemfire.pool.free-connection-timeout プロパティのいずれかを使用します。
    デフォルト:
    10000
- - idleTimeout
```
public abstract long idleTimeout
```
    接続が期限切れになるまでのアイドル時間を設定します。デフォルトは PoolFactory.DEFAULT_IDLE_TIMEOUT です。application.properties の spring.data.gemfire.pool.<poolName>.idle-timeout プロパティまたは spring.data.gemfire.pool.idle-timeout プロパティのいずれかを使用します。
    デフォルト:
    5000L
- - loadConditioningInterval
```
public abstract int loadConditioningInterval
```
    このプールの負荷調整間隔を設定します。デフォルトは PoolFactory.DEFAULT_LOAD_CONDITIONING_INTERVAL です。application.properties の spring.data.gemfire.pool.<poolName>.load-conditioning-interval プロパティまたは spring.data.gemfire.pool.load-conditioning-interval プロパティのいずれかを使用します。
    デフォルト:
    300000
- - locators
```
public abstract EnablePool.Locator[] locators
```
    このキャッシュクライアントが接続する Pivotal GemFire Locators を構成します。application.properties の spring.data.gemfire.pool.<poolName>.locators プロパティまたは spring.data.gemfire.pool.locators プロパティのいずれかを使用します。
    デフォルト:
    {}
- - locatorsString
```
public abstract StringSE locatorsString
```
    クラスター内の Pivotal GemFire ロケーターの接続エンドポイントを定義するホストとポートのコンマ区切りリストを含む StringSE。StringSE は、「host1[port]、host2[port]、...、hostN[port]」という形式にする必要があります。application.properties の spring.data.gemfire.pool.<poolName>.locators プロパティまたは spring.data.gemfire.pool.locators プロパティのいずれかを使用します。
    デフォルト:
    ""
- - maxConnections
```
public abstract int maxConnections
```
    プールが作成するクライアントからサーバーへの接続の最大数を設定します。デフォルトは PoolFactory.DEFAULT_MAX_CONNECTIONS です。application.properties の spring.data.gemfire.pool.<poolName>.max-connections プロパティまたは spring.data.gemfire.pool.max-connections プロパティのいずれかを使用します。
    デフォルト:
    -1
- - minConnections
```
public abstract int minConnections
```
    常に利用可能な接続の最小数を設定します。デフォルトは PoolFactory.DEFAULT_MIN_CONNECTIONS です。application.properties の spring.data.gemfire.pool.<poolName>.min-connections プロパティまたは spring.data.gemfire.pool.min-connections プロパティのいずれかを使用します。
    デフォルト:
    1
- - multiUserAuthentication
```
public abstract boolean multiUserAuthentication
```
    true に設定すると、作成されたプールを複数のユーザーが使用できます。デフォルトは PoolFactory.DEFAULT_MULTIUSER_AUTHENTICATION です。application.properties で spring.data.gemfire.pool.<poolName>.multi-user-authentication プロパティまたは spring.data.gemfire.pool.multi-user-authentication プロパティのいずれかを使用します。
    デフォルト:
    false
- - pingInterval
```
public abstract long pingInterval
```
    サーバーがまだ稼働しているかどうかを確認するために、サーバーに ping を実行する頻度を設定します。デフォルトは PoolFactory.DEFAULT_PING_INTERVAL です。application.properties の spring.data.gemfire.pool.<poolName>.ping-interval プロパティまたは spring.data.gemfire.pool.ping-interval プロパティのいずれかを使用します。
    デフォルト:
    10000L
- - prSingleHopEnabled
```
public abstract boolean prSingleHopEnabled
```
    デフォルトでは、prSingleHopEnabled は true です。この場合、クライアントは、DataPolicy.PARTITION でリージョンをホストしているサーバー上のパーティションの場所を認識します。デフォルトは PoolFactory.DEFAULT_PR_SINGLE_HOP_ENABLED です。application.properties で、spring.data.gemfire.pool.<poolName>.pr-single-hop-enabled プロパティまたは spring.data.gemfire.pool.pr-single-hop-enabled プロパティのいずれかを使用します。
    デフォルト:
    true
- - readTimeout
```
public abstract int readTimeout
```
    操作がタイムアウトして別のサーバー (使用可能な場合) を試す前に、サーバーからのレスポンスを待機するミリ秒数を設定します。デフォルトは PoolFactory.DEFAULT_READ_TIMEOUT です。application.properties の spring.data.gemfire.pool.<poolName>.read-timeout プロパティまたは spring.data.gemfire.pool.read-timeout プロパティのいずれかを使用します。
    デフォルト:
    10000
- - retryAttempts
```
public abstract int retryAttempts
```
    タイムアウト / 例外後にリクエストを再試行する回数を設定します。デフォルトは PoolFactory.DEFAULT_RETRY_ATTEMPTS です。application.properties の spring.data.gemfire.pool.<poolName>.retry-attempts プロパティまたは spring.data.gemfire.pool.retry-attempts プロパティのいずれかを使用します。
    デフォルト:
    -1
- - serverGroup
```
public abstract StringSE serverGroup
```
    このプールが接続するすべてのサーバーが属する必要があるグループを構成します。デフォルトは PoolFactory.DEFAULT_SERVER_GROUP です。application.properties の spring.data.gemfire.pool.<poolName>.server-group プロパティまたは spring.data.gemfire.pool.server-group プロパティのいずれかを使用します。
    デフォルト:
    ""
- - servers
```
public abstract EnablePool.Server[] servers
```
    このキャッシュクライアントが接続する Pivotal GemFire CacheServers を構成します。application.properties の spring.data.gemfire.pool.<poolName>.servers プロパティまたは spring.data.gemfire.pool.servers プロパティのいずれかを使用します。
    デフォルト:
    {}
- - serversString
```
public abstract StringSE serversString
```
    クラスター内の Pivotal GemFire サーバーの接続エンドポイントを定義するホストとポートのコンマ区切りリストを含む StringSE。StringSE は、「host1[port]、host2[port]、...、hostN[port]」という形式にする必要があります。application.properties の spring.data.gemfire.pool.<poolName>.servers プロパティまたは spring.data.gemfire.pool.servers プロパティのいずれかを使用します。
    デフォルト:
    ""
- - socketBufferSize
```
public abstract int socketBufferSize
```
    このプールで行われる各接続のソケットバッファサイズを設定します。デフォルトは PoolFactory.DEFAULT_SOCKET_BUFFER_SIZE です。application.properties の spring.data.gemfire.pool.<poolName>.socket-buffer-size プロパティまたは spring.data.gemfire.pool.socket-buffer-size プロパティのいずれかを使用します。
    デフォルト:
    32768
- - socketConnectTimeout
```
public abstract int socketConnectTimeout
```
    この「名前付き」 Pool の socket connect timeoutSE を設定します。クライアントがサーバー / ロケーターに接続するときのソケットタイムアウトとして指定されるミリ秒数。タイムアウトが 0 の場合、無限タイムアウトとして解釈されます。接続は確立されるかエラーが発生するまでブロックされます。デフォルトは PoolFactory.DEFAULT_SOCKET_CONNECT_TIMEOUT です。application.properties の spring.data.gemfire.pool.<poolName>.socket-connect-timeout プロパティまたは spring.data.gemfire.pool.socket-connect-timeout プロパティのいずれかを使用します。
    デフォルト:
    59000
- - statisticInterval
```
public abstract int statisticInterval
```
    クライアント統計をサーバーに送信する頻度を設定します。デフォルトは PoolFactory.DEFAULT_STATISTIC_INTERVAL です。application.properties の spring.data.gemfire.pool.<poolName>.statistic-interval プロパティまたは spring.data.gemfire.pool.statistic-interval プロパティのいずれかを使用します。
    デフォルト:
    -1
- - subscriptionAckInterval
```
public abstract int subscriptionAckInterval
```
    サーバーサブスクリプションから受信したイベントの確認応答をキャッシュサーバーに送信する前に待機する間隔をミリ秒単位で構成します。デフォルトは PoolFactory.DEFAULT_SUBSCRIPTION_ACK_INTERVAL です。application.properties の spring.data.gemfire.pool.<poolName>.subscription-ack-interval プロパティまたは spring.data.gemfire.pool.subscription-ack-interval プロパティのいずれかを使用します。
    デフォルト:
    100
- - subscriptionEnabled
```
public abstract boolean subscriptionEnabled
```
    true に設定すると、作成されたプールでサーバーからクライアントへのサブスクリプションが有効になります。デフォルトは PoolFactory.DEFAULT_SUBSCRIPTION_ENABLED です。application.properties で spring.data.gemfire.pool.<poolName>.subscription-enabled プロパティまたは spring.data.gemfire.pool.subscription-enabled プロパティのいずれかを使用します。
    デフォルト:
    false
- - subscriptionMessageTrackingTimeout
```
public abstract int subscriptionMessageTrackingTimeout
```
    クライアントがサーバーから受信したサブスクリプションイベントの有効期間 (ミリ秒単位) である messageTrackingTimeout 属性を構成します。デフォルトは PoolFactory.DEFAULT_SUBSCRIPTION_MESSAGE_TRACKING_TIMEOUT です。application.properties の spring.data.gemfire.pool.<poolName>.subscription-message-tracking-timeout プロパティまたは spring.data.gemfire.pool.subscription-message-tracking-timeout プロパティのいずれかを使用します。
    デフォルト:
    900000
- - subscriptionRedundancy
```
public abstract int subscriptionRedundancy
```
    このプールのサーバーからクライアントへのサブスクリプションの冗長性レベルを構成します。デフォルトは PoolFactory.DEFAULT_SUBSCRIPTION_REDUNDANCY です。application.properties の spring.data.gemfire.pool.<poolName>.subscription-redundancy プロパティまたは spring.data.gemfire.pool.subscription-redundancy プロパティのいずれかを使用します。
    デフォルト:
    0
- - threadLocalConnections
```
public abstract boolean threadLocalConnections
```
    このプールのスレッドローカル接続ポリシーを構成します。デフォルトは PoolFactory.DEFAULT_THREAD_LOCAL_CONNECTIONS です。application.properties の spring.data.gemfire.pool.<poolName>.thread-local-connections プロパティまたは spring.data.gemfire.pool.thread-local-connections プロパティのいずれかを使用します。
    デフォルト:
    false

アノテーション型 EnablePool

必須定数のサマリー

オプション要素の概要

要素の詳細

name

freeConnectionTimeout

idleTimeout

loadConditioningInterval

locators

locatorsString

maxConnections

minConnections

multiUserAuthentication

pingInterval

prSingleHopEnabled

readTimeout

retryAttempts

serverGroup

servers

serversString

socketBufferSize

socketConnectTimeout

statisticInterval

subscriptionAckInterval

subscriptionEnabled

subscriptionMessageTrackingTimeout

subscriptionRedundancy

threadLocalConnections