Hitachi

JP1 Version 10 JP1/Automatic Job Management System 3 - Software Development Kit APIリファレンス


2.1.4 destroyAjsCdメソッド

〈この項の構成〉

(1) 説明

アプリケーションごとにJP1/AJS3 - SDKの破棄を行います。AjsCdインターフェースを実装したクラスインスタンスを破棄します。

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

なお,本メソッドは,destroyAjsCdApiメソッドですべてのAjsCdApiインスタンスを破棄したあとに呼び出してください。

(2) 形式

public void destroyAjsCd(
  java.lang.String appName) throws AjsCdException
強制破棄する場合
public void destroyAjsCd(
  java.lang.String appName,
  DestroyOption option) throws AjsCdException

(3) 実行権限

なし。

(4) 引数

引数名

省略

説明

appName

不可

アプリケーション名を1〜32バイトの文字列で指定してください。なお,バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。

指定できる文字は半角英数字,および次の記号です。

! # $ % + −(ハイフン) _(アンダーバー)

大文字・小文字の区別はしません。

本引数で指定するアプリケーション名は,環境設定ファイルのアプリケーション名と一致させておく必要があります。

option

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

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

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

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

(5) 戻り値

なし。

(6) 例外

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