OkuyamaClientImpl2 (Java client library for Okuyama KVS 1.1.3 API)

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

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

public class OkuyamaClientImpl2
extends Object
implements OkuyamaClient

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

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`OkuyamaClientImpl2(SocketManager socketManager, boolean base64Key, boolean serializeString, CompressionStrategy compressionStrategy)` OkuyamaClient インスタンスを生成する。

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`boolean`	`addObjectValue(String key, Object value, String[] tags, long age)` 新たにOkuyamaに値を保存する。
`protected org.slf4j.Logger`	`getLogger()`
`String`	`getMasterNodeVersion()` MasterNodeのバージョンを返す
`Object[]`	`getMultiObjectValues(String... keys)` キーを指定してOkuyamaから値を取得する。
`Object`	`getObjectValue(String key)` キーを指定してOkuyamaから値を取得する。
`VersionedValue`	`getObjectValueVersionCheck(String key)` キーを指定してOkuyamaから値とバージョン情報を取得する。
`Pair[]`	`getPairsByTag(String tag)` タグを指定してOkuyamaから値を取得する。
`String[]`	`getTagKeys(String tag, boolean withDeletedKeys)` 指定されたタグが含まれるキー群を取得する。
`long`	`initClient()` 保存可能な最大サイズをMasterNodeへ問い合わせる.
`Object`	`removeObjectValue(String key)` キーを指定してOkuyamaから値を削除する。
`void`	`setCompressionStrategy(CompressionStrategy compressionStrategy)`
`protected void`	`setLogger(org.slf4j.Logger logger)`
`boolean`	`setObjectValue(String key, Object value, String[] tags, long age)` Okuyamaに値を保存する。
`boolean`	`setObjectValueVersionCheck(String key, Object value, String version, String[] tags, long age)` Okuyamaに値を保存する。

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

- コンストラクタの詳細
  - OkuyamaClientImpl2
```
protected OkuyamaClientImpl2(SocketManager socketManager,
                             boolean base64Key,
                             boolean serializeString,
                             CompressionStrategy compressionStrategy)
```
    OkuyamaClient インスタンスを生成する。
    
    パラメータ:
    
    socketManager - ソケットマネージャ
    
    base64Key - キーをBase64エンコードする。
    
    serializeString - 値に文字列を保管するときにシリアライズするなら true。 falseなら文字列をUTF-8でBase64エンコードする。
    
    compressionStrategy - 圧縮戦略
- メソッドの詳細
  - getMasterNodeVersion
```
public String getMasterNodeVersion()
                            throws IOException,
                                   OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    MasterNodeのバージョンを返す. "0.9.5"などの形式
    
    定義:
    
    getMasterNodeVersion インタフェース内 OkuyamaClient
    
    戻り値:
    
    バージョン文字列を返す。"0.9.5"などの形式
    
    例外:
    
    IOException - 通信エラーが発生した場合
    
    OperationFailedException - 操作が成功しなかった場合
  - initClient
```
public long initClient()
                throws IOException,
                       OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    保存可能な最大サイズをMasterNodeへ問い合わせる.
    
    定義:
    
    initClient インタフェース内 OkuyamaClient
    
    戻り値:
    
    保存可能な最大サイズ
    
    例外:
    
    IOException - 通信エラーが発生した場合
    
    OperationFailedException - 操作が成功しなかった場合
  - setObjectValue
```
public boolean setObjectValue(String key,
                              Object value,
                              String[] tags,
                              long age)
                       throws IOException,
                              OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    Okuyamaに値を保存する。キー及び値は内部的に Base64エンコードされる。
    
    定義:
    
    setObjectValue インタフェース内 OkuyamaClient
    
    パラメータ:
    
    key - キー文字列。コントロール文字を含む場合は例外
    
    value - 値オブジェクト。nullも指定可。
    
    tags - タグ文字列の配列。未設定の場合はnullを指定。
    
    age - 値の有効時間(秒)。0を指定すると無期限。
    
    戻り値:
    
    登録成功の場合は true
    
    例外:
    
    IOException - 通信エラーの場合
    
    OperationFailedException - 操作が成功しなかった場合
  - getObjectValue
```
public Object getObjectValue(String key)
                      throws IOException,
                             OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    キーを指定してOkuyamaから値を取得する。シリアライズされたオブジェクトがクラスが見つからないなどの原因でデシリアライズできなかった場合は ClassNotFoundException をオブジェクトとして返す。
    
    定義:
    
    getObjectValue インタフェース内 OkuyamaClient
    
    パラメータ:
    
    key - キー文字列。コントロール文字を含む場合は例外
    
    戻り値:
    
    値オブジェクト。存在しない場合は null となる。デシリアライズできなかった場合は ClassNotFoundExceptionオブジェクト。
    
    例外:
    
    IOException - 通信時の例外
    
    OperationFailedException - 操作が成功しなかった場合
  - removeObjectValue
```
public Object removeObjectValue(String key)
                         throws IOException,
                                OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    キーを指定してOkuyamaから値を削除する。キーが存在した場合は削除前の値を返す。シリアライズされたオブジェクトがクラスが見つからないなどの原因でデシリアライズできなかった場合は ClassNotFoundException をオブジェクトとして返す。
    
    定義:
    
    removeObjectValue インタフェース内 OkuyamaClient
    
    パラメータ:
    
    key - キー文字列。コントロール文字を含む場合は例外
    
    戻り値:
    
    削除前の値オブジェクト。存在しない場合は null となる。デシリアライズできなかった場合は ClassNotFoundExceptionオブジェクト。
    
    例外:
    
    IOException - 通信時の例外
    
    OperationFailedException - 操作が成功しなかった場合
  - addObjectValue
```
public boolean addObjectValue(String key,
                              Object value,
                              String[] tags,
                              long age)
                       throws IOException,
                              OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    新たにOkuyamaに値を保存する。既に存在する場合は失敗する。キー及び値は内部的に Base64エンコードされる。
    
    定義:
    
    addObjectValue インタフェース内 OkuyamaClient
    
    パラメータ:
    
    key - キー文字列。コントロール文字を含む場合は例外
    
    value - 値オブジェクト。nullも指定可。
    
    tags - タグ文字列の配列。未設定の場合はnullを指定。
    
    age - 値の有効時間(秒)。0を指定すると無期限。
    
    戻り値:
    
    登録成功の場合は true
    
    例外:
    
    IOException - 通信エラーの場合
    
    OperationFailedException - 操作が成功しなかった場合
  - getMultiObjectValues
```
public Object[] getMultiObjectValues(String... keys)
                              throws IOException,
                                     OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    キーを指定してOkuyamaから値を取得する。シリアライズされたオブジェクトがクラスが見つからないなどの原因でデシリアライズできなかった場合は ClassNotFoundException をオブジェクトとして返す。
    
    定義:
    
    getMultiObjectValues インタフェース内 OkuyamaClient
    
    パラメータ:
    
    keys - キー文字列(可変引数)。コントロール文字を含む場合は例外
    
    戻り値:
    
    値オブジェクトの配列。存在しない場合は null となる。デシリアライズできなかった場合は ClassNotFoundExceptionオブジェクト。
    
    例外:
    
    IOException - 通信時の例外
    
    OperationFailedException - 操作が成功しなかった場合
  - getTagKeys
```
public String[] getTagKeys(String tag,
                           boolean withDeletedKeys)
                    throws IOException,
                           OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    指定されたタグが含まれるキー群を取得する。
    
    定義:
    
    getTagKeys インタフェース内 OkuyamaClient
    
    パラメータ:
    
    tag - タグ
    
    withDeletedKeys - 削除済みキーも返す場合はtrue
    
    戻り値:
    
    キーの配列
    
    例外:
    
    IOException - 通信エラーの場合
    
    OperationFailedException - 操作が成功しなかった場合
  - getObjectValueVersionCheck
```
public VersionedValue getObjectValueVersionCheck(String key)
                                          throws IOException,
                                                 OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    キーを指定してOkuyamaから値とバージョン情報を取得する。シリアライズされたオブジェクトがクラスが見つからないなどの原因でデシリアライズできなかった場合は ClassNotFoundException をオブジェクトとして返す。
    
    定義:
    
    getObjectValueVersionCheck インタフェース内 OkuyamaClient
    
    パラメータ:
    
    key - キー文字列。コントロール文字を含む場合は例外
    
    戻り値:
    
    バージョン情報と値オブジェクトのペア。キーが存在しない場合は null となる。デシリアライズできなかった場合は値として ClassNotFoundExceptionオブジェクトを設定。
    
    例外:
    
    IOException - 通信時の例外
    
    OperationFailedException - 操作が成功しなかった場合
  - setObjectValueVersionCheck
```
public boolean setObjectValueVersionCheck(String key,
                                          Object value,
                                          String version,
                                          String[] tags,
                                          long age)
                                   throws IOException,
                                          OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    Okuyamaに値を保存する。キー及び値は内部的に Base64エンコードされる。
    
    定義:
    
    setObjectValueVersionCheck インタフェース内 OkuyamaClient
    
    パラメータ:
    
    key - キー文字列。コントロール文字を含む場合は例外
    
    value - 値オブジェクト。nullも指定可。
    
    version - バージョン文字列。getObjectValueVersionCheck で取得したものを指定する。
    
    tags - タグ文字列の配列。未設定の場合はnullを指定。
    
    age - 値の有効時間(秒)。0を指定すると無期限。
    
    戻り値:
    
    登録成功の場合は true
    
    例外:
    
    IOException - 通信時の例外
    
    OperationFailedException - 操作が成功しなかった場合
    
    KeyValueConsistencyException - 既に更新されていて指定したバージョンと一致しない
  - getPairsByTag
```
public Pair[] getPairsByTag(String tag)
                     throws IOException,
                            OperationFailedException
```
    インタフェースからコピーされた説明: OkuyamaClient
    
    タグを指定してOkuyamaから値を取得する。シリアライズされたオブジェクトがクラスが見つからないなどの原因でデシリアライズできなかった場合は ClassNotFoundException を値として返す。
    
    定義:
    
    getPairsByTag インタフェース内 OkuyamaClient
    
    パラメータ:
    
    tag - タグ文字列の配列。未設定の場合はnullを指定。
    
    戻り値:
    
    値オブジェクト。nullも指定可。
    
    例外:
    
    IOException - 通信エラーが発生した場合
    
    OperationFailedException - 操作が成功しなかった場合
  - setCompressionStrategy
```
public void setCompressionStrategy(CompressionStrategy compressionStrategy)
```
  - getLogger
```
protected org.slf4j.Logger getLogger()
```
  - setLogger
```
protected void setLogger(org.slf4j.Logger logger)
```

クラス OkuyamaClientImpl2

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

メソッドのサマリー

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

コンストラクタの詳細

OkuyamaClientImpl2

メソッドの詳細

getMasterNodeVersion

initClient

setObjectValue

getObjectValue

removeObjectValue

addObjectValue

getMultiObjectValues

getTagKeys

getObjectValueVersionCheck

setObjectValueVersionCheck

getPairsByTag

setCompressionStrategy

getLogger

setLogger