18.2.5 ServerInfoインタフェース
- 〈この項の構成〉
-
(1) 説明
EADSサーバの情報を取得するためのインタフェースです。
(2) インタフェース名
com.hitachi.software.xeads.common.ServerInfo
(3) メソッド一覧
ServerInfoインタフェースが提供するメソッド一覧を次の表に示します。
|
メソッド名 |
説明 |
|---|---|
|
ユーザファンクションを実行しているEADSサーバ名（運用ディレクトリ名）を取得します。 |
|
|
ユーザファンクションを実行しているEADSサーバのIPアドレスおよびポート番号を取得します。 |
|
|
ユーザファンクションを実行しているEADSサーバの，EADSサーバIDを取得します。 |
|
|
【非推奨】ユーザファンクションを実行しているEADSサーバで作成済みのキャッシュの，キャッシュ名の一覧を取得します。 キャッシュ名の一覧は，ASCIIコードの昇順となります。 |
|
|
【非推奨】指定したキャッシュ名のキャッシュから，キャッシュタイプの情報を取得します。 |
|
|
ユーザファンクションを実行しているEADSサーバが，キャッシュ用に確保しているExplicitヒープサイズを取得します。 |
|
|
ユーザファンクションを実行しているEADSサーバが，キャッシュ用に確保しているExplicitヒープの使用量を取得します。 |
|
|
【非推奨】キャッシュデータファイルの1ファイル当たりのファイルサイズ（キャッシュ定義ファイルに定義した値）を取得します。 |
|
|
【非推奨】現在書き込み中のキャッシュデータファイルについて，永続データを格納できる残りのファイルサイズを取得します。 |
|
|
【非推奨】キャッシュデータファイルのファイル数（キャッシュ定義ファイルに定義した値）を取得します。 |
|
|
【非推奨】現在使用できる，未使用のキャッシュデータファイルの数を取得します。 |
(4) getName()
(a) 機能
ユーザファンクションを実行しているEADSサーバ名（運用ディレクトリ名）を取得します。
(b) 形式
public String getName()
(c) 戻り値
ユーザファンクションを実行しているEADSサーバ名（運用ディレクトリ名）が返却されます。
(5) getAddress()
(a) 機能
ユーザファンクションを実行しているEADSサーバのIPアドレスおよびポート番号を取得します。
(b) 形式
public InetSocketAddress getAddress()
(c) 戻り値
サーバのIPアドレスとポート番号を示すjava.net.InetSocketAddressインスタンスが返却されます。
(6) getId()
(a) 機能
ユーザファンクションを実行しているEADSサーバの，EADSサーバIDを取得します。
(b) 形式
public int getId()
(c) 戻り値
ユーザファンクションを実行しているEADSサーバの，EADSサーバIDが返却されます。
(7) 【非推奨】getCacheNames()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，ClusterInfoインタフェースのgetCacheNames()を使用してください。
(a) 機能
ユーザファンクションを実行しているEADSサーバで作成済みのキャッシュの，キャッシュ名の一覧を取得します。
キャッシュ名の一覧は昇順となります。
(b) 形式
public java.util.Set<String> getCacheNames()
(c) 戻り値
ユーザファンクションを実行しているEADSサーバで作成済みのキャッシュ名の一覧が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，nullが返却されます。
(8) 【非推奨】getCacheType()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，ClusterInfoインタフェースのgetType()を使用してください。
(a) 機能
指定したキャッシュ名のキャッシュから，キャッシュタイプの情報を取得します。
(b) 形式
public CacheType getCacheType(String cacheName)
throws EADsStoreException(c) パラメータ
- cacheName
-
キャッシュ名を指定します。
指定できるデータについては，「15.2.2(4) キャッシュ名として指定できるデータ」を参照してください。
なお，作成していないキャッシュのキャッシュ名を指定した場合は不正となります。
(d) 戻り値
キャッシュタイプの情報が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，nullが返却されます。
(e) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
EADsStoreException（予期しないエラー）
(9) getEHeapSize()
(a) 機能
ユーザファンクションを実行しているEADSサーバが，キャッシュ用に確保しているExplicitヒープサイズを取得します。
(b) 形式
public long getEHeapSize()
throws EADsStoreException(c) 戻り値
EADSサーバがキャッシュ用に確保しているExplicitヒープサイズ（単位：バイト）が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は0が返却されます。
(d) 発生する例外
-
InternalServerException（EADSサーバの内部エラー）
-
EADsStoreException（予期しないエラー）
(10) getEHeapUsageSize()
(a) 機能
ユーザファンクションを実行しているEADSサーバが，キャッシュ用に確保しているExplicitヒープの使用量を取得します。
(b) 形式
public long getEHeapUsageSize()
throws EADsStoreException(c) 戻り値
EADSサーバがキャッシュ用に確保しているExplicitヒープの使用量（単位：バイト）が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は0が返却されます。
(d) 発生する例外
-
InternalServerException（EADSサーバの内部エラー）
-
EADsStoreException（予期しないエラー）
(11) 【非推奨】getCacheDataFileSpecifiedSize()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりにCacheInfoインタフェースのgetCacheDataFileSize()を使用してください。
(a) 機能
キャッシュデータファイルの1ファイル当たりのファイルサイズ（キャッシュ定義ファイルに定義した値）（単位：バイト）を取得します。
(b) 形式
public long getCacheDataFileSpecifiedSize(String cacheName)
throws EADsStoreException(c) パラメータ
- cacheName
-
キャッシュ名を指定します。
指定できるデータについては，「15.2.2(4) キャッシュ名として指定できるデータ」を参照してください。
なお，作成していないキャッシュのキャッシュ名を指定した場合は不正となります。
(d) 戻り値
キャッシュデータファイルの1ファイル当たりのファイルサイズ（キャッシュ定義ファイルに定義した値）（単位：バイト）が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，nullが返却されます。
(e) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
EADsStoreException（予期しないエラー）
(12) 【非推奨】getCacheDataFileRemainingSize()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，CacheInfoインタフェースのgetRemainingAreaSizeOfWritingCacheDataFile()を使用してください。
(a) 機能
現在書き込み中のキャッシュデータファイルについて，永続データを格納できる残りのファイルサイズ（単位：バイト）を取得します。
(b) 形式
public long getCacheDataFileRemainingSize(String cacheName, String key)
throws EADsStoreException(c) パラメータ
- cacheName
-
キャッシュ名を指定します。
指定できるデータについては，「15.2.2(4) キャッシュ名として指定できるデータ」を参照してください。
なお，作成していないキャッシュのキャッシュ名を指定した場合は不正となります。
- key
-
valueに関連づけるkeyを指定します。グループ名だけの指定もできます。
指定できるデータについては，「15.2.2(1) keyとして指定できるデータ」を参照してください。
なお，ユーザファンクションを実行中のEADSサーバに属していないkeyを指定した場合は不正となります。
(d) 戻り値
現在書き込み中のキャッシュデータファイルについて，永続データを格納できる残りのファイルサイズ（単位：バイト）が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，0が返却されます。
(e) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
InternalServerException（EADSサーバの内部エラー）
-
EADsStoreException（予期しないエラー）
(f) 注意事項
-
返却される残りのファイルサイズは，メソッド実行時点の情報です。そのため，残りのファイルサイズは，キャッシュ操作やコンパクションによって変動することがあります。
-
このメソッドを実行しているEADSサーバの情報を取得します。ほかのEADSサーバの情報は取得できません。
-
このメソッドの戻り値で，キャッシュデータファイルに十分な空き領域を確認できた場合でも，データのコピー先のEADSサーバが容量不足となっていると，データの格納時にデータのコピー先のEADSサーバが縮退してしまいます。このメソッドの戻り値に加えて，データのコピー先のEADSサーバで使用できる容量も考慮して，データを格納できるか判断してください。
(13) 【非推奨】getCacheDataFileSpecifiedNumber()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，CacheInfoインタフェースのgetCacheDataFilesNumber()を使用してください。
(a) 機能
キャッシュデータファイルのファイル数（キャッシュ定義ファイルに定義した値）を取得します。
(b) 形式
public int getCacheDataFileSpecifiedNumber(String cacheName)
throws EADsStoreException(c) パラメータ
- cacheName
-
キャッシュ名を指定します。
指定できるデータについては，「15.2.2(4) キャッシュ名として指定できるデータ」を参照してください。
なお，作成していないキャッシュのキャッシュ名を指定した場合は不正となります。
(d) 戻り値
キャッシュデータファイルのファイル数（キャッシュ定義ファイルに定義した値）が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，0が返却されます。
(e) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
EADsStoreException（予期しないエラー）
(14) 【非推奨】getCacheDataFileUnusedNumber()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，CacheInfoインタフェースのgetRemainingCacheDataFilesNumber()を使用してください。
(a) 機能
現在使用できる，未使用のキャッシュデータファイルの数を取得します。
(b) 形式
public int getCacheDataFileUnusedNumber(String cacheName, String key)
throws EADsStoreException(c) パラメータ
- cacheName
-
キャッシュ名を指定します。
指定できるデータについては，「15.2.2(4) キャッシュ名として指定できるデータ」を参照してください。
なお，作成していないキャッシュのキャッシュ名を指定した場合は不正となります。
- key
-
valueに関連づけるkeyを指定します。グループ名だけの指定もできます。
指定できるデータについては，「15.2.2(1) keyとして指定できるデータ」を参照してください。
なお，ユーザファンクションを実行中のEADSサーバに属していないkeyを指定した場合は不正となります。
(d) 戻り値
現在使用できる，未使用のキャッシュデータファイルの数が返却されます。ただし，EADSサーバによって使用予約済みのファイル数は含まれません。
現在書き込み中のキャッシュデータファイルが，書き込みできる最後のキャッシュデータファイルの場合は，0が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，0が返却されます。
(e) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
InternalServerException（EADSサーバの内部エラー）
-
EADsStoreException（予期しないエラー）
(f) 注意事項
-
返却される残りのファイル数は，メソッド実行時点の情報です。そのため，残りのファイル数は，キャッシュ操作やコンパクションによって変動することがあります。
-
このメソッドを実行しているEADSサーバの情報を取得します。ほかのEADSサーバの情報は取得できません。
-
このメソッドの戻り値で，キャッシュデータファイルに十分な空き領域を確認できた場合でも，データのコピー先のEADSサーバが容量不足となっていると，データの格納時にデータのコピー先のEADSサーバが縮退してしまいます。このメソッドの戻り値に加えて，データのコピー先のEADSサーバで使用できる容量も考慮して，データを格納できるか判断してください。