OkuyamaClient (Java client library for Okuyama KVS 1.1.3 API)

既知の実装クラスのリスト:

OkuyamaClientImpl2
```
public interface OkuyamaClient
```
Okuyamaにアクセスするクライアントライブラリである。接続先管理やTCPコネクションプールも行う。

メソッドのサマリー

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`boolean`	`addObjectValue(String key, Object value, String[] tags, long age)` 新たにOkuyamaに値を保存する。
`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から値を削除する。
`boolean`	`setObjectValue(String key, Object value, String[] tags, long age)` Okuyamaに値を保存する。
`boolean`	`setObjectValueVersionCheck(String key, Object value, String version, String[] tags, long age)` Okuyamaに値を保存する。

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

インタフェース OkuyamaClient

メソッドのサマリー

メソッドの詳細

getMasterNodeVersion

initClient

setObjectValue

getObjectValue

removeObjectValue

addObjectValue

getTagKeys

getMultiObjectValues

getPairsByTag

getObjectValueVersionCheck

setObjectValueVersionCheck