Cosminexus V9 BPM/ESB基盤 サービスプラットフォーム 開発ガイド 基本開発編
付録G.3 UOCクラス用API
インターフェースは,UOCクラスを呼び出すタイミングごとに存在し,インターフェースが追加されるタイミングでUOCクラスを実行します。複数のインターフェースを追加することで,複数の呼び出しタイミングに対応できます。
UOCクラスに実行するインターフェースを次に示します。
- <この項の構成>
- (1) インターフェース
- (2) 例外クラス
- (3) クラス構成例
(1) インターフェース
UOCクラス内で例外が発生した場合は,CSCUocSystemExceptionにラップしてthrowします。
(a) UOCクラス共通インターフェース
- パッケージ
- jp.co.Hitachi.soft.csc.msg.uoc
- インターフェース名
- ComponentCommonUoc
- 説明
- コンポーネント共通UOCで使用する定数を定義する共通インターフェースです。
- 定数
- 定数を次に示します。
定数 |
説明 |
COMPO_TYPE |
サービスアダプタか受付を判別するコードを取得するkey |
COMPO_KIND |
コンポーネント種別を取得するkey |
COMPO_ID |
コンポーネントIDを取得するkey |
TELEGRAM_DATA |
電文取得用APIを取得するkey |
MONITOR_SEND_DATA |
パラメタからモニタリングに送信するデータをセットするMapを取得するkey |
DESTINATION_DATA |
呼び出すサービスの宛先情報※を取得するkey |
- 注※
- ユーザ定義受付(SOAP受付を除く)の場合だけ取得できます。
定数の使用方法については,マニュアル「サービスプラットフォーム 解説」の「4.9.1 コンポーネント共通UOCの概要」を参照してください。
(b) リクエスト処理時用インターフェース
- パッケージ
- jp.co.Hitachi.soft.csc.msg.uoc
- インターフェース名
- ComponentRequestUoc
- 説明
- リクエスト処理時に呼び出されるUOCクラスのインターフェースです。
- #request
- #requestの操作に関する説明を次に示します。
- 引数
- Map<String,Object>
- (UOCクラスに渡すデータをまとめたオブジェクト)
- 戻り値
- なし
- 例外
- CSCUocSystemException
(c) 応答処理時用インターフェース
- パッケージ
- jp.co.Hitachi.soft.csc.msg.uoc
- インターフェース名
- ComponentResponseUoc
- 説明
- 応答処理時に呼び出されるUOCクラスのインターフェースです。
- #response
- #responseの操作に関する説明を次に示します。
- 引数
- Map<String,Object>
- (UOCクラスに渡すデータをまとめたオブジェクト)
- 戻り値
- なし
- 例外
- CSCUocSystemException
UOCクラスから例外をthrowする場合は,次のクラスにラップしてthrowします。
- パッケージ
- jp.co.Hitachi.soft.csc.msg.uoc
- 例外クラス名
- CSCUocSystemException
- コンストラクタ
public CSCUocSystemException()
public CSCUocSystemException(String errorMessage )
(3) クラス構成例
クラス構成例を次に示します。
図G-1 クラス構成例
All Rights Reserved. Copyright (C) 2012, 2019, Hitachi, Ltd.