2.2.3　destroyAjsCdApiメソッド

〈この項の構成〉

(1)　説明

AjsCdApiインターフェースを実装したクラスインスタンスを破棄します。

このインスタンスがすでに破棄されている場合は，ログにメッセージを出力して処理を中断します。この場合，例外は発生しません。

なお，本メソッドは，logoutメソッドまたはlogoutAllメソッドで，ログインしているすべてのJP1/AJS3 - Managerからログアウトしたあとに呼び出してください。

public void destroyAjsCdApi(
　　java.lang.String id) throws AjsCdException

強制破棄する場合

public void destroyAjsCdApi(
　　java.lang.String id,
　　DestroyOption option) throws AjsCdException

なし。

引数名	省略	説明
id	不可	AjsCdApiインターフェースを実装したクラスインスタンスを識別するための文字列（識別子）を1〜2048バイトで指定します。なお，バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。 AjsCdインターフェースを実装したインスタンス内でユニークな値を指定してください。なお，ここで指定した識別子は公開トレースログや内部ログに出力されます。
option	可	通常は本オプションは省略します。本オプションを省略した場合，実行中のAPIが終了したあと，AjsCdApiインターフェースを実装したクラスインスタンスを破棄します。緊急時にAPI処理中にかかわらず強制的にAjsCdApiインターフェースを終了したい場合にだけ，「強制破棄」を指定してください。「強制破棄」を指定した場合，処理中のAPIはすべて強制的に破棄されます。このため，APIの戻り値は保証されません。また，処理中のAPIでKNAK1501-Eのメッセージを出力するエラーが発生するおそれがあります。APIの処理がどこまで反映されているかを確認してください。指定できる値と内容については，「付録A.1 (11)DestroyOption」を参照してください。

引数名

省略

説明

不可

AjsCdApiインターフェースを実装したクラスインスタンスを識別するための文字列（識別子）を1〜2048バイトで指定します。なお，バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

AjsCdインターフェースを実装したインスタンス内でユニークな値を指定してください。

なお，ここで指定した識別子は公開トレースログや内部ログに出力されます。

option

可

通常は本オプションは省略します。本オプションを省略した場合，実行中のAPIが終了したあと，AjsCdApiインターフェースを実装したクラスインスタンスを破棄します。

緊急時にAPI処理中にかかわらず強制的にAjsCdApiインターフェースを終了したい場合にだけ，「強制破棄」を指定してください。

「強制破棄」を指定した場合，処理中のAPIはすべて強制的に破棄されます。このため，APIの戻り値は保証されません。また，処理中のAPIでKNAK1501-Eのメッセージを出力するエラーが発生するおそれがあります。APIの処理がどこまで反映されているかを確認してください。

指定できる値と内容については，「付録A.1 (11)DestroyOption」を参照してください。

なし。

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。