Hitachi

インメモリデータグリッド Hitachi Elastic Application Data Store ユーザーズガイド


18.2.6 ClusterInfoインタフェース

〈この項の構成〉

(1) 説明

クラスタの情報を取得するインタフェースです。

(2) インタフェース名

com.hitachi.software.xeads.common.ClusterInfo

(3) メソッド一覧

ClusterInfoインタフェースが提供するメソッド一覧を次の表に示します。

メソッド名

説明

getReplicationFactor()

データの多重度を取得します。

getCacheNames()

ユーザファンクションを実行しているEADSサーバで,作成済みのキャッシュのキャッシュ名の一覧を取得します。

キャッシュ名の一覧は,ASCIIコードの昇順となります。

getCacheInfo()

指定したキャッシュの情報を取得します。

getPosition()

指定したkeyまたはグループ名に対応するポジション(ハッシュ値)を取得します。

getRangeId()(ポジション指定)

指定したポジションに対応するレンジのレンジIDを取得します。

getRangeId()(keyまたはグループ名指定)

指定したkeyまたはグループ名に対応するレンジのレンジIDを取得します。

getLocalRangeId()

ユーザファンクションを実行しているEADSサーバが,コピー元,またはコピー先として処理するすべてのレンジのレンジIDの一覧を取得します。

isLocalRange()

指定したレンジが,ユーザファンクションを実行しているEADSサーバで,コピー元,またはコピー先としての役割を持つかどうかを取得します。

isLocalMasterRange()

指定したレンジが,ユーザファンクションを実行しているEADSサーバで,コピー元としての役割を持つかどうかを取得します。

(4) getReplicationFactor()

(a) 機能

データの多重度を取得します。

(b) 形式

public int getReplicationFactor()

(c) 戻り値

データの多重度が返却されます。

(5) getCacheNames()

(a) 機能

ユーザファンクションを実行しているEADSサーバで,作成済みのキャッシュのキャッシュ名の一覧を取得します。

キャッシュ名の一覧は,ASCIIコードの昇順となります。

(b) 形式

public String[] getCacheNames()

(c) 戻り値

ユーザファンクションを実行しているEADSサーバで,作成済みのキャッシュのキャッシュ名の一覧が返却されます。

(6) getCacheInfo()

(a) 機能

指定したキャッシュの情報を取得します。

(b) 形式

public CacheInfo getCacheInfo(String cacheName)
                       throws EADsStoreException

(c) パラメータ

cacheName

キャッシュ名を指定します。

指定できるデータについては,「15.2.2(4) キャッシュ名として指定できるデータ」を参照してください。

(d) 戻り値

指定したキャッシュ名のキャッシュに対応する情報を持つインスタンスが返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

(7) getPosition()

(a) 機能

指定したkeyまたはグループ名に対応するポジション(ハッシュ値)を取得します。

(b) 形式

public int getPosition(String keyOrGroupName)
               throws EADsStoreException

(c) パラメータ

keyOrGroupName

keyまたはグループ名を指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」,または「15.2.2(2) グループ名として指定できるデータ」を参照してください。

(d) 戻り値

指定したkeyまたはグループ名に対応するポジション(ハッシュ値)が返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADSサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(8) getRangeId()(ポジション指定)

(a) 機能

指定したポジションに対応するレンジのレンジIDを取得します。

(b) 形式

public int getRangeId(int position)
               throws EADsStoreException

(c) パラメータ

position

ポジションを指定します。

(d) 戻り値

指定したポジションに対応するレンジのレンジIDが返却されます。

(e) 発生する例外

  • EADsStoreException(予期しないエラー)

(9) getRangeId()(keyまたはグループ名指定)

(a) 機能

指定したkeyまたはグループ名に対応するレンジのレンジIDを取得します。

(b) 形式

public int getRangeId(String keyOrGroupName)
               throws EADsStoreException

(c) パラメータ

keyOrGroupName

keyまたはグループ名を指定します。

指定できるデータについては,「15.2.2(1) keyとして指定できるデータ」,または「15.2.2(2) グループ名として指定できるデータ」を参照してください。

(d) 戻り値

指定したkeyまたはグループ名に対応するレンジのレンジIDが返却されます。

(e) 発生する例外

  • UserOperationException(ユーザの操作不正)

  • InternalServerException(EADSサーバの内部エラー)

  • EADsStoreException(予期しないエラー)

(10) getLocalRangeId()

(a) 機能

ユーザファンクションを実行しているEADSサーバが,コピー元,またはコピー先として処理するすべてのレンジのレンジIDの一覧を取得します。

(b) 形式

public int[] getLocalRangeId()
                      throws EADsStoreException

(c) 戻り値

ユーザファンクションを実行しているEADSサーバが,コピー元,またはコピー先として処理するすべてのレンジのレンジIDの一覧が返却されます。

(d) 発生する例外

  • EADsStoreException(予期しないエラー)

(11) isLocalRange()

(a) 機能

指定したレンジが,ユーザファンクションを実行しているEADSサーバで,コピー元,またはコピー先としての役割を持つかどうかを取得します。

(b) 形式

public boolean isLocalRange(int rangeId)
                     throws EADsStoreException

(c) パラメータ

rangeId

レンジのレンジIDを指定します。

(d) 戻り値

true

指定したレンジは,ユーザファンクションを実行しているEADSサーバで,コピー元,またはコピー先としての役割を持ちます。

false

指定したレンジは,ユーザファンクションを実行しているEADSサーバで,コピー元,またはコピー先としての役割を持ちません。

(e) 発生する例外

  • EADsStoreException(予期しないエラー)

(12) isLocalMasterRange()

(a) 機能

指定したレンジが,ユーザファンクションを実行しているEADSサーバで,コピー元としての役割を持つかどうかを取得します。

(b) 形式

public boolean isLocalMasterRange(int rangeId)
                           throws EADsStoreException

(c) パラメータ

rangeId

レンジのレンジIDを指定します。

(d) 戻り値

true

指定したレンジは,ユーザファンクションを実行しているEADSサーバで,コピー元としての役割を持ちます。

false

指定したレンジは,ユーザファンクションを実行しているEADSサーバで,コピー元としての役割を持ちません。

(e) 発生する例外

  • InternalServerException(EADSサーバの内部エラー)

  • EADsStoreException(予期しないエラー)