23.3.1 Java言語のライブラリが提供するAPI
(1) Java言語のクライアントライブラリが提供するクラス
Java言語のクライアントライブラリでは,EADsのAPIとして次の表に示すクラスを提供します。
項番 |
クラス名 |
機能 |
パッケージ名 |
---|---|---|---|
1 |
データを操作するためのクラスです。 |
com.hitachi.software.xeads.client.api |
|
2 |
キャッシュを管理するためのクラスです。 |
||
3 |
EADsサーバの情報を取得するためのクラスです。 |
||
4 |
Cacheクラス,およびCacheManagerクラスに対する操作が失敗した場合に返却する例外クラスです。 |
||
5 |
CacheManagerクラスの初期化でエラーが発生した場合に返却されるCacheExceptionのサブクラスです。 |
||
6 |
EADsクライアントで内部エラーが発生した場合に返却されるCacheExceptionのサブクラスです。 |
||
7 |
EADsサーバで内部エラーが発生した場合に返却されるCacheExceptionのサブクラスです。 |
||
8 |
通信障害が発生した場合に返却されるCacheExceptionのサブクラスです。 |
||
9 |
不正なユーザ操作によってエラーが発生した場合に返却されるCacheExceptionのサブクラスです。 |
(2) ユーザファンクションで使用できるAPI
ユーザファンクションで使用できるAPIを次の表に示します。
項番 |
インタフェース名,クラス名,または列挙型 |
機能 |
パッケージ名 |
---|---|---|---|
1 |
EADsサーバで使用するユーザファンクションが実装する必要のあるインタフェースです。 |
com.hitachi.software.xeads.func.Function |
|
2 |
ユーザファンクションの実行に必要な情報をFunctionインタフェースに渡すインタフェースです。 |
com.hitachi.software.xeads.func.FunctionContext |
|
3 |
ユーザファンクションの初期化に使用したファンクション定義の情報を取得するインタフェースです。 |
com.hitachi.software.xeads.func.InitConfig |
|
4 |
実行したEADsクライアントの情報(PRFトレースに出力されるRootAP情報に相当する情報)を取得するインタフェースです。 |
com.hitachi.software.xeads.common.ClientInfo |
|
5 |
EADsサーバの情報を取得するためのインタフェースです。 |
com.hitachi.software.xeads.common.ServerInfo |
|
6 |
ユーザファンクションの実行時にデータを操作するインタフェースです。 |
com.hitachi.software.xeads.func.store.Store |
|
7 |
ユーザファンクションを実行中のEADsサーバに属するグループを操作するためのインタフェースです。 |
com.hitachi.software.xeads.func.store.Group |
|
8 |
ユーザファンクションで使用できるAPI内で,keyを表現するインタフェースです。 |
com.hitachi.software.xeads.func.store.Key |
|
9 |
ユーザログのインタフェースです。 |
com.hitachi.software.xeads.common.UserLogger |
|
10 |
Groupインタフェースに対する操作が失敗した場合に返却される例外クラスです。 |
com.hitachi.software.xeads.func.store.EADsStoreException |
|
11 |
EADsサーバで内部エラーが発生した場合に返却されるEADsStoreExceptionのサブクラスです。 |
com.hitachi.software.xeads.func.store.InternalServerException |
|
12 |
不正なユーザ操作によってエラーが発生した場合に返却されるEADsStoreExceptionのサブクラスです。 |
com.hitachi.software.xeads.func.store.UserOperationException |
|
13 |
キャッシュタイプを表す列挙型です。 |
com.hitachi.software.xeads.common.CacheType |
(3) ユーザイベントハンドラで使用できるAPI
ユーザイベントハンドラで使用できるAPIを次の表に示します。
項番 |
インタフェース名, アノテーション名, または列挙型名 |
機能 |
パッケージ名 |
---|---|---|---|
1 |
EADsサーバで使用するユーザイベントハンドラが実装する必要のあるインタフェースです。 |
com.hitachi.software.xeads.event.EventHandler |
|
2 |
EADsサーバ,EADsクライアント,および発生したイベントに関する情報を,ユーザイベントハンドラに渡すインタフェースです。 |
com.hitachi.software.xeads.event.EventContext |
|
3 |
実行したEADsクライアントの情報(PRFトレースに出力されるRootAP情報に相当する情報)を取得するインタフェースです。 |
com.hitachi.software.xeads.common.ClientInfo |
|
4 |
ユーザログのインタフェースです。 |
com.hitachi.software.xeads.common.UserLogger |
|
5 |
イベントが発生したデータ操作の種類に関して,ユーザイベントハンドラが動作する条件を指定するアノテーションです。 |
com.hitachi.software.xeads.event.annotation.OperationFilter |
|
6 |
イベントが発生したデータのキャッシュ名,グループ名,または要素名に関して,ユーザイベントハンドラが動作する条件を指定するアノテーションです。 |
com.hitachi.software.xeads.event.annotation.DataFilter |
|
7 |
ユーザイベントハンドラを実行する優先度を指定するアノテーションです。 |
com.hitachi.software.xeads.event.annotation.Priority |
|
8 |
イベントが発生したデータ操作の種類を表す列挙型です。 |
com.hitachi.software.xeads.event.OperationType |
|
9 |
実行したAPIの種類を表す列挙型です。 |
com.hitachi.software.xeads.event.MethodType |
|
10 |
ユーザイベントハンドラを実行する優先度を表す列挙型です。 |
com.hitachi.software.xeads.event.PriorityLevel |
- 注※
-
ClientInfoインタフェースについては,「20.2.4 ClientInfoインタフェース」を参照してください。
UserLoggerインタフェースについては,「20.2.9 UserLoggerインタフェース」を参照してください。