intra-mart Accel Platform 設定ファイルリファレンス 第23版 2019-08-01

SOAPClientオブジェクトの設定

概要

スクリプト開発向け im-BizAPI SOAPClientオブジェクトを使用するための設定です。
この設定はWebサービスを呼び出すためのスタブを生成する際に利用されます。

モジュール Webサービス 認証・認可クライアント
フォーマットファイル(xsd) WEB-INF/schema/soap-client-config.xsd
設定場所 WEB-INF/conf/soap-client-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<soap-client-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://intra_mart.co.jp/system/javascript/soap/config/soap-client-config"
    xsi:schemaLocation="http://intra_mart.co.jp/system/javascript/soap/config/soap-client-config ../schema/soap-client-config.xsd ">
  <wsdl>
    <!-- <mode>Once</mode> -->
    <!-- <work-dir>work/jssp/_functioncontainer</work-dir> -->
    <!-- <javac-encoding>UTF-8</javac-encoding> -->
    <!-- <javac-verbose>false</javac-verbose> -->
    <!-- <javac-xmx>64m</javac-xmx> -->
    <import-file-suffixes>
      <suffix>.xsd</suffix>
      <suffix>.wsdl</suffix>
    </import-file-suffixes>
    <import-sub-dirs>
      <sub-dir>xsd</sub-dir>
    </import-sub-dirs>
  </wsdl>
</request-control-config>

リファレンス

Web サービスのスタブ生成種別

タグ名 mode
SOAPClient のインスタンス生成時に行われるWeb サービスのスタブ生成に関する設定です。
スタブの生成ではWSDL の解析、Java スタブ・ソースの生成&コンパイル、および、JavaScript ソースの生成が実行されます。

【設定項目】

<soap-client-config>
  <mode>Once</mode>
</soap-client-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
Everytime Web サービスのスタブを毎回作成します。開発時に利用する設定です。
Once Web サービスのスタブが存在しない場合のみスタブを作成します。
Never Webサービスのスタブを自動生成しません。 このモードの場合、別途、Web サービスのスタブを配備する必要があります。 具体的には、Axis2が生成する Java のスタブ・クラスをクラスパスに追加し SOAPClient オブジェクトで生成された JavaScript のスタブ・ソースをソー スディレクトリ ( 通常はWEB-INF/jssp/src ) に追加する必要があります。
単位・型 文字列 ( Everytime | Once | Never )
省略時のデフォルト値 Once
親タグ soap-client-config

ファイル出力ディレクトリ

タグ名 work-dir
Web サービスのスタブ、および、WSDL ファイルを展開するディレクトリを指定します。

【設定項目】

<soap-client-config>
  <work-dir>work/jssp/_functioncontainer</work-dir>
</soap-client-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Web サービスのスタブ、および、WSDL ファイルを展開するディレクトリを設定します。
単位・型 文字列 (xxx/xxx/xxxxx)
省略時のデフォルト値 ファンクションコンテナの自動コンパイル時のクラスファイル出力先ディレクトリ
親タグ soap-client-config

スタブの文字コード

タグ名 javac-encoding
Web サービスのスタブをコンパイルする際のJava ソースの文字コードを指定します。

【設定項目】

<soap-client-config>
  <javac-encoding>UTF-8</javac-encoding>
</soap-client-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Web サービスのスタブをコンパイルする際のJava ソースの文字コードを設定します。
単位・型 文字列 (xxxxx)
省略時のデフォルト値 UTF-8
親タグ soap-client-config

スタブの詳細情報出力

タグ名 javac-verbose
Web サービスのスタブをコンパイルする際の詳細情報出力可否を指定します。

【設定項目】

<soap-client-config>
  <javac-verbose>false</javac-verbose>
</soap-client-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
false 詳細情報は出力されません。
true 詳細情報が出力されます。
単位・型 真偽値 (true/false)
省略時のデフォルト値 false
親タグ soap-client-config

スタブのコンパイル時の最大ヒープサイズ

タグ名 javac-xmx
Web サービスのスタブをコンパイルする際の最大ヒープサイズを指定します。
例えば、<javac-xmx>256m</javac-xmx>と設定した場合、最大ヒープサイズは 256M バイトに設定されます。

【設定項目】

<soap-client-config>
  <javac-xmx>64m</javac-xmx>
</soap-client-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Web サービスのスタブをコンパイルする際の最大ヒープサイズを設定します。
単位・型 文字列
省略時のデフォルト値 利用する JavaVMの-Xmxオプションの初期値
親タグ soap-client-config

スタブ ヘルパークラス

タグ名 helper
Web サービスのスタブ生成時に利用するヘルパーオブジェクトを指定します。

【設定項目】

<soap-client-config>
  <helper>system/common/parts/soap_client/soap_client_helper</helper>
</soap-client-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 ヘルパーに指定するJSプログラムのパスを設定します。
単位・型 文字列
省略時のデフォルト値 system/common/parts/soap_client/soap_client_helper
親タグ soap-client-config

Storage上のWSDLファイルの利用

タグ名 wsdl
Storage上に保存されているWSDLファイルを利用する際に必要になる設定を行います。

【設定項目】

<soap-client-config>
  <wsdl>
    ...
  </wsdl>
</soap-client-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Storage上に保存されているWSDLファイルを利用する際に必要な設定を行います。
単位・型 なし
省略時のデフォルト値 なし
親タグ soap-client-config

スタブ生成時に参照するファイル

タグ名 import-file-suffixes
スタブ生成に必要なファイルの拡張子を設定します。
Storage Service 上に保存されているWSDL ファイルを利用する際に必要な設定です。
例えば、ある WSDL ファイルで参照している要素が、別のファイルで定義されている場合、その定義ファイルの拡張子をここに設定します。

【設定項目】

<soap-client-config>
  <wsdl>
    <import-file-suffixes>
      ...
    </import-file-suffixes>
  </wsdl>
</soap-client-config>

必須項目
複数設定 ×
設定値・設定する内容 スタブ生成に必要なファイルの拡張子を設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ wsdl

ファイル拡張子

タグ名 suffix
設定するファイル拡張子を指定します。

【設定項目】

<soap-client-config>
  <wsdl>
    <import-file-suffixes>
      <suffix>.xsd</suffix>
    </import-file-suffixes>
  </wsdl>
</soap-client-config>

必須項目
複数設定
設定値・設定する内容 ファイルの拡張子を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ import-file-suffixes

スタブ生成時に参照するディレクトリ

タグ名 import-sub-dirs
スタブ生成に必要なファイルが格納されているディレクトリを設定します。
Storage Service 上に保存されているWSDL ファイルを利用する際に必要な設定です。
例えば、ある WSDL ファイルで参照している要素が、別のファイルで定義されている場合、そのファイルが保存されているディレクトリをここに設定します。
設定されているディレクトリは WSDL ファイルが保存されているディレクトリのサブディレクトリとして利用されます。

【設定項目】

<soap-client-config>
  <wsdl>
    <import-sub-dirs>
      ...
    </import-sub-dirs>
  </wsdl>
</soap-client-config>

必須項目
複数設定 ×
設定値・設定する内容 スタブ生成に必要なファイルが格納されているディレクトリを設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ wsdl

参照するディレクトリ

タグ名 sub-dir
参照先に設定するディレクトリを指定します。

【設定項目】

<soap-client-config>
  <wsdl>
    <import-sub-dirs>
      <sub-dir>xsd</sub-dir>
    </import-sub-dirs>
  </wsdl>
</soap-client-config>

必須項目
複数設定
設定値・設定する内容 参照先のディレクトリを設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ import-sub-dirs

getSampleCode 関数動作設定

タグ名 sample-data
SOAPClient#getSampleCode() 関数の実行時の動作設定を行います。

【設定項目】

<soap-client-config>
  <sample-data>
    ...
  </sample-data>
</soap-client-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 SOAPClient#getSampleCode() 関数の実行時の動作設定を行います。
単位・型 なし
省略時のデフォルト値 なし
親タグ soap-client-config

サンプルデータ出力対象外クラス

タグ名 exclude-classes
SOAPClient#getSampleCode()関数で生成されるコードに関して、サンプルデータの出力対象外とするクラスを設定します。
SOAPClient#getSampleCode() 関数を実行した際に出力されるソースコードのサンプルに含まれている Sample Data に出力しないクラスを設定します。

【設定項目】

<soap-client-config>
  <sample-data>
    <exclude-classes>
      ...
    </exclude-classes>
  </sample-data>
</soap-client-config>

必須項目
複数設定 ×
設定値・設定する内容 サンプルデータの出力対象外とするクラスを設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ sample-data

クラス名

タグ名 class-name
サンプルデータの出力対象外とするクラスのクラス名を指定します。

【設定項目】

<soap-client-config>
  <sample-data>
    <exclude-classes>
      <class-name>sample.ExcludeClass</class-name>
    </exclude-classes>
  </sample-data>
</soap-client-config>

必須項目
複数設定
設定値・設定する内容 サンプルデータの出力対象外とするクラスのクラス名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ exclude-classes