Hitachi

Cosminexus V11 BPM/ESB基盤 サービスプラットフォーム 開発ガイド 受付・アダプタ定義編

付録B.2　カスタムアダプタ開発フレームワークの定義ファイル

ここでは，カスタムアダプタ開発フレームワークで汎用カスタムアダプタを開発するときに定義するファイルの内容について説明します。

〈この項の構成〉

(1)　カスタムアダプタ開発フレームワーク動作定義ファイル

カスタムアダプタ開発フレームワーク動作定義ファイルは，java.util.PropertiesクラスのloadFromXMLメソッドで読み込むことができるXML形式のプロパティファイルです。カスタムアダプタ開発フレームワーク動作定義ファイルのファイル名は必ず「framework_properties.xml」にしてください。

機能

カスタムアダプタ開発フレームワークが読み込むプロトコルコンバータのクラス名（パッケージ名を含む）を指定します。プロトコルコンバータのクラス名は，key属性がclassnameであるentryタグに記述します。

ファイルの格納先

プロトコルコンバータのJARファイルを作成するときに，JARファイルのルートディレクトリに格納します。プロトコルコンバータのJARファイルの作成方法については，「3.3.16(5)　JARファイルの作成」を参照してください。

注意事項

  • ファイルが存在しない場合，またはjava.util.PropertiesクラスのloadFromXMLメソッドで読み込めないファイル形式の場合は，汎用カスタムアダプタを起動できません。

  • 複数のentry要素でkey属性を重複して指定しないでください。

記述例
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="classname">protocolconverter.MyProtocolConverter</entry>
</properties>

ページの先頭へ

(2)　カスタムアダプタプロパティファイル

カスタムアダプタプロパティファイルは，java.util.PropertiesクラスのloadFromXMLメソッドで読み込むことができるXML形式のプロパティファイルです。カスタムアダプタプロパティファイルのファイル名は，必ず「customadapter_properties.xml」にしてください。

機能

プロトコルコンバータで使用するプロパティを設定します。

汎用カスタムアダプタの開始時に，カスタムアダプタ開発フレームワークからプロパティが読み込まれます。読み込まれたプロパティは，アダプタコンテキストからgetPropertyメソッドで取得するPropertyインスタンスとして取得できます。

ファイルの格納先

汎用カスタムアダプタの定義時に，独自定義ファイルとして汎用カスタムアダプタに登録します。汎用カスタムアダプタの定義方法については，「3.3.16　汎用カスタムアダプタを定義する」を参照してください。

注意事項

ファイルが存在する場合でも，java.util.PropertiesクラスのloadFromXMLメソッドで読み込むことができないファイル形式のときは，汎用カスタムアダプタを起動できません。

記述例
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="init">1</entry>
<entry key="min">0</entry>
<entry key="max">10</entry>
</properties>

ページの先頭へ

(3)　カスタムアダプタ用アプリケーション統合属性ファイル

カスタムアダプタ用アプリケーション統合属性ファイルは，アプリケーション統合属性ファイルの一つで，次の場合に使用するXML形式のファイルです。

カスタムアダプタ用アプリケーション統合属性ファイルのファイル名は，必ず「cscadapter_property.xml」にしてください。

アプリケーション統合属性ファイルの詳細については，次の個所を参照してください。

機能

アプリケーション統合属性ファイルを使用することで，実行環境に合わせて汎用カスタムアダプタのパラメタを設定できます。

ファイルの格納先

汎用カスタムアダプタの定義時に，独自定義ファイルとして汎用カスタムアダプタに登録します。汎用カスタムアダプタの定義方法については，「3.3.16　汎用カスタムアダプタを定義する」を参照してください。

指定内容

カスタムアダプタ用アプリケーション統合属性ファイルのテンプレートを次の表に示します。このテンプレートを基に，可変部分を変更または追加してください。

また，<hitachi-application-all-property>/<ejb-jar>/<hitachi-session-bean-property>以下の要素として，次の項目の追加および編集ができます。

  • <ejb-ref>（リモートインターフェースを持つEnterprise Beanへの参照情報についての定義）

  • <ejb-local-ref>（EJB参照情報の設定）

  • <env-entry>（環境エントリについての定義）

  • <resource-ref>（リソース参照についての定義）

  • <resource-env-ref>（リソース環境変数についての定義）

  • <linked-queue>（queue名称）

    表B‒4　カスタムアダプタ用アプリケーション統合属性ファイルのテンプレート

    タグ

    説明

    変更可否

    <?xml version="1.0" encoding="MS932"?>

    XML宣言

    ○

    <!DOCTYPE hitachi-application-all-property

    PUBLIC '-//Hitachi, Ltd.//DTD Application All Property 7.1//EN'

    'http://localhost/hitachi-application-all-property_7_1.dtd'>

    DOCTYPE宣言

    −

    <hitachi-application-all-property>

    ルートタグ

    −

    　<hitachi-application-property>

    アプリケーションに関する情報の定義開始タグ

    −

    　　<description></description>

    アプリケーションの説明

    ○

    　　<icon>

    Deployツール上に表示されるJ2EEアプリケーションのアイコンの定義開始タグ

    −

    　　　<small-icon></small-icon>

    スモールアイコン（16×16）のファイル名

    ○

    　　　<large-icon></large-icon>

    ラージアイコン（32×32）のファイル名

    ○

    　　</icon>

    Deployツール上に表示されるJ2EEアプリケーションのアイコンの定義終了タグ

    −

    　　<lookup-name>CTMADP</lookup-name>

    クライアントからEJBをルックアップするときに使う名称

    ○※1

    　　<security-prop>

    Enterprise Beanのセキュリティの管理方法の定義開始タグ

    −

    　　　<security-method>no_security_for_methods_without_roles

    　　　</security-method>

    セキュリティの管理方法

    −

    　　　<default-security-role></default-security-role>

    security-methodにmap_methods_without_rolesを指定した場合のデフォルトセキュリティロール

    −

    　　</security-prop>

    Enterprise Beanのセキュリティの管理方法の定義終了タグ

    −

    　　<start-order>120</start-order>

    J2EEアプリケーション開始時および停止時の順番

    △※2

    　　<scheduling-unit>Application</scheduling-unit>

    キューの配置モデルの指定

    −

    　　<scheduling>

    CTMとの連携についての定義開始タグ

    −

    　　　<queue-name>CTMADP</queue-name>

    スケジューリングをするキューの名称

    ○※1

    　　　<parallel-count>1</parallel-count>

    CTMがアプリケーションを呼び出すために用意するスレッド数

    −

    　　　<queue-length></queue-length>

    スケジューリングをするキューの長さ

    −

    　　</scheduling>

    CTMとの連携についての定義終了タグ

    −

    　　<managed-by-ctm>false</managed-by-ctm>

    CTM連携をするかどうかの指定

    −

    　　<method-observation-recovery-mode>

    　　</method-observation-recovery-mode>

    J2EEアプリケーションの時間監視機能の障害回復モードの指定

    −

    　</hitachi-application-property>

    アプリケーションに関する情報の定義終了タグ

    −

    　<ejb-jar>

    EJBに関する情報の定義開始タグ

    −

    　　<hitachi-ejb-jar-property>

    EJB-JARの属性に関する情報の定義開始タグ

    −

    　　<description xml:lang="en"></description>

    EJB-JARの説明

    ○

    　　　<display-name xml:lang="en">CSCMsgServiceAdapter

    　　　</display-name>

    EJB-JARの表示名

    −

    　　　<icon xml:lang="en">

    GUIツール上に表示されるEJB-JARのアイコンの定義開始タグ

    −

    　　　　<small-icon></small-icon>

    スモールアイコン（16×16）のファイル名

    ○

    　　　　<large-icon></large-icon>

    ラージアイコン（32×32）のファイル名

    ○

    　　　</icon>

    GUIツール上に表示されるEJB-JARのアイコンの定義終了タグ

    −

    　　　<ejb-client-jar></ejb-client-jar>

    クライアントJARファイルの名称

    −

    　　</hitachi-ejb-jar-property>

    EJB-JARの属性に関する情報の定義終了タグ

    −

    　　<hitachi-session-bean-property>

    SessionBeanの属性の定義の開始タグ

    −

    　　　<description xml:lang="en"></description>

    SessionBeanの説明

    ○

    　　　<display-name xml:lang="en">CSCMsgServiceAdapterEJB

    　　　</display-name>

    SessionBeanの表示名

    −

    　　　<icon xml:lang="en">

    GUIツール上に表示されるSessionBeanのアイコンの定義開始タグ

    −

    　　　　<small-icon></small-icon>

    スモールアイコン（16×16）のファイル名

    ○

    　　　　<large-icon></large-icon>

    ラージアイコン（32×32）のファイル名

    ○

    　　　</icon>

    GUIツール上に表示されるSessionBeanのアイコンの定義終了タグ

    −

    　　　<session-type>Stateless</session-type>

    SessionBeanの種別

    −

    　　　<transaction-type>Container</transaction-type>

    トランザクション管理種別

    −

    　　　<env-entry>

    環境エントリについての定義開始タグ

    △※3

    　　　　<description xml:lang="en"></description>

    env-entryの説明

    　　　　<env-entry-name>CscServerName</env-entry-name>

    環境エントリの名称

    　　　　<env-entry-type>java.lang.String</env-entry-type>

    環境エントリのデータ型

    　　　　<env-entry-value>HCSC</env-entry-value>

    環境エントリの値

    　　　</env-entry>

    環境エントリについての定義終了タグ

    　　　<env-entry>

    環境エントリについての定義開始タグ

    　　　　<description xml:lang="en"></description>

    env-entryの説明

    　　　　<env-entry-name>CscClusterName</env-entry-name>

    環境エントリの名称

    　　　　<env-entry-type>java.lang.String</env-entry-type>

    環境エントリのデータ型

    　　　　<env-entry-value>Cluster</env-entry-value>

    環境エントリの値

    　　　</env-entry>

    環境エントリについての定義終了タグ

    　　　<env-entry>

    環境エントリについての定義開始タグ

    　　　　<description xml:lang="en"></description>

    env-entryの説明

    　　　　<env-entry-name>AdapterName</env-entry-name>

    環境エントリの名称

    　　　　<env-entry-type>java.lang.String</env-entry-type>

    環境エントリのデータ型

    　　　　<env-entry-value>CTMADP</env-entry-value>

    環境エントリの値

    　　　</env-entry>

    環境エントリについての定義終了タグ

    　　　<container-transaction>

    コンテナのトランザクションについての定義開始タグ

    −

    　　　　<description xml:lang="en"></description>

    container-transactionの説明

    −

    　　　　<method>

    メソッドについての定義開始タグ

    −

    　　　　　<description xml:lang="en"></description>

    メソッドの説明

    −

    　　　　　<method-intf></method-intf>

    メソッドが属するインターフェース種別

    −

    　　　　　<method-name>*</method-name>

    メソッド名

    −

    　　　　</method>

    メソッドについての定義終了タグ

    −

    　　　　<trans-attribute>Required</trans-attribute>

    メソッドに割り当てるトランザクション属性

    −

    　　　</container-transaction>

    コンテナのトランザクションについての定義終了タグ

    −

    　　　<session-runtime>

    runtimeの定義開始タグ

    −

    　　　　<lookup-name>CSCMsgServiceAdapterEJB

    　　　　</lookup-name>

    クライアントからEJBをルックアップする場合に使う名前

    −

    　　　　<optional-name>CTMADP</optional-name>

    リモートインターフェースの別名

    △※3

    　　　　<maximum-sessions>0</maximum-sessions>

    セッションの最大数

    ○

    　　　　<stateless>

    statelessの定義開始タグ

    −

    　　　　　<pooled-instance>

    プール内のインスタンスについての定義開始タグ

    −

    　　　　　　<minimum>1</minimum>

    プール内のインスタンスの最小数

    ○

    　　　　　　<maximum>0</maximum>

    プール内のインスタンスの最大数

    ○

    　　　　　</pooled-instance>

    プール内のインスタンスについての定義終了タグ

    −

    　　　　　<instance-timeout>0</instance-timeout>

    インスタンス取得時のタイムアウト時間

    ○

    　　　　</stateless>

    stateless定義の終了タグ

    −

    　　　　<enable-scheduling>false</enable-scheduling>

    該当するBeanをスケジューリングの対象にするかどうか（スケジューラのGateとして使用するかどうか）の指定

    −

    　　　　<pass-by-reference>true</pass-by-reference>

    Bean単位でのデータの参照渡し（pass by reference）の指定

    △※3

    　　　　<scheduling>

    CTM連携関連の情報の定義開始タグ

    −

    　　　　　<queue-name>CSCMsgServiceAdapterEJB

    　　　　　</queue-name>

    スケジューリングを行うqueue名称

    −

    　　　　　<parallel-count>1</parallel-count>

    CTMがアプリケーションを呼び出すために用意するスレッド数

    −

    　　　　　<queue-length></queue-length>

    スケジューリングをするキューの長さ

    −

    　　　　</scheduling>

    CTM連携関連の情報の定義終了タグ

    −

    　　　　<front-ejb>false</front-ejb>

    フロントEJB（クライアントが直接呼び出すEJB）かどうかの指定

    −

    　　　</session-runtime>

    runtimeの定義終了タグ

    −

    　　　<start-order>10</start-order>

    J2EEアプリケーション開始時および停止時の順番の指定

    −

    　　</hitachi-session-bean-property>

    SessionBeanの属性の定義の終了タグ

    −

    　</ejb-jar>

    EJBに関する情報の定義の終了タグ

    −

    </hitachi-application-all-property>

    ルートタグ

    −
    （凡例）

    ○：変更できます。

    △：自動的に変更されます。

    −：変更できません。

    注※1

    サービスIDを指定してください。

    注※2

    汎用カスタムアダプタのデプロイ時に自動的に設定されます。

    注※3

    汎用カスタムアダプタのデプロイ時に自動的に追加または上書きされます。

注意事項

ページの先頭へ

(4)　カスタムアダプタ定義ファイル

カスタムアダプタ定義ファイルの機能，および設定できるプロパティについて説明します。

機能

汎用カスタムアダプタの情報を設定します。

ファイルの格納先
<サービスプラットフォームのインストールディレクトリ>\CSC\samples\customadapter\csccustomadapter.properties
設定できるプロパティ

custom-adapter.dt-skip={ true | false }

データ変換時に電文の構造変換をスキップするかどうかを指定します。キーまたは値を省略した場合は，構造変換をスキップしません。

  • true

    構造変換をスキップします。

  • false

    構造変換をスキップしません。

なお，値を指定する場合は，trueまたはfalseのどちらかを指定してください。trueまたはfalse以外の値を指定した場合，コマンド実行時にエラーになります。

ページの先頭へ

商品名称に関する表示

All Rights Reserved. Copyright (C) 2020, 2021, Hitachi, Ltd.