ZooKeeperConnection (Spring XD 1.3.2.RELEASE API)

java.lang.Object
- org.springframework.xd.dirt.zookeeper.ZooKeeperConnection

実装済みのインターフェース一覧:
org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
```
public class ZooKeeperConnection
extends java.lang.Object
implements org.springframework.context.SmartLifecycle
```
ライフサイクルが Spring Bean として管理される CuratorFramework インスタンスのラッパー。接続または切断イベントの受信時に通知される ZooKeeperConnectionListener を受け入れます。
作成者:
Mark Fisher, David Turanski, Patrick Peralta

フィールド概要

フィールド
修飾子と型	フィールドと説明
`static java.lang.String`	`DEFAULT_CLIENT_CONNECT_STRING` デフォルトのクライアント接続文字列。
`static int`	`DEFAULT_CONNECTION_TIMEOUT` デフォルトの ZooKeeper 接続タイムアウト（ミリ秒単位）。
`static int`	`DEFAULT_INITIAL_RETRY_WAIT` 接続再試行間のデフォルトの初期ミリ秒数。
`static int`	`DEFAULT_MAX_RETRY_ATTEMPTS` 接続試行が失敗した後に行われるデフォルトの接続試行回数。
`static int`	`DEFAULT_SESSION_TIMEOUT` デフォルトの ZooKeeper セッションタイムアウト (ミリ秒単位)。

コンストラクター概要

コンストラクター
コンストラクターと説明
`ZooKeeperConnection()` デフォルトのクライアント接続文字列 "localhost:2181" を使用して ZooKeeper 接続を確立します
`ZooKeeperConnection(java.lang.String clientConnectString)` 提供されたクライアント接続文字列を使用して ZooKeeper 接続を確立します。
`ZooKeeperConnection(java.lang.String clientConnectString, java.lang.String namespace)` 提供されたクライアント接続文字列と名前空間を使用して ZooKeeper 接続を確立します。
`ZooKeeperConnection(java.lang.String clientConnectString, java.lang.String namespace, int sessionTimeout, int connectionTimeout, int initialRetryWait, int retryMaxAttempts)` 提供されたクライアント接続文字列、名前空間、タイミング値を使用して ZooKeeper 接続を確立します。

方法の概要

メソッド
修飾子と型	メソッドと説明
`boolean`	`addListener(ZooKeeperConnectionListener listener)` `ZooKeeperConnectionListener` を追加します。
`org.apache.curator.framework.CuratorFramework`	`getClient()` 基盤となる `CuratorFramework` インスタンスへのアクセスを提供します。
`int`	`getPhase()`
`org.apache.curator.RetryPolicy`	`getRetryPolicy()` Curator 再試行ポリシーを返します。
`boolean`	`isAutoStartup()`
`boolean`	`isConnected()` 基礎となる接続が確立されているかどうかを確認します。
`boolean`	`isRunning()` このクライアントが実行されているかどうかを確認します。
`boolean`	`removeListener(ZooKeeperConnectionListener listener)` `ZooKeeperConnectionListener` を削除します。
`void`	`setAutoStartup(boolean autoStartup)` この接続を自動的に開始するかどうかを示すフラグを設定します。
`void`	`setRetryPolicy(org.apache.curator.RetryPolicy retryPolicy)` Curator 再試行ポリシーを設定します。
`void`	`start()` 基礎となる `CuratorFramework` インスタンスを起動します。
`void`	`stop()` 基になる `CuratorFramework` インスタンスを閉じます。
`void`	`stop(java.lang.Runnable callback)` 基になる `CuratorFramework` インスタンスを閉じて、コールバックを呼び出します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - DEFAULT_CLIENT_CONNECT_STRING
```
public static final java.lang.String DEFAULT_CLIENT_CONNECT_STRING
```
    デフォルトのクライアント接続文字列。ローカルホストのポート 2181。
    関連事項:
    定数フィールド値
  - DEFAULT_SESSION_TIMEOUT
```
public static final int DEFAULT_SESSION_TIMEOUT
```
    デフォルトの ZooKeeper セッションタイムアウト (ミリ秒単位)。
    関連事項:
    定数フィールド値
  - DEFAULT_CONNECTION_TIMEOUT
```
public static final int DEFAULT_CONNECTION_TIMEOUT
```
    デフォルトの ZooKeeper 接続タイムアウト（ミリ秒単位）。
    関連事項:
    定数フィールド値
  - DEFAULT_INITIAL_RETRY_WAIT
```
public static final int DEFAULT_INITIAL_RETRY_WAIT
```
    接続再試行間のデフォルトの初期ミリ秒数。
    関連事項:
    定数フィールド値
  - DEFAULT_MAX_RETRY_ATTEMPTS
```
public static final int DEFAULT_MAX_RETRY_ATTEMPTS
```
    接続試行が失敗した後に行われるデフォルトの接続試行回数。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - ZooKeeperConnection
```
public ZooKeeperConnection()
```
    デフォルトのクライアント接続文字列 "localhost:2181" を使用して ZooKeeper 接続を確立します
  - ZooKeeperConnection
```
public ZooKeeperConnection(java.lang.String clientConnectString)
```
    提供されたクライアント接続文字列を使用して ZooKeeper 接続を確立します。
    パラメーター:
    clientConnectString - 1 つ以上の host:port 文字列（複数の場合はカンマで区切る）
  - ZooKeeperConnection
```
public ZooKeeperConnection(java.lang.String clientConnectString,
                   java.lang.String namespace)
```
    提供されたクライアント接続文字列と名前空間を使用して ZooKeeper 接続を確立します。
    パラメーター:
    clientConnectString - 1 つ以上の host:port 文字列（複数の場合はカンマで区切る）
    namespace - ZooKeeper のルートパス名前空間 (または null の場合はデフォルトの名前空間)
  - ZooKeeperConnection
```
public ZooKeeperConnection(java.lang.String clientConnectString,
                   java.lang.String namespace,
                   int sessionTimeout,
                   int connectionTimeout,
                   int initialRetryWait,
                   int retryMaxAttempts)
```
    提供されたクライアント接続文字列、名前空間、タイミング値を使用して ZooKeeper 接続を確立します。
    このクラスは内部的に ExponentialBackoffRetry を使用します。
    パラメーター:
    clientConnectString - 1 つ以上の host:port 文字列（複数の場合はカンマで区切る）
    namespace - ZooKeeper のルートパス名前空間 (または null の場合はデフォルトの名前空間)
    sessionTimeout - ZooKeeper セッションタイムアウト（ミリ秒）
    connectionTimeout - ZooKeeper 接続タイムアウト（ミリ秒）
    initialRetryWait - 接続再試行間隔（ミリ秒） (基準値)
    retryMaxAttempts - 接続試行が失敗した後に行われる接続試行の回数
- メソッドの詳細
  - isConnected
```
public boolean isConnected()
```
    基礎となる接続が確立されているかどうかを確認します。
    戻り値:
    接続されている場合、true
  - getClient
```
public org.apache.curator.framework.CuratorFramework getClient()
```
    基盤となる CuratorFramework インスタンスへのアクセスを提供します。
    戻り値:
    CuratorFramework インスタンス
  - addListener
```
public boolean addListener(ZooKeeperConnectionListener listener)
```
    ZooKeeperConnectionListener を追加します。
    パラメーター:
    listener - 追加するリスナー
    戻り値:
    リスナーが追加された場合には true、すでに登録されている場合には false
  - removeListener
```
public boolean removeListener(ZooKeeperConnectionListener listener)
```
    ZooKeeperConnectionListener を削除します。
    パラメーター:
    listener - 削除するリスナー
    戻り値:
    リスナーが削除された場合は true、登録されなかった場合は false
  - isAutoStartup
```
public boolean isAutoStartup()
```
    次で指定:
    インターフェース org.springframework.context.SmartLifecycle 内の isAutoStartup
  - setAutoStartup
```
public void setAutoStartup(boolean autoStartup)
```
    この接続を自動的に開始するかどうかを示すフラグを設定します。
    パラメーター:
    autoStartup - true の場合、この接続は自動的に開始されることを示します
  - setRetryPolicy
```
public void setRetryPolicy(org.apache.curator.RetryPolicy retryPolicy)
```
    Curator 再試行ポリシーを設定します。
    パラメーター:
    retryPolicy - キュレータークライアント RetryPolicy
  - getRetryPolicy
```
public org.apache.curator.RetryPolicy getRetryPolicy()
```
    Curator 再試行ポリシーを返します。
    戻り値:
    キュレーターの再試行ポリシー
  - getPhase
```
public int getPhase()
```
    次で指定:
    インターフェース org.springframework.context.Phased 内の getPhase
  - isRunning
```
public boolean isRunning()
```
    このクライアントが実行されているかどうかを確認します。
    次で指定:
    インターフェース org.springframework.context.Lifecycle 内の isRunning
  - start
```
public void start()
```
    基礎となる CuratorFramework インスタンスを起動します。
    次で指定:
    インターフェース org.springframework.context.Lifecycle 内の start
  - stop
```
public void stop()
```
    基になる CuratorFramework インスタンスを閉じます。
    次で指定:
    インターフェース org.springframework.context.Lifecycle 内の stop
  - stop
```
public void stop(java.lang.Runnable callback)
```
    基になる CuratorFramework インスタンスを閉じて、コールバックを呼び出します。
    次で指定:
    インターフェース org.springframework.context.SmartLifecycle 内の stop

クラス ZooKeeperConnection

フィールド概要

コンストラクター概要

方法の概要

クラス java.lang.Object から継承されたメソッド

フィールドの詳細

DEFAULT_CLIENT_CONNECT_STRING

DEFAULT_SESSION_TIMEOUT

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_INITIAL_RETRY_WAIT

DEFAULT_MAX_RETRY_ATTEMPTS

コンストラクターの詳細

ZooKeeperConnection

ZooKeeperConnection

ZooKeeperConnection

ZooKeeperConnection

メソッドの詳細

isConnected

getClient

addListener

removeListener

isAutoStartup

setAutoStartup

setRetryPolicy

getRetryPolicy

getPhase

isRunning

start

stop

stop