OkuyamaClientFactoryImpl (Java client library for Okuyama KVS 1.1.3 API)

java.lang.Object
- mitonize.datastore.okuyama.OkuyamaClientFactoryImpl

すべての実装されたインタフェース:: OkuyamaClientFactory

public class OkuyamaClientFactoryImpl
extends Object
implements OkuyamaClientFactory

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`OkuyamaClientFactoryImpl(String[] masternodes, int minPoolSize)` マスターノード、最小のソケットプールサイズを指定してファクトリクラスを生成する。
`OkuyamaClientFactoryImpl(String[] masternodes, int minPoolSize, boolean compatibilityMode)` マスターノード、最小のソケットプールサイズ、互換モードを指定してファクトリクラスを生成する。
`OkuyamaClientFactoryImpl(String[] masternodes, int minPoolSize, boolean compatibilityMode, boolean dumpStream)` マスターノード、最小のソケットプールサイズ、互換モード、ストリームのダンプモードを指定してファクトリクラスを生成する。
`OkuyamaClientFactoryImpl(String[] masternodes, int minPoolSize, boolean compatibilityMode, boolean dumpStream, CompressionStrategy compressionStrategy)` マスターノード、最小のソケットプールサイズ、互換モード、ストリームのダンプモードを指定してファクトリクラスを生成する。

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`OkuyamaClient`	`createClient()` `OkuyamaClient`を生成する。
`void`	`destroy()` 確保しているリソースを解放してファクトリクラスを破棄する。
`CompressionStrategy`	`getCompressionStrategy()` 圧縮戦略を取得する。
`int`	`getDelayToMarkOnlineInMillis()` オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)を取得
`int`	`getMaxCoucurrentSockets()` 同時に開いたソケットの最大値を取得する。
`int`	`getMaxPoolSize()` 保持するソケットの最大数を取得する。
`SocketManager`	`getSocketManager()`
`int`	`getTimeoutToConnectInMillis()` TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)を取得する。
`int`	`getTimeoutToReadInMillis()` ソケットの読み取りタイムアウト時間(ミリ秒)を取得する。
`boolean`	`isBase64key()` キーをBase64でエンコードするかを返す。
`boolean`	`isCompatibilityMode()` 互換モードが設定されているかを確認する。
`boolean`	`isCompressionMode()` 圧縮モードを取得する。
`boolean`	`isSerializeString()` 文字列を格納する際にJavaのシリアライズをするかを返す。
`void`	`setBase64key(boolean base64key)` キーをBase64でエンコードする設定をする。
`void`	`setCompatibilityMode(boolean compatibilityMode)` 互換モードを設定する。
`void`	`setCompressionMode(boolean doCompress)` 圧縮モードを設定する。
`void`	`setCompressionStrategy(CompressionStrategy compressionStrategy)` 圧縮戦略を設定する。
`void`	`setDelayToMarkOnlineInMillis(int delayToMarkOnlineInMillis)` オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)を設定する(デフォルト:3000ミリ秒)。
`void`	`setSerializeString(boolean serializeString)` 文字列を格納する際にJavaのシリアライズをするかを設定する。
`void`	`setSocketManager(SocketManager socketManager)`
`void`	`setSocketTimeToLiveInMilli(long socketTimeToLiveInMilli)` 新規に作成されてから設定値の期間経過したソケットは、そのソケットがプールから選択されるタイミングで削除され、利用されなくなります。
`void`	`setTimeoutToConnectInMillis(int timeoutToConnectInMillis)` TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)を設定する(デフォルト:1000ミリ秒)。
`void`	`setTimeoutToReadInMillis(int timeoutToReadInMillis)` ソケットの読み取りタイムアウト時間(ミリ秒)を設定する(デフォルト:1000ミリ秒)

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

- コンストラクタの詳細
  - OkuyamaClientFactoryImpl
```
public OkuyamaClientFactoryImpl(String[] masternodes,
                                int minPoolSize)
                         throws UnknownHostException
```
    マスターノード、最小のソケットプールサイズを指定してファクトリクラスを生成する。マスターノードの指定は、[ホスト名]:[ポート番号] の形式の文字列の配列である。オリジナルのOkuyamaClientから読み出せる形式で書き出すようにする（互換モード）。
    互換モードを設定すると下のような状態で稼働する。
    - キーを必ずbase64エンコードする
    - 文字列を格納する場合にもJavaのシリアライズを行ってからBase64エンコードする
    - 圧縮しない（圧縮設定すると例外を発生させる）
    パラメータ:
    
    masternodes - マスターノード接続先の配列
    
    minPoolSize - 最小のソケットプールサイズ
    
    例外:
    
    UnknownHostException - 指定したホスト名のIPアドレスが取得できない場合
    
    IllegalArgumentException - 指定したホストの形式が不正の場合
  - OkuyamaClientFactoryImpl
```
public OkuyamaClientFactoryImpl(String[] masternodes,
                                int minPoolSize,
                                boolean compatibilityMode)
                         throws UnknownHostException
```
    マスターノード、最小のソケットプールサイズ、互換モードを指定してファクトリクラスを生成する。マスターノードの指定は、[ホスト名]:[ポート番号] の形式の文字列の配列である。オリジナルのOkuyamaClientからでも読み出し可能な形式で格納するかを指定する（互換モード）。互換モードを設定すると下のような状態で稼働する。
    - キーを必ずbase64エンコードする
    - 文字列を格納する場合にもJavaのシリアライズを行ってからBase64エンコードする
    - 圧縮しない（圧縮設定すると例外を発生させる）
    パラメータ:
    
    masternodes - マスターノード接続先の配列
    
    minPoolSize - 最小のソケットプールサイズ
    
    compatibilityMode - オリジナルOkuyamaClient互換モード
    
    例外:
    
    UnknownHostException - 指定したホスト名のIPアドレスが取得できない場合
    
    IllegalArgumentException - 指定したホストの形式が不正の場合
  - OkuyamaClientFactoryImpl
```
public OkuyamaClientFactoryImpl(String[] masternodes,
                                int minPoolSize,
                                boolean compatibilityMode,
                                boolean dumpStream)
                         throws UnknownHostException
```
    マスターノード、最小のソケットプールサイズ、互換モード、ストリームのダンプモードを指定してファクトリクラスを生成する。マスターノードの指定は、[ホスト名]:[ポート番号] の形式の文字列の配列である。オリジナルのOkuyamaClientからでも読み出し可能な形式で格納するかを指定する（互換モード）。互換モードを設定すると下のような状態で稼働する。
    - キーを必ずbase64エンコードする
    - 文字列を格納する場合にもJavaのシリアライズを行ってからBase64エンコードする
    - 圧縮しない（圧縮設定すると例外を発生させる）
    パラメータ:
    
    masternodes - マスターノード接続先の配列
    
    minPoolSize - 最小のソケットプールサイズ
    
    compatibilityMode - オリジナルOkuyamaClient互換モード
    
    dumpStream - 入出力のストリームをダンプする(主にデバッグ用)
    
    例外:
    
    UnknownHostException - 指定したホスト名のIPアドレスが取得できない場合
    
    IllegalArgumentException - 指定したホストの形式が不正の場合
  - OkuyamaClientFactoryImpl
```
public OkuyamaClientFactoryImpl(String[] masternodes,
                                int minPoolSize,
                                boolean compatibilityMode,
                                boolean dumpStream,
                                CompressionStrategy compressionStrategy)
                         throws UnknownHostException
```
    マスターノード、最小のソケットプールサイズ、互換モード、ストリームのダンプモードを指定してファクトリクラスを生成する。マスターノードの指定は、[ホスト名]:[ポート番号] の形式の文字列の配列である。ストリームのダンプを指定すると標準出力にOkuyamaマスターノードへの入出力データをダンプする。圧縮戦略を指定すると、キーのパターンや値のサイズに応じで圧縮の有無、圧縮アルゴリズムの選択ができる。(参照 CompressionStrategy)
    互換モードを指定すると、オリジナルのOkuyamaClientからでも読み出し可能な形式で格納するように下の設定でクライアントを生成する。
    - キーを必ずbase64エンコードする
    - 文字列を格納する場合にもJavaのシリアライズを行ってからBase64エンコードする
    - 圧縮しない（圧縮戦略を設定すると例外を発生させる）
    パラメータ:
    
    masternodes - マスターノード接続先の配列
    
    minPoolSize - 最小のソケットプールサイズ
    
    compatibilityMode - オリジナルOkuyamaClient互換モード
    
    dumpStream - 入出力のストリームをダンプする(主にデバッグ用)
    
    compressionStrategy - 圧縮戦略
    
    例外:
    
    UnknownHostException - 指定したホスト名のIPアドレスが取得できない場合
    
    IllegalArgumentException - 指定したホストの形式が不正の場合、互換モードを指定しているにもかかわらず圧縮戦略を指定した場合
- メソッドの詳細
  - createClient
```
public OkuyamaClient createClient()
```
    インタフェースからコピーされた説明: OkuyamaClientFactory
    
    OkuyamaClientを生成する。接続先や各種パラメータは OkuyamaClientFactoryの実装クラスで設定されたものを用いる。
    
    定義:
    
    createClient インタフェース内 OkuyamaClientFactory
    
    戻り値:
    
    OkuyamaClientインスタンス(使用後はdestroyClientに渡す)
  - destroy
```
public void destroy()
```
    インタフェースからコピーされた説明: OkuyamaClientFactory
    
    確保しているリソースを解放してファクトリクラスを破棄する。
    
    定義:
    
    destroy インタフェース内 OkuyamaClientFactory
  - isCompatibilityMode
```
public boolean isCompatibilityMode()
```
    互換モードが設定されているかを確認する。
    
    戻り値:
    
    互換モードに設定されているなら true
  - setCompatibilityMode
```
public void setCompatibilityMode(boolean compatibilityMode)
```
    互換モードを設定する。trueが設定された場合は圧縮は無効化される。
    
    パラメータ:
    
    compatibilityMode - 互換モードに設定するなら true
  - getCompressionStrategy
```
public CompressionStrategy getCompressionStrategy()
```
    圧縮戦略を取得する。
    
    戻り値:
    
    設定されている圧縮戦略。未設定ならnull
  - setCompressionStrategy
```
public void setCompressionStrategy(CompressionStrategy compressionStrategy)
```
    圧縮戦略を設定する。簡易的なものはDefaultCompressionStrategyで提供される。設定を解除する場合はnullを設定する。
    
    パラメータ:
    
    compressionStrategy - 圧縮戦略。解除する場合はnull
  - isCompressionMode
```
public boolean isCompressionMode()
```
    圧縮モードを取得する。
    
    戻り値:
    
    圧縮する場合はtrue
  - setCompressionMode
```
public void setCompressionMode(boolean doCompress)
```
    圧縮モードを設定する。圧縮する場合はデフォルトの圧縮戦略DefaultCompressionStrategyが利用される。
    
    パラメータ:
    
    doCompress - 圧縮する場合はtrue
  - isBase64key
```
public boolean isBase64key()
```
    キーをBase64でエンコードするかを返す。
    
    戻り値:
    
    キーをBase64でエンコードするならtrue
  - setBase64key
```
public void setBase64key(boolean base64key)
```
    キーをBase64でエンコードする設定をする。(デフォルト:true)
    
    パラメータ:
    
    base64key - キーをBase64でエンコードするならtrue
  - isSerializeString
```
public boolean isSerializeString()
```
    文字列を格納する際にJavaのシリアライズをするかを返す。
    
    戻り値:
    
    文字列を格納する際にJavaのシリアライズをするならtrue
  - setSerializeString
```
public void setSerializeString(boolean serializeString)
```
    文字列を格納する際にJavaのシリアライズをするかを設定する。(デフォルト:false) 互換モードが設定されている場合は強制的にシリアライズされる。
    
    パラメータ:
    
    serializeString - 文字列を格納する際にJavaのシリアライズをするならtrue
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
    保持するソケットの最大数を取得する。一時的に同時利用ソケット数がこの上限値を超える場合があるが、同時使用数が落ち着くと、この上限数分のソケットは切断されずに保持される。
    
    戻り値:
    
    保持するソケットの最大数
  - getMaxCoucurrentSockets
```
public int getMaxCoucurrentSockets()
```
    同時に開いたソケットの最大値を取得する。
    
    戻り値:
    
    同時に開いたソケットの最大値
  - getTimeoutToReadInMillis
```
public int getTimeoutToReadInMillis()
```
    ソケットの読み取りタイムアウト時間(ミリ秒)を取得する。
    
    戻り値:
    
    ソケットの読み取りタイムアウト時間(ミリ秒)
  - setTimeoutToReadInMillis
```
public void setTimeoutToReadInMillis(int timeoutToReadInMillis)
```
    ソケットの読み取りタイムアウト時間(ミリ秒)を設定する(デフォルト:1000ミリ秒)
    
    パラメータ:
    
    timeoutToReadInMillis - ソケットの読み取りタイムアウト時間(ミリ秒)
  - getTimeoutToConnectInMillis
```
public int getTimeoutToConnectInMillis()
```
    TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)を取得する。
    
    戻り値:
    
    TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)
  - setTimeoutToConnectInMillis
```
public void setTimeoutToConnectInMillis(int timeoutToConnectInMillis)
```
    TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)を設定する(デフォルト:1000ミリ秒)。
    
    パラメータ:
    
    timeoutToConnectInMillis - TCP接続が確立するかどうか確認するときのコネクションタイムアウト時間(ミリ秒)
  - getDelayToMarkOnlineInMillis
```
public int getDelayToMarkOnlineInMillis()
```
    オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)を取得
    
    戻り値:
    
    オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)
  - setDelayToMarkOnlineInMillis
```
public void setDelayToMarkOnlineInMillis(int delayToMarkOnlineInMillis)
```
    オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)を設定する(デフォルト:3000ミリ秒)。 TCPポートが開いてから実際に待ち受け可能になるまで時間がかかるサーバの場合に指定する。不要な場合は0でよい。
    
    パラメータ:
    
    delayToMarkOnlineInMillis - オフライン状態からTCP接続が確立後にオンラインにするまでに待つ時間(ミリ秒)
  - getSocketManager
```
public SocketManager getSocketManager()
```
  - setSocketManager
```
public void setSocketManager(SocketManager socketManager)
```
  - setSocketTimeToLiveInMilli
```
public void setSocketTimeToLiveInMilli(long socketTimeToLiveInMilli)
```
    新規に作成されてから設定値の期間経過したソケットは、そのソケットがプールから選択されるタイミングで削除され、利用されなくなります。
    
    パラメータ:
    
    socketTimeToLiveInMilli - ソケットの生存期間[ミリ秒]（デフォルトは5分）

クラス OkuyamaClientFactoryImpl

コンストラクタのサマリー

メソッドのサマリー

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

コンストラクタの詳細

OkuyamaClientFactoryImpl

OkuyamaClientFactoryImpl

OkuyamaClientFactoryImpl

OkuyamaClientFactoryImpl

メソッドの詳細

createClient

destroy

isCompatibilityMode

setCompatibilityMode

getCompressionStrategy

setCompressionStrategy

isCompressionMode

setCompressionMode

isBase64key

setBase64key

isSerializeString

setSerializeString

getMaxPoolSize

getMaxCoucurrentSockets

getTimeoutToReadInMillis

setTimeoutToReadInMillis

getTimeoutToConnectInMillis

setTimeoutToConnectInMillis

getDelayToMarkOnlineInMillis

setDelayToMarkOnlineInMillis

getSocketManager

setSocketManager

setSocketTimeToLiveInMilli