18.2.2 FunctionContextインタフェース
- 〈この項の構成〉
(1) 説明
ユーザファンクションの実行に必要な情報をFunctionインタフェースに渡すインタフェースです。
FunctionContextインタフェースのインスタンスは，1リクエストにつき1つ生成されます。
(2) インタフェース名
com.hitachi.software.xeads.func.FunctionContext
(3) メソッド一覧
FunctionContextインタフェースが提供するメソッド一覧を次の表に示します。
|
メソッド名 |
説明 |
|---|---|
|
【非推奨】ユーザファンクションを実行するEADSサーバ名（運用ディレクトリ名）を取得します。 |
|
|
【非推奨】ユーザファンクションが実行されたキャッシュ名を取得します。 |
|
|
【非推奨】ユーザファンクションの実行時に，EADSクライアントで指定したグループ名を取得します。 |
|
|
【非推奨】ユーザファンクションの実行時に，EADSクライアントで指定した引数を取得します。 |
|
|
ユーザファンクションの呼び出しに使用したキャッシュの，データを操作するためのインスタンスを取得します。 |
|
|
指定したキャッシュ名のキャッシュの，データを操作するためのインスタンスを取得します。 |
|
|
ユーザログを出力するロガーを取得します。 |
|
|
ユーザファンクションを実行したEADSクライアントの情報を取得します。 |
|
|
ユーザファンクションの初期化に使用したファンクション定義の情報を取得します。 |
|
|
ユーザファンクションを実行したEADSサーバの情報を取得します。 |
|
|
クラスタに関する情報を取得します。 |
(4) 【非推奨】getServerName()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，ServerInfoインタフェースのgetName()を使用してください。
(a) 機能
ユーザファンクションを実行するEADSサーバ名（運用ディレクトリ名）を取得します。
(b) 形式
public String getServerName()
(c) 戻り値
ユーザファンクションを実行するEADSサーバ名（運用ディレクトリ名）が返却されます。
(5) 【非推奨】getCacheName()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，ClientInfoインタフェースのgetCacheName()を使用してください。
(a) 機能
ユーザファンクションが実行されたキャッシュ名を取得します。
(b) 形式
public String getCacheName()
(c) 戻り値
ユーザファンクションが実行されたキャッシュ名が返却されます。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，nullが返却されます。
(6) 【非推奨】getGroupName()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，ClientInfoインタフェースのgetKeyOrGroupName()を使用してください。
(a) 機能
ユーザファンクションの実行時に，EADSクライアントで指定したグループ名を取得します。
(b) 形式
public String getGroupName()
(c) 戻り値
ユーザファンクションの実行時に，EADSクライアントで指定したグループ名が返却されます。
次の場合はnullが返却されます。
-
EADSクライアントでグループを指定しなかった場合
-
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合
(7) 【非推奨】getArgument()
- 参考
-
このメソッドは非推奨です。このメソッドの代わりに，ClientInfoインタフェースのgetFunctionArgument()を使用してください。
(a) 機能
ユーザファンクションの実行時に，EADSクライアントで指定した引数を取得します。
(b) 形式
public Object getArgument()
(c) 戻り値
ユーザファンクションの実行時に，EADSクライアントで指定した引数が返却されます。
次の場合はnullが返却されます。
-
EADSクライアントで引数にnullを指定した場合
-
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合
(8) getStore()
(a) 機能
ユーザファンクションの呼び出しに使用したキャッシュの，データを操作するためのインスタンスを取得します。
(b) 形式
public Store getStore()
(c) 戻り値
ユーザファンクションの呼び出しに使用したキャッシュの，データを操作するためのインスタンスが返却されます。
データを操作するためのインスタンスについては，「18.2.8 Storeインタフェース」を参照してください。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，nullが返却されます。
(9) getStore()（キャッシュ名指定）
(a) 機能
指定したキャッシュ名のキャッシュの，データを操作するためのインスタンスを取得します。
(b) 形式
public Store getStore(String cacheName)
throws EADsStoreException(c) パラメータ
- cacheName
-
操作対象となるキャッシュのキャッシュ名を指定します。
指定できるデータについては，「15.2.2(4) キャッシュ名として指定できるデータ」を参照してください。
なお，作成していないキャッシュのキャッシュ名を指定した場合は不正となります。
(d) 戻り値
指定したキャッシュ名のキャッシュの，データを操作するためのインスタンスが返却されます。
データを操作するためのインスタンスについては，「18.2.8 Storeインタフェース」を参照してください。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，nullが返却されます。
(e) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
EADsStoreException（予期しないエラー）
(11) getClientInfo()
(a) 機能
ユーザファンクションを実行したEADSクライアントの情報を取得します。
(b) 形式
public ClientInfo getClientInfo()
(c) 戻り値
ユーザファンクションを実行したEADSクライアントの情報が返却されます。EADSクライアントの情報については，「18.2.4 ClientInfoインタフェース」を参照してください。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，nullが返却されます。
(12) getInitConfig()
(a) 機能
ユーザファンクションの初期化に使用したファンクション定義の情報を取得します。
(b) 形式
public InitConfig getInitConfig()
(c) 戻り値
ユーザファンクションの初期化に使用したファンクション定義の情報が返却されます。
ユーザファンクションの初期化に使用したファンクション定義の情報については，「18.2.3 InitConfigインタフェース」を参照してください。
(13) getServerInfo()
(a) 機能
ユーザファンクションを実行したEADSサーバの情報を取得します。
(b) 形式
public ServerInfo getServerInfo()
(14) getClusterInfo()
(a) 機能
クラスタに関する情報を取得します。
(b) 形式
public ClusterInfo getClusterInfo()
(c) 戻り値
クラスタに関する情報が返却されます。
クラスタに関する情報については，「18.2.6 ClusterInfoインタフェース」を参照してください。
Functionインタフェースのinit()，またはdestroy()内でこのメソッドを呼び出した場合は，nullが返却されます。