次の各トピックでは、通信アダプタ用 Java CAPS プロジェクトコンポーネントの設定手順について説明します。
ここでは、Java CAPS アダプタの接続マッププロパティーを設定する方法について説明します。
すべてのアダプタには、一意の一連のデフォルト構成パラメータが含まれています。アダプタが確立され、プロジェクトの環境内に外部システムが作成されたら、アダプタのパラメータを特定のシステム用に変更します。アダプタの構成パラメータの変更は、次の各場所から行います。
接続マップ: これらのパラメータはほとんどの場合、ある特定のコンポーネントのアダプタに適用されるため、その値は通常、プロジェクト内のほかの同じタイプのアダプタとは異なります。
エンバイロメントエクスプローラ: これらのパラメータは通常グローバルであり、プロジェクト内の同じタイプのすべてのアダプタに適用されます。保存されたプロパティーは、外部システムウィンドウ内のすべてのアダプタによって共有されます。
コラボレーションまたはビジネスプロセス: アダプタのプロパティーは、コラボレーションまたはビジネスプロセスからも設定できます。その場合、その設定は、アダプタの接続マップ設定内の対応するプロパティーを上書きします。上書きされないプロパティーはすべて、そのデフォルト設定を維持します。
コラボレーションに外部アプリケーションを接続すると、Netbeans IDE によって適切なアダプタがリンクに自動的に割り当てられます。各アダプタにはデフォルト設定プロパティーを含むテンプレートが用意されていますが、これらのプロパティーには接続マップからアクセスできます。
接続マップ内では、インバウンドモードまたはアウトバウンドモード、あるいはその両方にアダプタを設定できます。
接続マップ上でアダプタのアイコンをダブルクリックします。
アダプタの「プロパティー」ウィンドウが表示され、インバウンドアダプタのデフォルトプロパティーが表示されます。
接続マップ上でアダプタのアイコンをダブルクリックします。
アダプタの「プロパティー」ウィンドウが表示され、アウトバウンドアダプタのデフォルトプロパティーが表示されます。
SNA インバウンドアダプタの接続マップは、次の各プロパティーカテゴリから構成されています。
次の表に、インバウンドアダプタの「一般設定」を示します。
表 1–1 インバウンドアダプタ —一般設定
名前 |
説明 |
必要な値 |
---|---|---|
状態のスコープ |
OTD サブノードである State オブジェクトのスコープを定義します。 |
このパラメータの有効なオプションは、次のとおりです。 |
次の表に、インバウンドアダプタの「SNA 設定」を示します。
表 1–2 インバウンドアダプタ — SNA 設定
次の表に、インバウンドアダプタの「接続の確立」プロパティーを示します。
表 1–3 インバウンドアダプタ — 接続の確立
名前 |
説明 |
必要な値 |
---|---|---|
接続の最大再試行回数 |
接続の取得に失敗した場合に接続を確立するための再試行の、最大回数を指定します。 |
有効な数値。デフォルトは 3 です。 |
接続再試行間隔 |
SNA LU62 宛先へのアクセスを再度試みる際の一時停止時間をミリ秒で指定します。この設定は、「接続の最大再試行回数」設定と組み合わせて使用されます。 たとえば、接続再試行回数の値が 3 で、接続再試行間隔が 30000 の場合、アダプタは SNA 宛先への接続に失敗すると、再接続を 30 秒の間隔で 3 回試みます。 |
有効な数値。デフォルトは 30000 です。 |
次の表に、インバウンドアダプタの「インバウンド接続の管理」プロパティーを示します。
表 1–4 インバウンドアダプタ — インバウンド接続の管理
ここでは次の内容について説明します。
「リスナースケジュール」プロパティーは、サーバーが新しいクライアント接続確立要求の到着を待つ必要がある場合のスケジュールを指定します。このスケジュールはリスナー/モニター用です。次の表に、「リスナースケジュール」プロパティーを示します。
表 1–5 インバウンドスケジュール—リスナースケジュール
次の表に、インバウンドアダプタの「サービススケジュール」プロパティーを示します。
表 1–6 インバウンドスケジュール — サービススケジュール
次の表に、アウトバウンドアダプタの「一般設定」を示します。
表 1–7 アウトバウンドアダプタ — 一般設定
名前 |
説明 |
必要な値 |
---|---|---|
状態のスコープ |
OTD サブノードである State オブジェクトのスコープを定義します。 |
このパラメータの有効なオプションは、次のとおりです。 |
次の表に、アウトバウンドアダプタの「SNA 設定」を示します。
表 1–8 アウトバウンドアダプタ —SNA 設定
次の表に、アウトバウンドアダプタの「接続の確立」プロパティーを示します。
表 1–9 アウトバウンドアダプタ — 接続の確立
ここでは、レコード処理を行う BatchRecordOTD のプロパティーについて説明します。BatchRecord のプロパティーに含まれるセクションは、次のとおりです。
BatchRecord の接続マッププロパティーの「一般設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–10 接続マップ - BatchRecord - 一般設定
ここでは、「レコード」のパラメータを設定し、アダプタに認識させるレコード特性を指定できます。
BatchRecord の接続マッププロパティーの「レコード」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–11 接続マップ - BatchRecord - レコード
ここでは、接続マップからアクセスされる BatchFTP OTD の構成パラメータについて説明します。
BatchFTP の接続マッププロパティーに含まれるセクションは、次のとおりです。
これらの設定オプションのいくつかでは、正規表現を使用できます。この拡張機能は便利ですが、注意して使用する必要があります。正規表現の形式が不適切だと、不要なデータが作成される可能性があるほか、データが失われる可能性さえあります。この機能を使用する前に、正規表現の構文や構成についてよく理解しておく必要があります。そのような設定は、十分にテストを行ったあとで本番環境に移行することをお勧めします。
転送前処理とは、ファイル転送の前に実行される処理のことです。
BatchFTP の接続マッププロパティーの「転送前」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–12 接続マップ - BatchFTP - 転送前
BatchFTP の SOCKS は NO-AUTHENTICATION、USER/PASSWORD の 2 つのネゴシエーション方式をサポートします。
BatchFTP の接続マッププロパティーの「SOCKS」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–13 接続マップ - BatchFTP - SOCKS
BatchFTP の接続マッププロパティーの「FTP」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–14 接続マップ - BatchFTP - 転送前
FTP raw コマンドとは、FTP サーバーに直接送信されるコマンドのことです。
BatchFTP の接続マッププロパティーの「FTP raw コマンド」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–15 接続マップ - BatchFTP - FTP raw コマンド
BatchFTP の接続マッププロパティーの「シーケンス番号」セクションには、次の表に示す最上位パラメータが含まれています。
シーケンス番号を使用するには、「一般設定」の下にある「同期」プロパティーを「はい」に設定する必要があります。
名前 |
説明 |
必要な値 |
---|---|---|
ターゲットのディレクトリまたはファイルの名前にシーケンス番号が含まれるように設定した場合に、このパラメータを使用します。これは、この値 (最大シーケンス番号) に達した際にシーケンス番号を「開始シーケンス番号」の値にリセットするように、アダプタに指示します。 このパラメータは、名前パターン %# で使用されます。 |
1 から 2147483647 までの整数。最大シーケンス番号の値は開始シーケンス番号の値よりも大きくなければいけません。 |
|
ターゲットのディレクトリまたはファイルの名前にシーケンス番号が含まれるように設定した場合に、このパラメータを使用します。これは、前回実行時のシーケンス番号が存在しない場合にどの値から開始するかを、アダプタに指示します。 このパラメータは、名前パターン %# で使用されます。 この最大シーケンス番号の値に達すると、シーケンス番号が開始シーケンス番号の値にリセットされます。 |
0 から 2147483647 までの整数。開始シーケンス番号の値は最大シーケンス番号の値よりも小さくなければいけません。 |
転送後処理とは、実際の FTP 転送のあとでリモート (FTP) サイト上で実行される処理のことです。
BatchFTP の接続マッププロパティーの「転送後」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–17 接続マップ - BatchFTP - 転送後
名前 |
説明 |
必要な値 |
---|---|---|
ファイルのリネーム先となる、外部システム上のディレクトリの名前 (パス) を指定します。値としては、リテラルまたはパターン名を指定できます。 (宛先への) アウトバウンド転送の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。この設定は、「転送後 コマンド」パラメータが「リネーム」処理の場合にのみ使用されます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ディレクトリ名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「転送後ディレクトリ名がパターン」プロパティーを参照してください。 |
ディレクトリの正確な名前 (パスを含む) を入力するか、パターン名を入力するか、あるいは次のいずれかの値を選択します。
|
|
次のように、ディレクトリに対して入力されたパターンがリテラル、名前パターンのいずれを表すかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
|
外部システム上のファイルのリネーム後のファイル名を指定します。値はファイル名を表します。値としては、リテラルまたはパターン名を指定できます。 この設定は、「転送後 コマンド」パラメータが「リネーム」処理の場合にのみ使用されます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ファイル名を示します。 「転送後ディレクトリ名がパターン」プロパティーを参照してください。 |
ファイルの正確な名前を入力するか、パターン名を入力するか、あるいは次のいずれかの値を選択します。
|
|
次のように、ファイル名に対して入力されたパターンがリテラル、名前パターンのいずれとして解釈されるかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
|
実際のファイル転送の直前または「コミット」フェーズ中に、必要なアクションを実行できるようにします。 インバウンド転送の場合、自動バックアップを行う (リネーム) か転送済みのファイルを永続的に破棄する (削除) ことで、そのファイルを「使用済み」としてマークできます。アウトバウンド転送の場合、転送済みのファイルをリネームすることで、ほかのクライアントからそのファイルを使用できるようにすることができます。オプションは次のとおりです。
|
「リネーム」、「削除」、または「なし」を選択します。 デフォルト設定は「なし」です。 |
「ターゲットの場所」セクションでは、FTP ディレクトリおよびファイルのターゲット場所 (リモートの場所) に関するパラメータを設定できます。
BatchFTP の接続マッププロパティーの「ターゲットの場所」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–18 接続マップ - BatchFTP - ターゲットの場所
名前 |
説明 |
必要な値 |
---|---|---|
既存ファイルにデータを上書きするか、あるいはデータを追加するかを指定します。このパラメータを使用するのは、アウトバウンド FTP 転送の場合だけです。次のように適切な設定を選択します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
ファイルの取得元または送信先となる、外部システム上のディレクトリを指定します。ディレクトリ名とパスを指定することをお勧めしますが、指定しなかった場合、パスは、FTP サーバーにログオンした際のホームディレクトリから見た相対パスになります。 値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 アウトバウンド FTP 処理 (宛先) の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。 「ターゲットディレクトリ名がパターン」プロパティーを参照してください。 |
ターゲット外部システム上のディレクトリ名とパス。 |
|
次のように、ディレクトリ名がリテラルを表すか、あるいは正規表現または名前パターンを表すかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
取得または送信されるリモート FTP ファイルの名前を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 MVS GDG システムの場合、ターゲットファイル名としてデータセットのバージョンを指定できます。次に例を示します。
|
インバウンドの場合: リテラルファイル名または正規表現。 アウトバウンドの場合: リテラルファイル名または名前パターン。 |
|
次のように、ターゲットファイル名がリテラルを表すか、あるいは正規表現または名前パターンを表すかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
「SSH トンネリング」セクションは、SSH トンネリングのプロパティーを設定するための情報を提供します。セキュリティー保護された FTP (FTP over SSH または FTP over SSL) が必要な場合には、セキュリティー保護された FTP の OTD (BatchFTPOverSSL、BatchSFTP、および BatchSCP) を使用します。
BatchFTP の接続マッププロパティーの「SSH トンネリング」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–19 接続マップ - BatchFTP - SSH トンネリング
名前 |
説明 |
必要な値 |
---|---|---|
アダプタが SSH サブプロセスを起動する必要があるかどうかを指定します。 「いいえ」を選択した場合、それは、SSH チャネルがまだ確立されていないことを示します。アダプタは、内部的にサブプロセスを生成したあと、ユーザーに代わってチャネルを確立します。 「いいえ」を選択した場合に設定する必要のあるパラメータは、次のとおりです。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
SSH チャネルの確立に使用されるコマンド行を指定します。このパラメータが必要になるのは、「SSH チャネルが確立済み」パラメータを「いいえ」に設定する場合だけです。 このエントリは、SSH トンネリングをサポートするために使用している追加ソフトウェアアプリケーションが必要とする、完全で正しいコマンド行でなければいけません。このコマンド行はそのまま実行されるため、次のことを確認する必要があります。
|
有効な SSH コマンド行。 |
|
コマンド行の構文は、使用する SSH クライアント実装の種類に応じて異なる可能性があります。詳細については、SSH トンネリングサポートソフトウェアのユーザーマニュアルを参照してください。 例 ssh -L 3456:ftp.sun.com:21 -o BatchMode=yes apple ssh -L 4567:apple:21 -o BatchMode=yes apple ssh -L 5678:orange:21 -o BatchMode=yes apple ssh -L 6789:orange:21 -g -o BatchMode=yes apple plink -L 4567:apple:21 apple plink -L 5678:orange:21 apple plink -L 6789:orange:21 -g apple | ||
FTP コマンド接続が SSH トンネル経由でセキュリティー保護されるかどうかを指定します。 「いいえ」を選択すると、このセクション内のその他のパラメータはすべて無視されます。 注 – SSH ポート転送機能を使用するには、使用しているサーバーの種類やその現在の設定内容によっては FTP サーバーを設定し直さなければいけない可能性があります。 |
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
アダプタの SSH トンネリング (ポート転送とも呼ばれる) の機能では、Windows の Plink や UNIX の OpenSSH など、追加の既存 SSH サポートソフトウェアアプリケーションが活用されます (「追加のソフトウェア要件」を参照)
コマンドの構文や環境設定は、SSH クライアント実装ごとに異なる可能性があります。詳細については、SSH サポートアプリケーションのユーザーガイドを参照してください。
SSH トンネリングは、セキュリティー保護された FTP コマンド接続を提供します。この機構は既存の SSH ポート転送設定に基づいています。SSH をサポートするアダプタ接続を設定する前に、SSH 待機ホスト上で SSH ポート転送を設定する必要があります。
たとえば、アプリケーションサーバークライアントホスト localhost 上で、コマンドを次のように発行することができます。
ssh -L 4567:apple:21 -o BatchMode=yes apple |
上の例に対するアダプタの設定の下で、次の情報を指定する必要があります。
環境パラメータ「SSH 待機ホスト」で localhost
環境パラメータ「SSH 待機ポート」で 4567
この場合、アダプタは SSH トンネル経由で FTP サーバー apple:21 に接続します。SSH トンネリングの詳細については、「SSH トンネリングのサポート」を参照してください。
SOCKS と SSH トンネリングは同時に使用可能です。ただし、この方法はお勧めできません。
BatchFTP の接続マッププロパティーの「一般設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–20 接続マップ - BatchFTP - 一般設定
名前 |
説明 |
必要な値 |
---|---|---|
旧バージョンのバッチアダプタプロジェクトだけに適用されます。バージョン 5.0.7 以前のバッチアダプタを使って作成されたプロジェクトを、そのアダプタの動作を変更しないでインポートおよび配備できるようにするための下位互換性を提供します。選択肢は次のとおりです。
|
「はい」または「いいえ」。 デフォルト設定は「はい」ですが、この場合、バージョン 5.0.7 以前のバッチアダプタを使って作成されたプロジェクトがシミュレートされます。 |
BatchFTPOverSSL アダプタの接続マッププロパティーに含まれるトピックは、次のとおりです。
「転送前」トピックでは、保護/バックアップ/復旧の動作をカスタマイズできます。ここでは、実際のファイル転送の前にリモートまたはローカルで実行される処理について説明します。
BatchFTPOverSSL の接続マッププロパティーの「転送前」トピックには、次の表に示す最上位パラメータが含まれています。
表 1–21 接続マップ - BatchFTPOverSSL - 転送前
名前 |
説明 |
必要な値 |
---|---|---|
リモートディレクトリ名 |
ファイルのリネームまたはコピーの実行場所となる、リモート外部システム上のディレクトリとパスを指定します。これは、「リモート転送前コマンド」が「リネーム」または「コピー」の場合にのみ使用されます。 値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。宛先のディレクトリを指定する場合、そのディレクトリがまだ存在していなければ、そのディレクトリが作成されます。 特殊文字を使用できます。このパラメータが使用されるたびに、 あらゆる特殊文字の展開 が実行されます。たとえば、パターン %f は元の作業ディレクトリ名を意味します。 「リモートディレクトリ名がパターン」プロパティーを参照してください。 |
ターゲットシステム上のディレクトリ名とパス。 特殊文字を使用できます。 |
リモートディレクトリ名がパターン |
次のように、ディレクトリに対して入力されたパターンがリテラルを表すのか、あるいは名前パターンまたは正規表現を表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
リモートファイル名 |
ファイルのリネーム先またはコピー先となる、外部システム上のファイルの名前を指定します。この値は、パスを含まないファイル名を表します。この設定は、「転送前コマンド」パラメータが「リネーム」または「コピー」処理の場合にのみ使用されます。 値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ファイル名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「リモートファイル名がパターン」プロパティーを参照してください。 |
リモートファイル名。 |
リモートファイル名がパターン |
次のように、ファイル名に対して入力されたパターンがリテラルを表すのか、あるいは名前パターンまたは正規表現を表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
リモート転送前コマンド |
実際のファイル転送の直前に必要なアクションを実行できるようにします。インバウンド転送の場合、同じディレクトリおよびファイルのパターンまたは名前を使ってターゲットシステムに対するポーリングを行うほかのクライアントがそのファイルを使用するのを禁止できます。アウトバウンド転送の場合、既存のファイルを自動的にバックアップ/クリーンアップできます。オプションは次のとおりです。
|
「リネーム」、「コピー」、または「なし」を選択します。 デフォルト設定は「なし」です。 注 – 「コピー」オプションを使用すると、コピーするファイルのサイズが大きい場合は特に、システムのパフォーマンスが低下する可能性があります。 |
ローカルディレクトリ名 |
「リネーム」または「コピー」で使用されるディレクトリ名 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 特殊文字を使用できます (名前パターン)。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「リモートファイル名がパターン」プロパティーを参照してください。 注 – パス区切り文字を入力する際には、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 |
ディレクトリ名。 |
ローカルディレクトリ名がパターン |
次のように、ローカルディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ローカルファイル名 |
「リネーム」または「コピー」で使用されるファイル名を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「ローカルファイル名がパターン」プロパティーを参照してください。 |
ファイル名。 |
ローカルファイル名がパターン |
次のように、ローカルファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ローカル転送前コマンド |
実際のファイル転送の直前に必要なアクションを実行できるようにします。インバウンド転送の場合、同じディレクトリおよびファイルのパターンまたは名前を使ってターゲットシステムに対するポーリングを行うほかのクライアントがそのファイルを使用するのを禁止できます。アウトバウンド転送の場合、既存のファイルを自動的にバックアップできます。オプションは次のとおりです。
|
「リネーム」、「コピー」、または「なし」を選択します。 デフォルト設定は「なし」です。 注 – 「コピー」オプションを使用すると、コピーするファイルのサイズが大きい場合は特に、システムのパフォーマンスが低下する可能性があります。 |
BatchFTPOverSSL の接続マッププロパティーの「FTP および SSL の設定」トピックには、次の表に示す最上位パラメータが含まれています。
表 1–22 接続マップ - BatchFTPOverSSL - FTP および SSL の設定
名前 |
説明 |
必要な値 |
---|---|---|
セキュリティー保護モードを指定します。選択肢は次のとおりです。
|
「なし」、「暗黙的な SSL」、または「明示的な SSL」を選択します。 「なし」がデフォルト設定になります。 |
|
FTP サーバーのディレクトリリストスタイルを「UNIX」、「NT」、または「MVS」として指定します。これは、FTP サーバーからのディレクトリリスト応答を解析するための「ヒント」を、クライアント側に提供します。 |
「UNIX」のままにしておきます。現時点でサポートされているオプションは、「UNIX」だけです。 デフォルト設定は「UNIX」です。 |
|
FTP 受動モードが有効かどうかを指定します。 |
「はい」または「いいえ」を選択します。 「はい」は、FTP 受動モードが有効であることを示します。 デフォルト設定は「はい」です。 |
|
転送の形式がバイナリコード、ASCII テキストのいずれであるかを指定します。 |
「BINARY」または「ASCII」を選択します。デフォルト設定は「BINARY」です。 |
|
リモートサーバーに新しく転送されるデータを、以前に転送されたデータの末尾に追加するかどうかを指定します。 |
「はい」または「いいえ」を選択します。 「はい」は、データが追加されることを示します。 デフォルト設定は「いいえ」です。 |
|
サーバー認証が必要かどうかを指定します。選択肢は次のとおりです。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
|
ログインユーザーの識別名 (DN) を指定します。これは、CSR 返信からインポートされ、クライアント認証の設定に使用されます。 |
X.509 の識別名。 |
|
JKS タイプのキーストア内の、ある鍵ペアの別名を指定します。この値は、クライアント認証の設定に使用されます。 |
別名。 |
|
別名で特定されたキーストア内の鍵ペアエントリを保護するパスワードを指定します。 |
別名のパスワード。 |
|
データの送受信場所となる、FTP サーバー上のディレクトリを指定します。このディレクトリのアクセス可能性は通常、ログインユーザーに依存します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 「リモートディレクトリ名がパターン」プロパティーを参照してください。 |
リモートディレクトリの名前。 |
|
次のように、リモートディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
リモートサーバー上のファイル名を指定します。
|
リモートファイルの名前。 |
|
次のように、リモートファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
リモートシステムとの間で送受信されるファイル用のローカルディレクトリ (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 「ローカルディレクトリ名がパターン」プロパティーを参照してください。 |
ローカルディレクトリ名。 |
|
次のように、ローカルディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
ローカルファイル名を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 「ローカルファイル名がパターン」プロパティーを参照してください。 |
ローカルファイル名。 |
|
次のように、ローカルファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
リモートからダウンロードされた新しいデータで既存のデータを上書きするかどうかを指定します。 |
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
BatchFTPOverSSL の接続マッププロパティーの「転送後」トピックには、次の表に示す最上位パラメータが含まれています。
表 1–23 接続マップ - BatchFTPOverSSL - 転送後
名前 |
説明 |
必要な値 |
---|---|---|
リモートディレクトリ名 |
ファイルのリネームまたはコピーの実行場所となる、リモート外部システム上のディレクトリの名前 (パス) を指定します。これは、「転送後コマンド」が「リネーム」または「コピー」の場合にのみ使用されます。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 アウトバウンド (宛先) の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ディレクトリ名を意味します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「リモートディレクトリ名がパターン」プロパティーを参照してください。 |
外部システム上のディレクトリ名とパス。 特殊文字を使用できます。 |
リモートディレクトリ名がパターン |
次のように、リモートディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
リモートファイル名 |
ファイルのリネーム先またはコピー先となる、外部システム上のファイルの名前を指定します。この設定は、「転送後コマンド」パラメータが「リネーム」または「コピー」処理の場合にのみ使用されます。 値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ファイル名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「リモートファイル名がパターン」プロパティーを参照してください。 |
ファイル名。 |
リモートファイル名がパターン |
次のように、リモートファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
リモート転送後コマンド |
実際のファイル転送の直後に必要なアクションを実行できるようにします。インバウンド転送の場合にこれを適用すれば、自動バックアップを行う (リネーム) か転送済みのファイルを永続的に破棄する (削除) ことで、そのファイルを「使用済み」としてマークできます。アウトバウンド転送の場合にこれを適用すれば、転送済みのファイルをリネームすることで、ほかのクライアントがそのファイルを使用できるようにすることができます。
|
「リネーム」、「削除」、または「なし」を選択します。 デフォルト設定は「なし」です。 |
ローカルディレクトリ名 |
「リネーム」で使用されるディレクトリ名 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 注 – パス区切り文字については、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 「ローカルディレクトリ名がパターン」プロパティーを参照してください。 |
ローカルディレクトリ名。 |
ローカルディレクトリ名がパターン |
次のように、ローカルディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ローカルファイル名 |
「リネーム」で使用されるファイル名を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 注 – パス区切り文字については、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 「ローカルファイル名がパターン」プロパティーを参照してください。 |
ファイル名。 |
ローカルファイル名がパターン |
次のように、ローカルファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ローカル転送後コマンド |
実際のファイル転送の直後に必要なアクションを実行できるようにします。インバウンド転送の場合、 自動バックアップを行う (リネーム) かターゲットファイルを永続的に破棄する (削除) ことで、そのファイルを「使用済み」としてマークできます。 アウトバウンド転送の場合、ターゲットファイルをリネームすることで、ほかのクライアントからそのファイルを使用できるようにすることができます。オプションは次のとおりです。
|
「リネーム」、「削除」、または「なし」を選択します。 デフォルト設定は「なし」です。 |
BatchFTPOverSSL の接続マッププロパティーの「ファイアウォール設定」トピックには、次の表に示す最上位パラメータが含まれています。
表 1–24 接続マップ - BatchFTPOverSSL - ファイアウォール設定
名前 |
説明 |
必要な値 |
---|---|---|
ファイアウォールを使用 |
ファイアウォールを使用するかどうかを指定します。ファイアウォールを使用する場合、SOCKS 4 と 5 がサポートされます。 |
「はい」または「いいえ」。「はい」は、ファイアウォールを使用することを示します。 デフォルト設定は「いいえ」です。 |
SOCKS バージョン |
ファイアウォールの SOCKS のバージョンを指定します。サポートされるオプションは、SOCKS version 4 を表す「4」と、SOCKS version 5 を表す「5」です。 |
SOCKS version 4 の場合は「4」を、SOCKS version 5 の場合は「5」を、それぞれ選択します。 |
BatchFTPOverSSL の接続マッププロパティーの「同期」トピックには、次の表に示す最上位パラメータが含まれています。
表 1–25 接続マップ - BatchFTPOverSSL - 同期
名前 |
説明 |
必要な値 |
---|---|---|
同期 |
バージョン 5.1 より前のアダプタは同期的に実行されますが、その動作をこのアダプタにシミュレートさせるか、あるいはこのアダプタを並列的に実行するかを指定します。選択肢は次のとおりです。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ここでは、接続マップからアクセスされる BatchInbound アダプタ (OTD) の構成パラメータについて説明します (BatchInbound の環境プロパティーは存在しない)。
BatchInbound の接続マッププロパティーには、次の表に示す最上位パラメータが含まれています。
表 1–26 接続マップ - BatchInbound- 設定
名前 |
説明 |
必要な値 |
---|---|---|
入力ディレクトリ名 (パス) を指定します。 これは、BatchInbound アダプタがトリガーまたはデータファイルを取得するためにポーリングするディレクトリを示します。値としては、リテラルまたは正規表現を指定できます。 注 – パス区切り文字については、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 「ディレクトリ名がパターン」プロパティーを参照してください。 |
ディレクトリ名。 |
|
次のように、ディレクトリ名がリテラルを表すのか、あるいは正規表現を表すのかを指定します。
|
true または false を選択します。 デフォルト設定は false です。 |
|
入力ファイル名を指定します。値としては、リテラルまたは正規表現を指定できます。 「ファイル名がパターン」プロパティーを参照してください。 |
ファイル名。 |
|
次のように、ターゲットファイル名がリテラルを表すか、あるいは正規表現を表すかを指定します。
|
true または false を選択します。 デフォルト設定は true です。 |
|
アダプタが入力ファイルを取得するために入力ディレクトリに対して行う各ポール間のポーリング間隔を、ミリ秒数で指定します。 |
アダプタによるディレクトリのポーリング間の時間の長さをミリ秒数で示す数値。 デフォルト設定は 5000 (つまり 5 秒) です。 |
ここでは、接続マップからアクセスされる BatchLocalFile OTD のプロパティーについて説明します。
BatchLocalFile のプロパティーに含まれるセクションは、次のとおりです。
「ターゲットの場所 (BatchLocalFile の接続マップ)」
これらの設定オプションのいくつかでは、正規表現を使用できます。この拡張機能は便利ですが、注意して使用する必要があります。正規表現の形式が不適切だと、不要なデータが作成されたり、データが失われたりする可能性があります。この機能を使用する前に、正規表現の構文や構成についてよく理解しておく必要があります。そのような設定は、十分にテストを行ったあとで本番環境に移行することをお勧めします。
ここでは、「転送前」パラメータの設定に関する情報を提供します。転送前処理とは、実際のファイル転送の直前に実行される処理のことです。
BatchLocalFile の接続マッププロパティーの「転送前」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–27 接続マップ - BatchLocalFile - 転送前
名前 |
説明 |
必要な値 |
---|---|---|
ファイルのリネームまたはコピーの実行場所となる、外部システム上のディレクトリの名前 (パス) を指定します。この設定は、「転送前コマンド」パラメータが「リネーム」または「コピー」処理の場合にのみ使用されます。値としては、リテラルまたはパターン名を指定できます。 アウトバウンド転送の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ディレクトリ名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。参照してください 注 – パス区切り文字については、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 「転送前ディレクトリ名がパターン」プロパティーを参照してください。 |
ディレクトリの正確な名前 (パスを含む) を入力するか、パターン名を入力するか、あるいは次のいずれかの値を選択します。
|
|
次のように、転送前ディレクトリ名がリテラル、名前パターンのいずれを表しているかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
ファイルのリネーム先またはコピー先となる、外部システム上のファイルの名前を指定します。この設定は、「転送前コマンド」パラメータが「リネーム」または「コピー」処理の場合にのみ使用されます。値としては、リテラルまたはパターン名を指定できます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ファイル名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「転送前ファイル名がパターン」プロパティーを参照してください。 |
ファイルの正確な名前を入力するか、パターン名を入力するか、あるいは次のいずれかの値を選択します。
|
|
次のように、転送前ファイル名がリテラル、名前パターンのいずれを表しているかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
実際のファイル転送の直前に実行されるアクションを決定できるようにします。 インバウンドファイル転送の場合、同じディレクトリおよびファイルのパターンまたは名前を使ってターゲットシステムに対するポーリングを行うほかのクライアントがそのファイルを使用するのを禁止できます。アウトバウンド転送の場合、既存ファイルの自動バックアップを行えます。オプションは次のとおりです。
|
「リネーム」、「コピー」、または「なし」を選択します。デフォルトは「なし」です。 注 – 「転送前ディレクトリ名」および「転送前の名前」パラメータで指定されるファイルまたはディレクトリが存在している場合、「リネーム」および「コピー」はそれを上書きします。 |
BatchLocalFile の接続マッププロパティーの「シーケンス番号」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–28 接続マップ - BatchLocalFile - シーケンス番号
名前 |
説明 |
必要な値 |
---|---|---|
ターゲットファイルの名前にシーケンス番号が含まれるように設定した場合に、このパラメータを使用します。これは、この値 (最大シーケンス番号) に達した際にシーケンス番号を「開始シーケンス番号」の値にリセットするように、アダプタに指示します。 このパラメータは、名前パターン %# で使用されます。 「名前パターンの使用」を参照してください。 |
1 から 2147483647 までの整数。最大シーケンス番号の値は開始シーケンス番号の値よりも大きくなければいけません。 デフォルト設定値は 999999 です。 |
|
ターゲットファイルの名前にシーケンス番号が含まれるように設定した場合に、このパラメータを使用します。これは、前回実行時のシーケンス番号が存在しない場合にどの値から開始するかを、アダプタに指示します。 また、この最大シーケンス番号の値に達すると、シーケンス番号が開始シーケンス番号の値にリセットされます。 このパラメータは、名前パターン %# で使用されます。 |
0 から 2147483647 までの整数。開始シーケンス番号の値は最大シーケンス番号よりも小さくなければいけません。 デフォルト設定値は 1 です。 |
シーケンス番号を使用するには、「一般設定」の下にある「同期」プロパティーを「はい」に設定する必要があります。
BatchLocalFile の接続マッププロパティーの「転送後」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–29 接続マップ - BatchLocalFile - 転送後
名前 |
説明 |
必要な値 |
---|---|---|
ファイルのリネームの実行場所となる、外部システム上のディレクトリの名前 (パス) を指定します。この設定は、「転送後 コマンド」パラメータが「リネーム」処理の場合にのみ使用されます。値としては、リテラルまたはパターン名を指定できます。 アウトバウンド転送の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ディレクトリ名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 注 – パス区切り文字については、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 「転送後ディレクトリ名がパターン」プロパティーを参照してください。 |
ディレクトリの正確な名前 (パスを含む) を入力するか、パターン名を入力するか、あるいは次のいずれかの値を選択します。
|
|
次のように、転送後ディレクトリ名がリテラル、名前パターンのいずれを表しているかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
転送済みファイルのリネーム後のファイル名 (「リネーム」の場合)、ファイルの移動先となるディレクトリ (「移動」の場合) のいずれかを指定しますが、どちらを指定するかは、パラメータ「転送後コマンド」の設定によって決まります。 値としては、リテラルまたはパターン名を指定できます。 特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「転送後ファイル名がパターン」プロパティーを参照してください。 |
ファイルの正確な名前を入力するか、パターン名を入力するか、あるいは次のいずれかの値を選択します。
|
|
次のように、転送後ファイル名がリテラル、名前パターンのいずれを表しているかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
実際のファイル転送の直後に必要なアクションを実行できるようにします。インバウンド転送の場合、自動バックアップを行う (リネーム) か転送済みのファイルを永続的に破棄する (削除) ことで、そのファイルを「使用済み」としてマークできます。アウトバウンド転送の場合、転送済みのファイルをリネームすることで、ほかのクライアントからそのファイルを使用できるようにすることができます。オプションは次のとおりです。
|
「リネーム」、「コピー」、「削除」、または「なし」を選択します。 デフォルト設定は「なし」です。 |
BatchLocalFile の接続マッププロパティーの「一般設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–30 接続マップ - BatchLocalFile - 一般設定
名前 |
説明 |
必要な値 |
---|---|---|
次のように、OTD が読み取りの再開機能を処理するかどうかを指定します。
|
「はい」または「いいえ」 デフォルト設定は「いいえ」です。 注 – 読み取りの再開を使用するには、「同期」を「はい」に設定する必要があります。 |
|
旧バージョンのバッチアダプタプロジェクトだけに適用されます。バージョン 5.0.7 以前のバッチアダプタを使って作成されたプロジェクトを、そのアダプタの動作を変更しないでインポートおよび配備できるようにするための下位互換性を提供します。選択肢は次のとおりです。
|
「はい」または「いいえ」。 デフォルト設定は「はい」ですが、この場合、バージョン 5.0.7 以前のバッチアダプタを使って作成されたプロジェクトがシミュレートされます。 注 – シーケンス番号または読み取りの再開を使用するには、「同期」を「はい」に設定する必要があります。 |
BatchLocalFile の接続マッププロパティーの「ターゲットの場所」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–31 接続マップ - BatchLocalFile - ターゲットの場所
名前 |
説明 |
必要な値 |
---|---|---|
既存ファイルにデータを上書きするか、あるいはデータを追加するかを指定します。このパラメータを使用するのは、アウトバウンドファイル転送の場合だけです。次のように適切な設定を選択します。
|
「はい」または「いいえ」を選択します デフォルト設定は「いいえ」です。 |
|
ファイルの取得元または送信先となる、ローカルシステム上のディレクトリの名前 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 アウトバウンド転送 (宛先) の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。 注 – パス区切り文字については、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 「ターゲットディレクトリ名がパターン」プロパティーを参照してください。 |
ディレクトリ名。 |
|
次のように、ターゲットディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
|
取得または送信対象となる、ローカルシステム上のファイルの名前を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 「ターゲットディレクトリ名がパターン」プロパティーを参照してください。 |
ファイル名。 |
|
次のように、ターゲットファイル名がリテラルを表すか、あるいは正規表現または名前パターンを表すかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ここでは、接続マップからアクセスされる BatchSCP OTD の設定プロパティーについて説明します。
BatchSCP アダプタの接続マッププロパティーに含まれるセクションは、次のとおりです。
BatchSCP の接続マッププロパティーの「SCP 設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–32 接続マップ - BatchSCP - SCP 設定
名前 |
説明 |
必要な値 |
---|---|---|
クライアント認証タイプを指定します。オプションは次のとおりです。
|
「PASSWORD」、「 HOST BASED」、または「PUBLICKEY」を選択します。 デフォルト設定は「PASSWORD」です。 |
|
「はい」または「いいえ」を選択します。 「はい」を選択すると、公開鍵の検証による SSH サーバーの認証が有効になります。 デフォルト設定は「はい」です。 |
||
データの送受信場所となる、SSH サーバー (SFTP サブシステムを含む) 上のディレクトリを指定します。このディレクトリのアクセス可能性は通常、ログインユーザーに依存します。 |
リモートディレクトリ。 |
|
リモートファイル。 |
||
ローカルディレクトリ。 |
||
ローカルファイル |
ローカルファイル。 |
|
「はい」または「いいえ」を選択します。「はい」は、コピーを再帰的に行うことを示します。 デフォルト設定は「いいえ」です。 |
BatchSCP の接続マッププロパティーの「ファイアウォール設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–33 接続マップ - BatchSCP - ファイアウォール設定
名前 |
説明 |
必要な値 |
---|---|---|
「はい」または「いいえ」。 「はい」は、ファイアウォールを使用することを示します。 デフォルト設定は「いいえ」です。 |
||
ファイアウォールが必要とする SOCKS のバージョンを指定します。サポートされるオプションは、SOCKS version 4 を表す「4」と、SOCKS version 5 を表す「5」です。 |
SOCKS version 4 の場合は「4」を、SOCKS version 5 の場合は「5」を、それぞれ選択します。 デフォルト設定は 5 です。 |
BatchSCP の接続マッププロパティーの「同期」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–34 接続マップ - BatchSCP - 同期
名前 |
説明 |
必要な値 |
---|---|---|
バージョン 5.1 より前のアダプタは同期的に実行されますが、その動作をこのアダプタにシミュレートさせるか、あるいはこのアダプタを並列的に実行するかを指定します。選択肢は次のとおりです。
|
「はい」または「いいえ」。 デフォルト設定は、「いいえ」です。 |
ここでは、接続マップからアクセスされる BatchSFTP OTD の設定プロパティーについて説明します。
BatchSFTP アダプタの接続マッププロパティーに含まれるセクションは、次のとおりです。
「転送前」プロパティーでは、保護/バックアップ/復旧の動作をカスタマイズできます。ここでは、実際のファイル転送の前にリモートまたはローカルで実行される処理について説明します。
BatchSFTP の接続マッププロパティーの「転送前」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–35 接続マップ - BatchSFTP - 転送前
名前 |
説明 |
必要な値 |
---|---|---|
リモートディレクトリ名 |
ファイルのリネームまたはコピーの実行場所となる、リモート外部システム上のディレクトリの名前 (パス) を指定します。これは、「リモート転送前コマンド」が「リネーム」または「コピー」の場合にのみ使用されます。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 アウトバウンド (宛先) の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。 特殊文字を使用できます。このパラメータが使用されるたびに、 あらゆる特殊文字の展開 が実行されます。たとえば、パターン %f は元の作業ディレクトリ名を意味します。 「リモートディレクトリ名がパターン」プロパティーを参照してください。 |
ディレクトリ名。 |
リモートディレクトリ名がパターン |
次のように、リモートディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
リモートファイル名 |
ファイルのリネーム先またはコピー先となる、外部システム上のファイルの名前を指定します。この設定は、「転送前コマンド」パラメータが「リネーム」または「コピー」処理の場合にのみ使用されます。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ファイル名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「リモートファイル名がパターン」プロパティーを参照してください。 |
ファイル名。 |
リモートファイル名がパターン |
次のように、リモートファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
リモート転送前コマンド |
実際のファイル転送の直前に必要なアクションを実行できるようにします。インバウンド転送の場合、同じディレクトリおよびファイルのパターンまたは名前を使ってターゲットシステムに対するポーリングを行うほかのクライアントがそのファイルを使用するのを禁止できます。アウトバウンド転送の場合、既存のファイルを自動的にバックアップ/クリーンアップできます。オプションは次のとおりです。
|
「リネーム」、「コピー」、または「なし」を選択します。 デフォルト設定は「なし」です。 注 – 「コピー」オプションを使用すると、コピーするファイルのサイズが大きい場合は特に、システムのパフォーマンスが低下する可能性があります。 |
ローカルディレクトリ名 |
「リネーム」または「コピー」で使用されるローカルディレクトリ名 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「ローカルディレクトリ名がパターン」プロパティーを参照してください。 注 – パス区切り文字を入力する際には、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 |
ディレクトリ名。 |
ローカルディレクトリ名がパターン |
次のように、ローカルディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ローカルファイル名 |
「リネーム」または「コピー」で使用されるローカルファイル名を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「ローカルファイル名がパターン」プロパティーを参照してください。 |
ファイル名。 |
ローカルファイル名がパターン |
リテラルを表すか、あるいは正規表現または名前パターンを表すかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ローカル転送前コマンド |
実際のファイル転送の直前に必要なアクションを実行できるようにします。インバウンド転送の場合、同じディレクトリおよびファイルのパターンまたは名前を使ってターゲットシステムに対するポーリングを行うほかのクライアントがそのファイルを使用するのを禁止できます。アウトバウンド転送の場合、既存のファイルを自動的にバックアップできます。オプションは次のとおりです。
|
「リネーム」、「コピー」、または「なし」を選択します。 デフォルト設定は「なし」です。 注 – 「コピー」オプションを使用すると、コピーするファイルのサイズが大きい場合は特に、システムのパフォーマンスが低下する可能性があります。 |
BatchSFTP の接続マッププロパティーの「SFTP 設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–36 接続マップ - BatchSFTP - SFTP 設定
名前 |
説明 |
必要な値 |
---|---|---|
転送の形式がバイナリコード、ASCII テキストのいずれであるかを指定します。 |
「BINARY」または「ASCII」を選択します。 デフォルト設定は「Binary」です。 |
|
「CR」、「LF」、または「CRLF」を選択します。 「CRLF」がデフォルト設定になります。 |
||
ファイル転送時に使用されるブロックサイズを指定します。デフォルトを増やさないでください。リモートサーバーがデフォルトよりも大きなブロックサイズをサポートできない可能性があるからです。 |
ファイル転送時に使用されるブロックサイズを示す整数。 デフォルト設定は 32768 です。 |
|
ローカル読み取りバッファーのサイズ (バイト) を示す整数。値 -1 は、ローカルファイルの全体が一度に読み取られることを示します。 |
||
クライアント認証タイプを指定します。オプションは次のとおりです。
|
「PASSWORD」、「 HOST BASED」、または「PUBLICKEY」を選択します。 デフォルト設定は「PASSWORD」です。 |
|
「はい」または「いいえ」を選択します。「はい」を選択すると、公開鍵の検証による SSH サーバーの認証が有効になります。 デフォルト設定は「はい」です。 |
||
データの送受信場所となる、SSH サーバー (SFTP サブシステムを含む) 上のディレクトリ名 (パス) を指定します。このディレクトリのアクセス可能性は通常、ログインユーザーに依存します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 「リモートディレクトリ名がパターン」プロパティーを参照してください。 |
リモートディレクトリ名。 |
|
次のように、リモートディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
リモートサーバー上のファイルの名前を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 「リモートファイル名がパターン」プロパティーを参照してください。 |
リモートファイル。 |
|
次のように、リモートファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
リモートサーバー上のファイルを送受信するためのローカルディレクトリ名 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 「ローカルディレクトリ名がパターン」プロパティーを参照してください。 |
ローカルディレクトリ。 |
|
次のように、「ローカルディレクトリ名」プロパティーの意味を指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
|
リモートサーバー上で送受信されるローカルファイルを指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 「ローカルファイル名がパターン」プロパティーを参照してください。 |
ローカルファイル。 |
|
次のように、ローカルファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
BatchSFTP の接続マッププロパティーの「転送後」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–37 接続マップ - BatchSFTP - 転送後
名前 |
説明 |
必要な値 |
---|---|---|
リモートディレクトリ名 |
ファイルのリネームまたはコピーの実行場所となる、リモートシステム上のディレクトリの名前 (パス) を指定します。これは、「転送後コマンド」が「リネーム」または「コピー」の場合にのみ使用されます。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 アウトバウンド (宛先) の場合、ディレクトリがまだ存在していなければ、ディレクトリが作成されます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ディレクトリ名を意味します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「リモートディレクトリ名がパターン」プロパティーを参照してください。 |
ディレクトリ名。 |
リモートディレクトリ名がパターン |
次のように、リモートディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
リモートファイル名 |
外部システム上のファイル名を指定します。この設定は、「転送後コマンド」パラメータが「リネーム」または「コピー」処理の場合にのみ使用されます。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 特殊文字を使用できます。たとえば、パターン %f は元の作業ファイル名を示します。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「リモートファイル名がパターン」プロパティーを参照してください。 |
ファイル名。 |
リモートファイル名がパターン |
次のように、リモートファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「はい」です。 |
リモート転送後コマンド |
実際のファイル転送の直後に必要なアクションを実行できるようにします。インバウンド転送の場合にこれを適用すれば、自動バックアップを行う (リネーム) か転送済みのファイルを永続的に破棄する (削除) ことで、そのファイルを「使用済み」としてマークできます。アウトバウンド転送の場合にこれを適用すれば、転送済みのファイルをリネームすることで、ほかのクライアントがそのファイルを使用できるようにすることができます。
|
「リネーム」、「削除」、または「なし」を選択します。 デフォルト設定は「なし」です。 |
ローカルディレクトリ名 |
「リネーム」で使用されるローカルディレクトリ名 (パス) を指定します。値としては、リテラル、正規表現 (ソースの場合)、またはパターン名 (宛先の場合) を指定できます。 特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 が実行されます。 「ローカルディレクトリ名がパターン」プロパティーを参照してください。 パス区切り文字を入力する際には、バックスラッシュ「\」の代わりにスラッシュ「/」を使用してください。アダプタは、バックスラッシュを特殊文字として解釈します。たとえば、c:/temp/dir を使用します。 |
ディレクトリ名。 |
ローカルディレクトリ名がパターン |
次のように、ローカルディレクトリ名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。デフォルト設定は「いいえ」です。 |
ローカルファイル名 |
「リネーム」で使用されるローカルファイル名を指定します。値としては、リテラル、正規表現 (受信時)、またはパターン名 (送信時) を指定できます。 特殊文字を使用できます。このパラメータが使用されるたびに、あらゆる特殊文字の展開が実行されます。 「ローカルファイル名がパターン」プロパティーを参照してください。 |
ファイル名。 |
ローカルファイル名がパターン |
次のように、ローカルファイル名がリテラルを表すのか、あるいは正規表現または名前パターンを表すのかを指定します。
|
「はい」または「いいえ」を選択します。 デフォルト設定は「いいえ」です。 |
ローカル転送後コマンド |
実際のファイル転送の直後に必要なアクションを実行できるようにします。インバウンド転送の場合、 自動バックアップを行う (リネーム) かターゲットファイルを永続的に破棄する (削除) ことで、そのファイルを「使用済み」としてマークできます。 アウトバウンド転送の場合、ターゲットファイルをリネームすることで、ほかのクライアントからそのファイルを使用できるようにすることができます。オプションは次のとおりです。
|
「リネーム」、「削除」、または「なし」を選択します。 デフォルト設定は「なし」です。 |
BatchSFTP の接続マッププロパティーの「ファイアウォール設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–38 接続マップ - BatchSFTP - ファイアウォール設定
名前 |
説明 |
必要な値 |
---|---|---|
「はい」または「いいえ」を選択します。 「はい」は、ファイアウォールを使用することを示します。 デフォルト設定は「いいえ」です。 |
||
ファイアウォールの SOCKS のバージョンを指定します。サポートされるオプションは、SOCKS version 4 を表す「4」と、SOCKS version 5 を表す「5」です。 |
SOCKS version 4 の場合は「4」を、SOCKS version 5 の場合は「5」を、それぞれ選択します。 デフォルト設定は 5 です。 |
BatchSFTP の接続マッププロパティーの「同期」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–39 接続マップ - BatchSFTP - 同期
名前 |
説明 |
必要な値 |
---|---|---|
バージョン 5.1 より前のアダプタは同期的に実行されますが、その動作をこのアダプタにシミュレートさせるか、あるいはこのアダプタを並列的に実行するかを指定します。選択肢は次のとおりです。
|
「はい」または「いいえ」を選択します。 デフォルト設定は、「いいえ」です。 |
接続マップからアクセスされる CICS アダプタの構成パラメータは、次の各セクションに編成されています。
CICS の接続マッププロパティーの「コネクタ」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–40 接続マップ - コネクタのプロパティー
名前 |
説明 |
必要な値 |
---|---|---|
コネクタのタイプを指定します。 |
「CICS」と入力します。. CICS 接続の場合、デフォルト値は常に「CICS」になります。 |
|
CICS アダプタが CICS 領域への要求の送信、および CICS 領域からの応答の取得を行う際に使用する配下の接続トランスポートを指定します。 |
次に示す配下の接続トランスポートのいずれかを選択します。 Sun CICS Listener CICS Transaction Gateway (IBM CICS Transaction Gateway を指定) 「Sun CICS Listener」がデフォルト設定になります。 |
|
CICS クライアントコネクタオブジェクトのクラス名を指定します。 |
CICS クライアントコネクタオブジェクトの (クラス) パッケージ名。デフォルトは「com.stc.adapters.cics.CicsClientConnector」です。 |
|
データソースのアイデンティティーを指定します。このパラメータは、現在の EBobConnectorFactory によって必要とされています。 |
データソースのパッケージ名。 |
CICS の接続マッププロパティーの「CICS クライアント」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–41 「CICS クライアント」接続マッププロパティー
名前 |
説明 |
必要な値 |
---|---|---|
ECI 呼び出しタイプが「同期」かどうかを指定します。同期呼び出しは、トランザクションが完了するまで待機したあと、COMMAREA の内容を返します。サポートされているのは同期呼び出しだけです。 |
「同期」がデフォルト設定になります。 |
|
サーバー上で実行される CICS プログラムを指定します。最大長は 8 文字です。 |
8 文字以下の CICS プログラム名。 |
|
CTG に固有です。CICS トランザクションの ID を指定します。最大長は 4 文字です。属性は次のように、「トランザクション ID を ECI_TPN として使用」で設定される値によって異なります。 「EciTPN」が false に設定されている場合、トランザクション ID の値は、プログラムパラメータで指定されたプログラムへのリンクが持続している間、EIBTRNID 内に格納されます。呼び出されたプログラムは、ミラートランザクション CPMI の下で実行されますが、トランザクション ID のトランザクション名の配下にリンクされます。呼び出されたプログラムは、トランザクション ID のクエリーを行う際にこの名前を使用できます。一部のサーバーはトランザクション ID に基づいて、呼び出されたプログラムのセキュリティー属性やパフォーマンス属性を決定します。 「EciTPN」が true に設定されている場合、トランザクション ID は ECI_TPN トランザクション ID として解釈されます。これは、サーバー内で ECI 要求を処理するために使用されるトランザクションです。このトランザクションは、サーバー内で CICS ミラートランザクションとして定義される必要があります。ECI 要求が拡張される場合、このパラメータが意味を持つのは最初の要求に対してだけです。 |
4 文字以下の CICS トランザクション ID。 |
|
CTG に固有です。トランザクション ID が ECI_TPN として解釈されるか、あるいは呼び出されたプログラムがデフォルトミラートランザクション CPMI の下で実行されるかを指定します。オプションは次のとおりです。 true: トランザクション ID が ECI_TPN として解釈されることを示します。 false: 呼び出されたプログラムが、デフォルトミラートランザクション CPMI の下で実行され、トランザクション ID が存在する場合にその配下にリンクされることを示します。 |
true または false を選択します。false がデフォルト設定になります。 |
|
ECI に渡される COMMAREA の長さ (バイト) を指定します。 |
COMMAREA のバイト長を示す数値。 注 – CICS Transaction Gateway トランスポートを使用する場合、CICS に送信されるデータは、フルサイズの COMMAREA に一致するように、必要に応じて空白で埋める必要があります。 |
|
呼び出しの最後で作業論理単位が終了されるかどうかを指定します。 |
「はい」または「いいえ」。 「はい」は、呼び出しの最後で作業単位が終了されることを示します。 デフォルト設定は「いいえ」です。 |
|
CTG に固有です。呼び出しの所属先となる作業論理単位 (LUW) の識別に使用される整数を指定します。LUW を拡張する場合でも、LUW の開始時にこれを 0 (ゼロ) に設定する必要があります。ECI はこの値を、LUW の最初の (または唯一の) 呼び出しが発生した際に更新します。LUW を拡張する場合、この値は、同じ LUW に関連付けられた後続のすべての呼び出しへの入力として使用されます。 リターンコードが ECI_NO_ERROR でなく、かつ呼び出しが既存の LUW を終了または継続させる場合には、次のようにこのフィールドを使って LUW の状態の報告が行われます。
|
ECI 作業論理単位の識別に使用される整数。 |
|
エンコーディングセットの正規名を指定します。 |
Sun の Java Runtime Environment 1.1.8 によってサポートされる任意のエンコーディングセット (rt.jar および i18n.jar 内に含まれる) の正規名。例としては、「ASCII」や「Cp500」 (EBCDIC) などが挙げられます。CICS アダプタを z/OS プラットフォーム上で実行している場合は、「エンコード」の値を「Cp500」に設定してください。 |
CICS の接続マッププロパティーの「接続モード」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–42 接続マッププロパティー - 「接続モード」セクション
名前 |
説明 |
必要な値 |
---|---|---|
外部接続をインスタンス化する際に物理的な接続を確立するかどうかを指定します。オプションは次のとおりです。 自動: 外部接続をインスタンス化する際に物理的な接続を確立します。 手動: 外部接続をインスタンス化する際に物理的な接続を自動的に確立しません。 物理的な接続が自動的に確立されない場合には、コラボレーションから (connect() メソッドを呼び出すなどして) 物理的な接続を確立する必要があります。 |
「自動」または「手動」。デフォルト設定は「自動」です。 |
接続マップからアクセスされる e-Mail アダプタの構成パラメータは、次の各セクションに編成されています。
一部の e-Mail アダプタプロパティーは、コラボレーションからも設定できます。コラボレーションから設定されたプロパティーは、アダプタの設定ファイル内の対応するプロパティーを上書きします。コラボレーションから設定されないすべてのプロパティーでは、そのデフォルト設定が保持されます。
e-Mail アダプタの接続マッププロパティーの「ポーリング設定」セクションには、表 1–43 に示す最上位パラメータが含まれています。
表 1–43 接続マップ - ポーリング設定
名前 |
説明 |
必要な値 |
---|---|---|
e-Mail ソースファイルのポーリングを行なって新しい受信 e-Mail メッセージの有無を確認する間隔 (ミリ秒) を指定します。 |
ポーリング間隔をミリ秒で示す数値。 デフォルト設定は 5000 (5 秒) です。 |
接続マップからアクセスされるインバウンドファイルアダプタの設定プロパティーは、次の各セクションに編成されています。
インバウンドファイルアダプタの接続マッププロパティーの「パラメータ設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–44 インバウンドファイルアダプタの接続マッププロパティー - パラメータ設定
名前 |
説明 |
必要な値 |
---|---|---|
入力ファイル名 |
ファイルマスク。デフォルトは「input*.txt」です。*.txt のように拡張子とアスタリスク (*) のみを指定すれば、その拡張子を持つすべてのファイルを許可できます。ある入力ファイルが取得されると、その入力ファイルの拡張子が.~in に変更されます。 注 – input1.txt.~in など、リネーム名と同じ名前のファイルが存在していると、入力ファイルの取得に失敗します。ファイルがインバウンドファイルポーラーによって処理される前に、リネーム名を持つファイルが存在しないことを確認する必要があります。 |
|
ポーリング間隔 |
入力ディレクトリに対する複数のポーリング試行間でアダプタが待機するミリ秒数。 受信メッセージの予期されるボリュームや頻度に基づいて、ポーリング間隔と MDB プールサイズを「調整」することができます。 |
整数。指定可能な範囲は 2 から 99999 までの整数 (両端を含む) であり、デフォルトは 5000 (5000 ミリ秒つまり 5 秒) です。 5 秒未満の値を入力することはお勧めできません。 ![]() 不正な値を入力しても、エラーメッセージは表示されません。 |
入力タイプ |
ファイルのタイプ。デフォルトは、唯一の有効な値である「バイト」です。 |
|
EOL を削除 |
アダプタが、サブスクライバに送信されるレコード( メッセージ) から末尾の End-Of-Line (EOL) 文字を除外するかどうかを指定します。このプロパティーが適用されるのは、「ファイルごとに複数レコード」プロパティーが true に設定されている場合だけです。 |
true または false
|
ファイルごとに複数レコード |
ファイルごとに複数のレコード (メッセージ) を取得するかどうかを指定します。このプロパティーが true に設定されていると、「1 レコードあたりの最大バイト数」プロパティーに指定されたバイト数まで、行ごとに複数のレコード (メッセージ) が生成されます。1 レコードあたりの最大バイト数のサイズを超えたデータはすべて、後続のメッセージとして送信されます。 |
true または false。
|
1 レコードあたりの最大バイト数 |
サブスクライバに送信されるレコード (メッセージ) ごとの最大バイト数を指定します。このプロパティーが適用されるのは、「ファイルごとに複数レコード」プロパティーが true に設定されている場合だけです。 |
整数。指定可能な範囲は 2 から 99999 までの整数 (両端を含む) であり、デフォルトは 4096 です。 ![]() 不正な値を入力しても、エラーメッセージは表示されません。 |
エンコード |
有効なエンコーディング名を指定します。Java のエンコーディングの詳細については、次のサイトを参照してください。 http://java.sun.com/j2se/1.3/ja/docs/ja/api/java/lang/package-summary.html |
エンコーディング名。 |
シリアルモード |
メッセージがシリアルモードで (一度に 1 つずつ) 処理されるか、あるいは並行的に処理されるかを指定します。 |
true または false。
|
接続マップからアクセスされるアウトバウンドファイルアダプタの設定プロパティーは、次の各セクションに編成されています。
アウトバウンドファイルアダプタの接続マッププロパティーの「パラメータ設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–45 アウトバウンドファイルアダプタの接続マッププロパティー - パラメータ設定
名前 |
説明 |
必要な値 |
---|---|---|
出力ファイル名 |
適切なファイル名。デフォルトは「output%d.dat」です。ファイル名に含まれる %d はカウンタであり、新しいファイルごとに増分されます。 %d の代わりに、整数か long 値を取るその他の任意の printf スタイルを使用できます。たとえば、1%d や %012d などを指定できます 「ファイルごとに複数レコード」プロパティーが false に設定されていると、次のようになります。
|
|
EOL を追加 |
アダプタが出力ファイルに送信する各レコードにシステムが行末文字を追加するかどうかを指定します。 |
true または false。
|
ファイルごとに複数レコード |
出力ファイルに複数のレコード (メッセージ) を書き込めるかどうかを指定します。新しいメッセージは出力ファイルの末尾に追加されます。 |
true または false。
|
エンコード |
有効なエンコーディング名を指定します。有効なすべてのエンコーディングを確認するには、次のサイトを参照してください。http://java.sun.com/j2se/1.3/ja/docs/ja/api/java/lang/package-summary.html |
エンコーディング名。 |
HTTPS アダプタの接続マップは次のカテゴリから構成されています。
HTTPS アダプタのプロパティーには、外部システムが使用するパラメータが含まれます。
表 1–46 HTTP アダプタ — HTTP 設定
名前 |
説明 |
必要な値 |
---|---|---|
Cookie を許可 |
サーバーから送信されてきた Cookie を格納したり、後続の要求受信時にその Cookie を送信したりできるようにするかどうかを指定します。Cookie を許可しないとセッションがサポートされません。 |
true または false。デフォルトは true です。 |
受け付けタイプ |
サーバーへの要求送信時に含める、受け付けタイプヘッダーのデフォルトの値。 |
文字列。次に例を示します。 text/html、text/plain、text/xml など。 デフォルトは「text/*」です。 |
HTTPS サーバーアダプタのプロパティーには、外部システムが使用するパラメータが含まれます。
表 1–47 HTTP サーバーアダプタ — HTTP サーバー外部設定
名前 |
説明 |
必要な値 |
---|---|---|
servlet-url |
HTTPS サーバーサーブレット URL の最後のパス要素を指定します。クライアントはこの URL 値を使ってサーバーにアクセスします。 このプロパティー値は、HttpServerServlet などのサーブレット名である必要があります。有効なサーブレット URL の例として、http://localhost:18001/Deployment1_servlet_HttpServerServlet/HttpServerServlet が挙げられます。この場合、URL 値は次のようないくつかの要素から構成されています。
|
有効な URL。 |
接続マップからアクセスされる IMS アダプタの設定プロパティーは、次のセクションに編成されています。
接続マップからアクセスされるアウトバウンド設定プロパティーは、次の各セクションに編成されています
「コネクタ」セクションには、次の表に含まれる最上位パラメータが含まれています。
表 1–48 IMS アダプタの「コネクタ」パラメータ設定
名前 |
説明 |
必要な値 |
---|---|---|
コネクタのタイプを指定します。 |
IMSClientETD 接続の場合はデフォルトで IMSClientETD。 |
|
ETD コネクタオブジェクトのクラス名を指定します。 |
有効なパッケージ名。デフォルトは「com.stc.adapters.ims.IMSClientETDConnector」です。 |
「接続モード」セクションには、次の表に含まれる最上位パラメータが含まれています。
表 1–49 IMS アダプタの「接続モード」パラメータ設定
名前 |
説明 |
必要な値 |
---|---|---|
IMS 接続モード |
外部システムとの接続の確立とクローズを行う方法を指定します。
|
「手動」、「自動」のいずれかの設定。デフォルト設定は「手動」です。 |
接続マップからアクセスされる LDAP アダプタの構成パラメータは、次の各セクションに編成されています。
LDAP アダプタの「コネクタ」セクションのプロパティーには、次のパラメータが含まれています。
表 1–50 LDAP アダプタ — 「コネクタ」設定
名前 |
説明 |
必要な値 |
---|---|---|
コネクタタイプ |
コネクタのタイプを表示します |
デフォルトは「LDAP コネクタ」です。 |
コネクタクラス |
コネクタクラスを表示します。 |
デフォルトのコネクタクラスは、com.stc.connector.ldapadapter.LDAPadapterConnection です。 |
LDAP アダプタの「接続」セクションのプロパティーを使えば、LDAP システムへの接続を定義できます。
表 1–51 LDAP アダプタ — 「接続」設定
名前 |
説明 |
必要な値 |
|
---|---|---|---|
認証 |
使用する認証 (「なし」または「シンプル」) を選択できるようにします。次のように目的の認証を選択します。
|
「なし」または「シンプル」を選択します。デフォルトは「なし」です。 |
|
資格 |
匿名ログイン (「認証」が「なし」の場合) 以外の認証機構を使用する際に必要となる資格を入力できるようにします。 |
有効なパスワードとしての適切な資格。 |
|
初期コンテキストファクトリ |
LDAP サーバーの初期コンテキストを作成するために使用されるファクトリを入力できるようにします。デフォルトでは、Sun が Java Software Developers’ Kit (SDK) の一部として提供する LDAP サービスプロバイダが使用されます。 |
有効な Java ファクトリ名。デフォルトは次のとおりです。 com.sun.jndi.ldap.LdapCtxFactory。 Sun が提供する LDAP サービスプロバイダ以外のプロバイダを使用する必要がある場合を除き、この値を変更しないことをお勧めします。 |
|
主体 |
匿名ログイン (「認証」が「なし」の場合) 以外の認証機構を使用する際に必要となる主体を指定できるようにします。 |
ユーザーの完全修飾識別名 (DN)。次に例を示します。
|
|
プロバイダ URL |
LDAP サーバーの URL を指定できるようにします。 |
有効な URL。プロトコルとして ldap を含めます。 |
LDAP アダプタの「リフェラル」セクションのプロパティーを使えば、LDAP リフェラル情報を入力できます。
表 1–52 LDAP アダプタ — 「リフェラル」設定
名前 |
説明 |
必要な値 |
---|---|---|
資格 |
ディレクトリで任意のリフェラルを追跡する際に使用する資格ファイルを指定できるようにします。資格ファイルは RCF コマンド行ユーティリティーを使って作成されます。 |
サービスバスから使用できる有効なファイルとパス名。 |
追跡 |
LDAP サーバーから返されたリフェラルを追跡する必要があるかどうかを選択できるようにします。 |
「はい」または「いいえ」を選択します。デフォルトは「はい」です。次のように目的の値を入力します。
|
次に、「リフェラル」セクションに含まれるプロパティーに関する追加の注意事項を示します。
リフェラルとは、クライアントの要求を別のサーバーにリダイレクトするために使用される構成要素のことです。リフェラルには、ほかのオブジェクトの名前と場所が含まれます。これは、クライアントから要求された情報が 1 つ以上の別の場所、おそらく 1 つ以上の別のサーバー上に存在していることを示すために、サーバーによって送信されます。
検索処理を実行すると、リフェラルエントリが検出される可能性がありますが、このエントリは、その情報が格納されている場所へのポインタにすぎません。このポインタの形式は通常、このアダプタの「プロバイダ URL」設定と似たものになります。その構成要素は次のとおりです。
ホスト名
ポート番号
コンテキスト名 (省略可能)
リフェラル検出時の選択肢は、次のとおりです。
無視: リフェラルを無視します。
追跡: リフェラルを追跡します。つまり、参照先のシステムに接続し、検索処理を続行します。
スロー: リフェラル例外をスローします。クライアントからこの例外をキャッチし、必要に応じてアクションを実行することができます。
LDAP アダプタで、リフェラル使用時に設定する必要のあるプロパティーは、次のとおりです。
資格ファイル: ファイルへの完全修飾パスを入力します。このファイルには、適切なリフェラル資格情報が含まれている必要があります (このファイルは RCF コマンド行ユーティリティーを使って生成する必要があるが、これについてはこのセクションの後の方で説明する)。
追跡: 「はい」または「いいえ」。 デフォルトは「はい」です。
次の表に示す各シナリオが発生する可能性がありますが、どのシナリオが発生するかは、リフェラル用に指定されたプロパティーとアダプタの動作に依存します。それらについて、シナリオごとに説明します。
表 1–53 リフェラルのシナリオ
「追跡」の設定 |
資格ファイル |
アダプタの動作 |
---|---|---|
「追跡」が「はい」に設定されている。 |
資格ファイルが提供されていない。 |
アダプタは、初期サーバーで入力された元の資格 (ユーザー名とパスワード) を使用して、参照先システムへの接続を試みます。参照先システムが同じ資格を持たない場合、接続が失敗する可能性があります。 |
資格ファイルが提供され、そのファイル内に参照先ホストの資格エントリが含まれている。 |
リフェラル検出時に LdapReferralException をスローするように、初期サーバーへの接続が設定されます。この例外はその後、アダプタによってキャッチされます。続いて、アダプタは、資格ファイル内に指定された資格情報を使って参照先システムへの接続を確立します。 |
|
提供された資格ファイル内に、参照先ホストの資格エントリが含まれていない。 |
リフェラル検出時に LdapReferralException をスローするように、初期サーバーへの接続が設定されます。この例外はその後、アダプタによってキャッチされます。続いて、アダプタは、匿名ログインを使って参照先システムへの接続を確立します。参照先システムが匿名ログインを許可していない場合、接続が失敗する可能性があります。 |
|
「追跡」が「いいえ」に設定されている。 |
資格ファイルが存在しない。 |
リフェラルは追跡されません。つまり、アダプタはリフェラルを無視します。 |
資格ファイルを作成するには、RCF (Referral Credentials File) コマンド行ユーティリティーを使用できます。
コマンド行からパラメータを 1 つも指定しないで RCF ユーティリティーを実行すると、ユーティリティーの使用方法が表示されます。
RCF ユーティリティーで使用されるファイルは、次の場所に格納されています。
netbeans_home\usrdir\modules\ext\ldapadapter\stcldap13.jar |
または
<netbeans_home>\usrdir\modules\ext\ldapadapter\ stcldap14.jar |
上記ファイルのいずれかをあるフォルダにコピー & ペーストし、そのフォルダから次のようにしてユーティリティーを実行します。
netbeans_home\jdk\bin\java -cp ./stcldap13.jar com.stc.connector.ldapadapter.utils.RCFUtil |
次のメニューが表示されます。
C:\temp>java -cp ./stcldap13.jar com.stc.connector.ldapadapter.utils.RCFUtil Please specify the operation. ---+ RCFUtil +--- Interactive command line utility for creating and managing file(s) containing credentials information to follow LDAP referrals. File(s) generated can be used by the Java LDAP Adapter for following referrals that required credentials different from those used to create the connection to the initial LDAP server. Usage : java com.stc.connector.ldapadapter.utils.RCFUtilOPTIONS -- <filename> OPTIONS: --create Create a new referral credentials file. --add Add an entry to the referral credentials file. --list Print a list of entries in the referral credentials file. --remove Remove an entry from the referral credentials file. --modify Modify an entry in the referral credentials file. --decrypt When displaying credentials, decrypt the credentials. --username <username> Specify the username; if not specified, it’ll be prompted. --password <password> Specify the password; if not specified, it’ll be prompted. --help Print this usage. filename: The full path to the referral credentials file. |
samplercf.txt という名前の新しいリフェラルファイルを作成するには、コマンド行で次のパラメータを入力します。
netbeans_home\jdk\bin\java -cp ./stcldap13.jar com.stc.connector.ldapadapter.utils.RCFUtil --create -- samplercf.txt |
すると、ユーザー名とパスワードが要求されます。ユーザー名とパスワードを入力します。このユーザー名とパスワードは、ファイル自体を保護するためのものです。というのも、このファイルには、ほかの LDAP サーバーに関する機密性の高い資格情報が含まれているからです。次に例を示します。
C:\temp>c:\JavaCAPS6\netbeans\jdk\bin\java -cp .\stcldap13.jar com.stc.connector.ldapadapter. utils.RCFUtil --create -- samplercf.txt Creating file samplercf.txt... Enter username >> test Enter password >> test File created! |
「File created!」というメッセージが表示されます。この場合のファイル名は、samplercf.txt です。拡張子は何でもかまいません。
samplercf.txt という名前のリフェラルファイルに LDAP サーバー接続情報を追加するには、コマンド行で次のパラメータを入力します。
netbeans_home\jdk\bin\java -cp ./stcldap13.jar com.stc.connector.ldapadapter.utils.RCFUtil --add -- samplercf.txt |
ファイルにアクセスするには、ユーザー名とパスワードが必要になります。以前にファイルを作成する際に指定したユーザー名とパスワードを入力します。
次のプロンプトが表示されたら、次の情報を指示どおりに入力します。
ホスト名のプロンプト: ホスト名を入力します。
ポート番号のプロンプト: LDAP ポート番号を入力します。
主体のプロンプト: ユーザーの完全修飾 DN を入力します。
パスワードのプロンプト: 以前に指定した、DN のパスワードを入力します。
次に例を示します。
C:\temp>c:\JavaCAPS6\netbeans\jdk\bin\java -cp .\stcldap13.jar com.stc.connector.ldapadapter.utils.RCFUtil --add -- samplercf.txt Adding a referral credentials entry... Enter username >> test Enter password >> test Enter LDAP Host >> localhost.stc.com Enter LDAP Port >> 389 Enter the Principal >> cn=Manager,dc=stc,dc=com Enter the Credentials >> secret Done. |
「samplercf.txt」という名前のリフェラルファイル内の LDAP サーバー接続情報を表示するには、コマンド行で次のパラメータを入力します。
<netbeans_home>\jdk\bin\java -cp ./stcldap13.jar com.stc.connector.ldapadapter.utils.RCFUtil --list -- samplercf.txt |
ファイルにアクセスするには、ユーザー名とパスワードが必要になります。以前にファイルを作成する際に指定したユーザー名とパスワードを入力します。
次の単一エントリの例に示すように、ファイル内のエントリが一覧表示されます。
1> localhost.stc.com | 389 | cn=Manager,dc=stc,dc=com | l/ ZRt1cfNKc= |
パスワードは暗号化されています。パスワードを復号化された形式で表示するには、1 つ前のコマンドに --decrypt を追加します。出力は次のようになります。
1> localhost.stc.com | 389 | cn=Manager,dc=stc,dc=com | secret |
次に例を示します。
C:\temp>c:\JavaCAPS6\netbeans\jdk\bin\java -cp .\stcldap13.jar com.stc.connector.ldapadapter.utils.RCFUtil --list -- samplercf.txt Listing entries in the referral credentials file... Enter username >> test Enter password >> test 1> localhost.stc.com | 389 | cn=Manager,dc=stc,dc=com | l/ ZRt1cfNKc= C:\temp>c:\JavaCAPS6\netbeans\jdk\bin\java -cp .\stcldap13.jar com.stc.connector.ldapadapter.utils.RCFUtil --list --decrypt -- samplercf.txt Listing entries in the referral credentials file... Enter username >> test Enter password >> test 1> localhost.stc.com | 389 | cn=Manager,dc=stc,dc=com | secret |
資格エントリの削除や資格エントリの変更といったその他の操作も、RCF ユーティリティーを使って同様に行えます。
次の例は、説明用のコメント付きで、資格ファイル samplercf.txt の内容を示したものです。
###This properties file was generated by #com.stc.connector.ldapadapter.utils.RCFUtil. #Do NOT modify this file "by hand" if you don’t understand the nature #or format of this file. Use the utility to create and #manage this file. # #Tue Feb 14 17:49:17 PST 2006 password=P9He6eCUY6Q\= localhost.stc.com\:389=test;P9He6eCUY6Q\= username=test #New credentials entry that was created. |
LDAP アダプタの「セキュリティー/SSL」セクションのプロパティーは、SSL の基本的なセキュリティー機能を設定するために使用されます。
表 1–54 LDAP アダプタ — 「セキュリティー/SSL」設定
名前 |
説明 |
必要な値 |
||
---|---|---|---|---|
JSSE プロバイダクラス |
JSSE プロバイダクラスの完全修飾名を指定します。詳細については、Sun Microsystems の次の Java サイトを参照してください。 |
有効な JSSE プロバイダクラスの名前。デフォルトは次のとおりです。 com.sun.net.ssl.internal.ssl.Provider AIX 上でインテグレーションサーバーを実行している場合は、次の名前を指定します。 com.ibm.jsse.IBMJSSEProvider |
||
キーストア |
デフォルトのキーストアファイルを指定します。キーストアは、SSL 接続確立時の鍵/証明書管理に使用されます。 |
有効なパッケージの場所。デフォルト値はありません。次のファイルを使用することをお勧めします。
項目の意味を次に示します。
|
||
キーストアパスワード |
デフォルトのキーストアパスワードを指定します。このパスワードは、SSL 接続確立時の鍵/証明書管理に使用されるキーストアにアクセスする際に使用されます。デフォルトはありません。 |
有効なキーストアパスワード。デフォルト値はありません。 |
||
キーストアタイプ |
デフォルトのキーストアタイプを指定できるようにします。キーストアタイプは、SSL 接続確立時の鍵/証明書管理に使用されます。キーストアタイプが指定されなかった場合、デフォルトのキーストアタイプである JKS が使用されます。 |
有効なキーストアタイプ。 |
||
キーストアユーザー名 |
SSL 接続確立時の鍵/証明書管理に使用されるキーストアにアクセスするためのユーザー名。 注 – キーストアタイプが PKCS12 または JKS の場合、キーストアユーザー名のプロパティーは使用されません。PKCS12 および JKS のキーストアタイプでは、アクセス時にパスワードが必要になりますが、ユーザー名は必要ありません。このプロパティーに値を入力しても、PKCS12 および JKS ではその値は無視されます。 |
有効なキーストアユーザー名。 |
||
SSL 接続タイプ |
使用される SSL 接続のタイプを指定できるようにします。 |
「なし」、「SSL を有効化」、または「TLS オンデマンド」を選択します。次のように目的の値を入力します。 なし: SSL を使用しない、単純なプレーン接続。 SSL を有効化: SSL が有効化されます。LDAP サーバーへのすべての通信で、セキュリティー保護された通信チャネルが使用されます。 注 – 「SSL の有効化」オプションを使用する場合、「プロバイダ URL」プロパティーが、セキュリティー保護された LDAP ポート (デフォルトは 636) を指している必要があります。 このプロパティーの必要な値に関する追加情報については、「SSL 接続タイプ」を参照してください。 |
||
SSL プロトコル |
LDAP サーバーとの SSL 接続を確立する際に使用する SSL プロトコル。アプリケーションサーバーのプラットフォームについては、JSSE のマニュアルを参照してください。 |
「TLS」、「TLSv1」、「SSLv3」、「SSLv2」、または「SSL」を選択します。 |
||
トラストストア |
デフォルトのトラストストアを指定します。トラストストアは、SSL 接続確立時の CA 証明書管理に使用されます。 |
有効なトラストストアファイル。デフォルトはありません。 |
||
トラストストアパスワード |
デフォルトのトラストストアパスワードを指定できるようにします。このパスワードは、SSL 接続確立時の CA 証明書管理に使用されるトラストストアにアクセスするためのものです。 |
有効なトラストストアパスワード。デフォルトはありません。 |
||
トラストストアタイプ |
SSL 接続確立時の CA 証明書管理に使用されるトラストストアのトラストストアタイプを指定できるようにします。トラストストアタイプが指定されなかった場合、デフォルトのトラストストアタイプである JKS が使用されます。 |
有効なトラストストアタイプ。 |
||
ホスト名の検証 |
SSL ハンドシェーク中にサーバー証明書に対してホスト名検証を行うかどうかを判定します。 このプロパティーを使えば、要求 URL 内のサーバーホスト名と受信されたサーバー証明書内のホスト名について、厳格なチェックを行えます。 |
true または false。デフォルトは false です。 このプロパティーの必要な値に関する追加情報については、「ホスト名の検証」を参照してください。 |
||
X509 アルゴリズム名 |
信頼マネージャーファクトリと鍵マネージャーファクトリで使用する X509 アルゴリズムの名前を指定します。 |
有効な X509 アルゴリズム名前。デフォルトは「SunX509」です。AIX 上でインテグレーションサーバーを実行している場合は、「IbmX509」を指定します。 |
次に示すのは、「セキュリティー/SSL」セクションの次のプロパティーに関する追加の注意事項です。
現在の LDAP サーバーで、セキュリティー証明書のインストールやポート番号などの SSL プロパティーが正しく設定されていることを確認してください。
Transport Layer Security (TLS) は、インターネット経由で通信するクライアント/サーバーアプリケーション間で機密性とデータの完全性を保証するプロトコルです。 このアダプタの TLS 動作では、セキュリティー保護された通信とされていない通信の両方が同じ接続上でサポートされます。
ただし、LDAP サーバーの中には、セキュリティー保護されていない設定済みのポート上で起動しなければならず、セキュリティー保護されたポート上では起動できないものもあります。詳細については、LDAP サーバーの関連するマニュアルを参照してください。
TLS オンデマンド: LDAP version 3 の機能 (StartTLS 拡張動作)。これは、Java SDK version 1.4 以降でサポートされています。このオプションを選択すれば、SSL 接続の確立を、プログラムを使ってオンデマンドで行えます。
「TLS オンデマンド」オプションを使用する場合、「プロバイダ URL」プロパティーが、セキュリティー保護されていない LDAP ポート (デフォルトは 389) を指している必要があります。
このオプションの選択後、セキュリティー保護された通信が必要になるたびに、LDAP サーバーに対するすべてのメソッド呼び出しを、LDAP OTD 経由でアクセス可能な startTLS 呼び出しと stopTLS 呼び出しの間に配置する必要があります。
次の例では、performAddEntry 呼び出しはセキュリティー保護された通信チャネルを経由しますが、performRename 呼び出しはセキュリティー保護されていないプレーン通信チャネルを経由します。
startTLS(); performAddEntry(); stopTLS(); performRename(); |
現在の LDAP サーバーで (SSL 設定に加えて) TLS 設定が正しく設定されていることを確認してください。
stopTLS メソッドを使用すると、一部の LDAP サーバーで予期しない動作が発生する可能性があります。コラボレーション定義からこのメソッドを削除しなければいけない可能性があります。たとえば、Sun ONE Directory Server への接続時には stopTLS メソッドを使用できません。詳細については、LDAP サーバーの関連するマニュアルを参照してください。
ユーザーが複数の値を持つ単一の属性を TLS 接続経由で繰り返し追加すると、Active Directory はコンテキストを解放しません。ただし、TLS を開始し、属性処理を追加してから TLS を停止する、という回避方法をとれば、コンテキストが解放されます。
LDAP OTD でこの機能を使用する方法については、「TLS 拡張ノード」を参照してください。
いくつかの環境下で、このプロパティーを true、false のどちらに設定するかによって、さまざまな Java 例外が発生する可能性があります。ここでは、それらの例外の原因について説明します。
たとえば、URL に含まれるホスト名が localhost、サーバー証明書に含まれるホスト名が localhost.stc.com であるととします。このとき、次の条件が適用されます。
「ホスト名の検証」が false に設定されている場合:
要求された URL とサーバー証明書間のホスト名チェック機能が「無効」になります。
https://localhost:444 などの不完全なドメインホスト名を使用することも、https://localhost.stc.com:444 などの完全なドメインホスト名を使用することも可能であり、どちらの場合も正常な応答が得られます。
「ホスト名の検証」が true に設定されている場合:
要求された URL とサーバー証明書間のホスト名チェック機能が「有効」になります。
https://localhost:444 などの不完全なドメインホスト名を使用すると例外 java.io.IOException (HTTPS hostname wrong) が発生する可能性があります。
https://localhost.stc.com:444 などの完全なドメインホスト名を使用する必要があります。
Application Server が使用している Java SDK のバージョンと対応する Application Server プロパティー設定とが一致しないと、例外 java.lang.ClassCastException が発生する可能性があります。
インバウンド MSMQ アダプタの設定情報は、次の各トピックに編成されています。
これらのプロパティーのうちの 1 つ、たとえば形式名を使ってキューを識別する場合、ほかの 2 つのプロパティーの値は空のままにしておくことをお勧めします (この場合であれば、「MSMQ キューエイリアス」および「MSMQ キュー名」プロパティーを空のままにする)。これにより、ユーザーが指定したキュー識別方式だけが確実に使用されるようになります。
インバウンド MSMQ 接続マッププロパティーの「MSMQ 設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–55 接続マップ - インバウンド - MSMQ 設定
名前 |
説明 |
必要な値 |
---|---|---|
キューエイリアスを指定します。キューエイリアスは、AD パスとユーザー定義文字列 (エイリアス) を、公開、非公開、または直接の単一要素形式名に関連付けます。 キューエイリアスを使ってメッセージの送受信を行うには、MSMQ および Active Directory サービスが Application Server と同じコンピュータ上にインストールされている必要があります。 |
キューエイリアス。 詳細については、「MSMQ キューの識別」を参照してください。 |
|
キューの形式名を指定します。形式名とは、いくつかの接続詳細情報やキューのパスを指定することでキューを一意に識別する文字列のことです。さまざまなタイプの形式名を使用することで、メッセージのルーティング方法、デスティネーションのタイプ、およびキューのオープン対象となる処理のタイプを指定できます。 TCP および HTTP プロトコルを受け付けるように MQ のセキュリティー属性を設定してください。 |
次の形式の公開または非公開の形式名。
|
|
Microsoft メッセージキューの名前を指定します。 |
キューを識別する文字列名。これはホスト名に関連付けられているため、queuename のように値を入力します。ここで、queuename はキュー名です。 詳細については、「MSMQ キューの識別」を参照してください。 |
|
DENY_NONE または DENY_RECEIVE_SHARE を選択します。 DENY_NONE がデフォルト設定になります。 |
||
MSMQ アクセスモードを指定します。 インバウンドモードでサポートされているのは、RECEIVE_ACCESS だけです。 |
RECEIVE_ACCESS |
|
ポーリング間隔、つまりアダプタがキュー内に受信メッセージがないか確認する頻度、をミリ秒で指定します。 |
ポーリング間隔をミリ秒で示す数値。 デフォルト設定は 5000 (5 秒) です。 |
|
MSMQ 受信アクションコード |
MSMQ 受信アクションコードを指定します。 インバウンドモードでサポートされているのは、ACTION_RECEIVE だけです。 |
ACTION_RECEIVE |
Microsoft メッセージトランザクションタイプを指定します。 |
キューを識別する文字列名。これはホスト名に関連付けられているため、queuename のように値を入力します。ここで、queuename はキュー名です。 |
MSMQ アダプタは、次の 3 つのプロパティーのうち、次の順番で最初に使用可能になった値を使って MSMQ キューを識別します。
MSMQ キューエイリアス
MSMQ 形式名
MSMQ キュー名
形式名とは、接続詳細情報やキューのパスを使ってキューを一意に識別する文字列のことです。さまざまなタイプの形式名を使用することで、メッセージのルーティング方法、デスティネーションのタイプ、およびキューのオープン対象となる処理のタイプを指定できます。
公開または非公開の形式名プロパティーの値は、次のようにして入力します。
公開キューの場合は次の形式を使用します。
DIRECT=TCP:IPAddress\QueueName
例: DIRECT=TCP:192.168.100.100\testmsmq
DIRECT=OS:ComputerName\QueueName
例: DIRECT=OS:mypc-gx600\testmsmq
DIRECT=HTTP://Host/msmq/QueueName
例: DIRECT=HTTP://mypc-gx600/msmq/testmsmq
非公開キューの場合は次の形式を使用します。
DIRECT=TCP:IPAddress\private$\ QueueName例: DIRECT=TCP:192.168.100.100\private$\privateqnxa
DIRECT=OS:ComputerName\private$\ QueueName
例: DIRECT=OS:mypc-gx600\private$\privateqnxa
TCP および HTTP プロトコルを受け付けるように MQ のセキュリティー属性を設定してください。「MSMQ 形式名」を指定する場合であれば、「MSMQ キュー名」および「MSMQ キューエイリアス」プロパティーは空のままにしておく必要があります。
ComputerName を確認するには、「マイ コンピュータ」を右クリックし、「管理」をクリックします。「コンピュータの管理」ダイアログボックスから、「コンピュータの管理」 ⇒ 「サービスとアプリケーション」 ⇒ 「メッセージキュー」 ⇒ 「パブリックキュー」と選択します。キューを右クリックし、「プロパティ」を選択します。「プロパティ」ダイアログボックスの「全般」タブから、MSMQ で使用されているコンピュータ名とキュー名を確認できます (次の図を参照)。
ComputerName と Host の名前は、MSMQ によって 15 文字に制限されています。ホスト名に含まれる文字が 15 文字を超えている場合、MSMQ はその名前を切り詰めます。その場合、その切り詰められたホスト名を使用する必要があります。システムの具体的なホスト名を確認するには、キューの「プロパティ」、「全般」タブを参照してください (「転送前 (BatchFTP の接続マップ)」を参照)。
アウトバウンド MSMQ アダプタの設定情報は、次の各トピックに編成されています。
これらのプロパティーのうちの 1 つ、たとえば形式名を使ってキューを識別する場合、ほかの 2 つのプロパティーの値は空のままにしておくことをお勧めします (この場合であれば、「MSMQ キューエイリアス」および「MSMQ キュー名」プロパティーを空のままにする)。これにより、ユーザーが指定したキュー識別方式だけが確実に使用されるようになります。
アウトバウンド MSMQ アダプタの接続マッププロパティーの「MSMQ 設定」セクションには、次の表に示す最上位プロパティーが含まれています。
表 1–56 接続マップ - アウトバウンド - MSMQ 設定
名前 |
説明 |
必要な値 |
---|---|---|
キューエイリアスを指定します。キューエイリアスは、AD パスとユーザー定義文字列 (エイリアス) を、公開、非公開、または直接の単一要素形式名に関連付けます。 キューエイリアスを使ってメッセージの送受信を行うには、MSMQ および Active Directory サービスが Application Server と同じコンピュータ上にインストールされている必要があります。 |
キューエイリアス。 詳細については、「SOCKS (BatchFTP の接続マップ)」を参照してください。 |
|
MSMQ 形式名 |
キューの形式名を指定します。形式名とは、接続詳細情報やキューのパスを使ってキューを一意に識別する文字列のことです。さまざまなタイプの形式名を使用することで、メッセージのルーティング方法、デスティネーションのタイプ、およびキューのオープン対象となる処理のタイプを指定できます。 TCP および HTTP プロトコルを受け付けるように MQ のセキュリティー属性を設定してください。 |
次の形式の公開または非公開の形式名。
|
Microsoft メッセージキューの名前を指定します。 |
キューを識別する文字列名。これはホスト名に関連付けられているため、host/queue のように値を入力します。ここで、host はホスト名、queue はキュー名です。 詳細については、「SOCKS (BatchFTP の接続マップ)」を参照してください。 |
|
MSMQ トランザクションタイプ |
アウトバウンドのトランザクションタイプを指定します。オプションは次のとおりです。
|
MQ_NO_TRANSACTION、MQ_XA_TRANSACTION、または MQ_SINGLE_MESSAGE をトランザクションタイプとして選択します。 デフォルト値 MQ_NO_TRANSACTION を使用します。 詳細については、MSMQ のユーザーマニュアルを参照してください。 |
次のいずれかを使って MSMQ 共有モードを指定します。 |
DENY_NONE または DENY_RECEIVE_SHARE を選択します。 DENY_NONE がデフォルト設定になります。 エラー条件 Message Queuing がキューを開いたあとで、このユーザーかほかのだれかが RECEIVE_ACCESS または PEEK_ACCESS を使ってそのキューを開こうとすると、エラーメッセージが表示されます。 RECEIVE_ACCESS または PEEK_ACCESS を使ってキューがすでに開かれている状態で、DENY_RECEIVE_SHARE を使ってそのキューを開こうとすると、その呼び出しは失敗します。 |
|
すべてのメッセージに対するメッセージ優先レベルを指定します。優先度の範囲は、レベル 0 (低い優先度) から 7 (高い優先度) までです。メッセージはキュー内で降順に格納され、優先度の高いメッセージが先にきます。優先度が有効になるのは、「MSMQ アクセスモード」が SEND_ACCESS に設定されている場合だけです。 |
メッセージの優先度を示す、0 から 7 までの数値。デフォルト設定は 3 です。 |
|
次のいずれかを使って MSMQ 受信アクションコードを指定します。 ACTION_RECEIVE: 現在のカーネル位置にあるメッセージを読み取り、それをキューから削除します。 ACTION_PEEK_CURRENT: キュー内の最後のメッセージを「peek」します。いくつかのメッセージがキューを出入りしていて、最後のメッセージを peek (確認) して取得する必要がある場合に、この機能を使用できます。 |
ACTION_RECEIVE または ACTION_PEEK_CURRENT を選択します。 ACTION_RECEIVE がデフォルト設定になります。 |
|
Message Queuing が peek、送信、受信のいずれのアクセス権を使ってキューを開くかを指定します。 |
RECEIVE_ACCESS、SEND_ACCESS、または PEEK_ACCESS を選択します。 メッセージ優先度を使用するには、このアクセスモードを SEND_ACCESS に設定する必要があります。 |
|
外部接続をインスタンス化する際に物理的な接続を確立するかどうかを指定します。オプションは次のとおりです。
|
「自動」または「手動」 (動的) を選択します。 デフォルト設定は「自動」です。 |
MSMQ アダプタは、次の 3 つのプロパティーのうち、次の順番で最初に使用可能になった値を使って MSMQ キューを識別します。
MSMQ キューエイリアス
MSMQ 形式名
MSMQ キュー名
接続マップからアクセスされる TCP/IP HL7 サーバーインバウンドアダプタの設定プロパティーは、次の各セクションに編成されています。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーの「一般インバウンド設定」セクションには、次の表に示す最上位パラメータが含まれています。
表 1–57 接続マップ - 一般インバウンド設定
名前 |
説明 |
必要な値 |
---|---|---|
プログラムの内部に格納できるデータの最大量を指定します。有効な範囲は、1 から 2G バイト (Java の整数の最大値) までです。 |
データの最大量を示す数値。有効な範囲は、1 から 2147483647 (バイト) までです。 デフォルト設定は 2147483647 です。 |
|
OTD ノードである State オブジェクトのスコープを定義します。このパラメータのオプションは、次のとおりです。
|
次のいずれかを選択します。 リソースアダプタレベル 接続レベル OTD レベル デフォルト設定は「リソースアダプタレベル」です。 |
|
サーバーの専用セッションモードが有効、無効のいずれであるかを指定します。サーバーの専用セッションモードが有効な場合、現在のクライアントの要求が接続先のサーバーポートを占有します。同じポートに対する次のクライアントの要求は、その前の要求が完了して接続を解放するまで、ブロックまたは拒否されます。 |
true または false を選択します。true は、専用セッションモードが有効であることを示します。 デフォルト設定は false です。 |
「TCPIP インバウンド設定」セクションは、Java の Socket および ServerSocket のオプションを提供します。TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–58 接続マップ - TCPIP インバウンド設定
名前 |
説明 |
必要な値 |
||
---|---|---|---|---|
アダプタによる TCP/IP 接続の確立方法を指定します。
|
「クライアント」または「サーバー」。「サーバー」がデフォルト設定です。「クライアント」モードが特に必要でないかぎり、この値はデフォルトの「サーバー」のままにしておいてください。 |
|||
ServerSocket の SO_TIMEOUT の値を、ミリ秒で設定または取得します。ServerSocket.accept() で使用されます。このオプションをゼロ以外のタイムアウトに設定すると、この ServerSocket 上で accept() を呼び出した際に、その設定された時間の長さだけブロックが発生します。タイムアウトの期限が切れると、java.net.SocketTimeoutException (または java.net.InterruptedIOException) がスローされますが、ServerSocket は有効なままです。ブロック動作に入る前に、このオプションを有効にしてください。このパラメータが使用されるのは、「接続タイプ」が「サーバー」に設定されている場合だけです |
ServerSO タイムアウトを示す数値 (ミリ秒)。 このタイムアウトはゼロ (0) より大きくする必要があります。ゼロのタイムアウトは、タイムアウトが無限であると解釈されます。 デフォルト設定は 60000 (60 秒) です。 |
|||
サーバーソケットファクトリを実装した Java クラスの名前を指定します。このクラスは、サーバーソケットを作成するために使用されます。ユーザー独自のサーバーソケット実装を用意した場合には、その実装を含む Java クラスの名前をここで入力します。ファクトリ実装クラスは、次のインタフェースを実装する必要があります。
|
有効な Java クラス名。デフォルトは次のとおりです。
|
|||
クライアントの SO_KEEPALIVE オプションが有効、無効のいずれであるかを指定します。ある TCP ソケットでこのオプションが設定されており、そのソケット経由で2 時間、どちらの方向にもデータがまったく交換されなかった場合、TCP は自動的に KEEPALIVE プローブをピアに送信します (実際の値は実装に依存する)。このプローブは TCP セグメントであり、ピアはこれに応答する必要があります。次の 3 つの応答のいずれかが予期されます。
|
true または false。true は、サーバーの SO_KEEPALIVE オプションが有効であることを示します。 注 – 一部のプロパティーについては、その設定がサーバーソケット自体には直接関連付けられません。代わりに、それらのプロパティーは受け付けられたクライアントソケットにマップされます。 |
|||
現在のソケットの SO_RCVBUF オプションの値を設定または取得します。これは、オペレーティングシステムがこのソケットの入力用に使用するバッファーのサイズです。これは、プラットフォームが受信ネットワーク入出力用に使用する配下のバッファーの概算サイズを提供します。これを設定に使用すると、その値は、このソケット経由で受信されるデータ用に使用するバッファーのサイズに関する、アプリケーションからカーネルへの提案値になります。これを取得に使用すると、プラットフォームがこのソケット上でのデータ受信時に使用するバッファーの実際のサイズが返されます。 |
受信バッファーサイズを示す数値。 デフォルト設定は 8192 です。 |
|||
現在のソケットの SO_SNDBUF オプションの値を設定または取得します。これは、オペレーティングシステムがこのソケットの出力用に使用するバッファーのサイズです。これは、プラットフォームが送信ネットワーク入出力用に使用する配下のバッファーの概算サイズを提供します。これを設定に使用すると、その値は、このソケット経由で送信されるデータ用に使用するバッファーのサイズに関する、アプリケーションからカーネルへの提案値になります。これを取得に使用すると、プラットフォームがこのソケット上でのデータ送信時に使用するバッファーの実際のサイズが返されます。 |
送信バッファーサイズを示す数値。 デフォルト設定は 8192 です。 |
|||
アダプタが linger-on-close タイムアウトを実行するかどうかを指定します。このオプションは、TCP Socket の close() からの即時リターンを無効化/有効化します。このパラメータは「SoLinger タイムアウト」と組み合わせて使用されます。
|
true または false。true の場合、SO_Linger オプションが有効になります。 |
|||
サーバーの SoLinger タイムアウトを秒で指定します。「SoLinger タイムアウト」は「linger-on-close」タイムアウトを設定するために、「SoLinger」 (「SoLinger」プロパティー値を参照) と組み合わせて使用されます。 「SoLinger」が true (有効) に設定された場合、「SoLinger タイムアウト」値の意味は、次のようになります。
|
-1 から 65535 までの整数。デフォルトは -1 秒ですが、これは、「SoLinger」オプションが無効化される (false に設定される) ことを示します。 ゼロ (0) は、SoLinger が即時に強制的なクローズを実行することを示します。整数 1 から 65535 までは、タイムアウトの秒数を示します。 |
|||
SoTimeout の値をミリ秒で設定または取得します。受け付けられたクライアントソケットで使用されます。このオプションをゼロ以外のタイムアウトに設定すると、このソケットに関連付けられた InputStream 上で read() を呼び出した際に、設定された時間だけブロックが発生します。タイムアウトの期限が切れると、java.io.InterruptedIOException (または java.net.SocketTimeoutException) がスローされますが、Socket は有効なままです。 ブロック動作に入る前に、このオプションを有効にしてください。 |
SoTimeout の値 (ミリ秒)。デフォルト設定は 10000 (10 秒) です。 このタイムアウトは 0 (ゼロ) より大きくする必要があります。ゼロのタイムアウトは、タイムアウトが無限であると解釈されます。 |
|||
サーバーの TcpNoDelay オプション (つまり、Nagle のアルゴリズム) が有効、無効のいずれであるかを指定します。
|
true または false。 デフォルト設定は false です。 |
「TCPIP インバウンド設定」 - 「サーバーポートのバインディング」セクションは、サーバーポートバインディングの制御に使用されるパラメータを定義します。このセクションが使用されるのは、「接続タイプ」が「サーバー」に設定されている場合だけです。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
このセクションが使用されるのは、「接続タイプ」が「サーバー」に設定されている場合だけです。
名前 |
説明 |
必要な値 |
---|---|---|
localhost 上の指定された TCP/IP ポートへのバインドをアダプタが試みる最大回数を指定します。 |
バインドの試行回数を示す整数。 デフォルト設定は 3 です。 |
|
localhost 上の指定された TCP/IP ポートへの複数のバインド試行間でのアダプタの待機時間の長さ (ミリ秒) を指定します。 |
複数の試行間でのアダプタの待機時間の長さをミリ秒で示す整数。 デフォルト設定は 30000 (30 秒) です。 |
「TCPIP インバウンド設定」 - 「クライアント接続の確立」セクションは、接続の確立を制御するために使用される構成パラメータをいくつか定義します。このセクションが使用されるのは、「接続タイプ」が「クライアント」に設定されている場合だけです。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
このセクションが使用されるのは、「接続タイプ」が「クライアント」に設定されている場合だけです。
名前 |
説明 |
必要な値 |
---|---|---|
外部システムへの接続を試みるまでにアダプタが待機する時間の長さ (ミリ秒) を指定します。 |
外部システムへの接続を試みるまでの待機時間の長さ (ミリ秒) を示す数値。 デフォルト設定は 30000 (30 秒) です。 |
「TCPIP インバウンド設定」 - 「インバウンド接続の管理」セクションは、インバウンドサーバー接続の管理に使用されるパラメータを定義します。たとえば、受け付けられた接続の接続プールやライフサイクルなどです。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–61 接続マップ - TCPIP インバウンド設定 - インバウンド接続の管理
名前 |
説明 |
必要な値 |
---|---|---|
指定された TCP/IP ポート上で待機しているかそのポートを監視している特定のリスナー/モニターに許可される、同時接続の最大数を指定します。これは、このサーバーのサービスの能力または可用性を表します。クライアントからの接続要求ごとに 1 つの同時接続が割り当てられます。また、このパラメータは、このサーバーのサービスに同時に接続し、特定のリスナー/モニターのサービスを同時に受けることができるクライアントの最大数も表します。 |
特定の TCP/IP ポートで 1 つのリスナー/モニターから使用可能な同時接続の最大数を示す数値。0 は、制限がないことを示します。 デフォルト設定は 50 です。 |
|
アダプタが使用している受け付けられた接続のスコープを指定します。次の 2 つのオプションがあります。
|
「リソースアダプタレベル」または「コラボレーションレベル」を選択します。 デフォルト設定値は「リソースアダプタレベル」です。 |
|
クローズ通知の値を指定します。サーバーは、このパラメータの値に一致する内容を含む通知を受け取ると、接続を安全に閉じ、対応するすべてのスケジュールを取り消します。 |
接続を閉じるようにサーバーに通知するトリガー値を示す文字列。 デフォルト設定は「QUIT」です。 |
|
リクエスタ (クライアント) の非活動時間の長さ (ミリ秒) を指定します。アダプタは、クライアント側 (接続の反対側) の活動状態の検出を試みます。指定された期間中にクライアントの活動がなかった場合 (その接続経由でクライアントから入出力要求が到着しなかった場合)、その接続はサーバー側から閉じられ、リソースが解放されます。値の単位はミリ秒です。このアイドルタイムアウトチェック機能を無効にするには、このパラメータに 0 を指定します。 |
時間の長さをミリ秒で示す整数。値 0 を指定すると、アイドルタイムアウトは無効になります。 デフォルト設定は 60000 です。 |
このセクションでは、インバウンド TCP/IP サーバーによって使用されるスケジューラを設定します。サーバーは、新しいクライアント接続確立要求の到着を待ちます。これらのパラメータは、指定されたポート上で待機するリスナー/モニターを設定するために使用されます。
使用可能な J2EE スケジューラは次の 2 つです (次の表を参照)。
タイマーサービス: J2EE で使用可能です。このスケジューラの設定は、「固定レートで」、「遅延」、および「期間」プロパティーを使って行われます。
作業マネージャー: J2EE (JCA 1.5 以上) で使用可能です。このスケジューラの設定は、「遅延」および「期間」プロパティーを使って行われます。
どちらのスケジューラも、インバウンド TCP/IP サーバーが必要とする機能を提供します。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–62 接続マップ - TCPIP インバウンドスケジュール - リスナースケジュール
名前 |
説明 |
必要な値 |
---|---|---|
このインバウンド通信のスケジューラのタイプを指定します。次の 2 つのオプションがあります。
|
「タイマーサービス」または「作業マネージャー」を選択します。使用するコンテナが JCA 作業マネージャーをサポートしていない場合は、「タイマーサービス」を選択します。 |
|
このプロパティーの設定は、プロパティーエディタから確認はできるものの、無効になっています。使用できるスケジュール型は「繰り返し」だけですが、これは、このセクションの「期間」プロパティー (「期間」プロパティーを参照) で定義される一定間隔でタスクが繰り返し実行されるようにスケジューリングされることを示します。 |
このフィールドは有効化されません。 |
|
タイマーサービスと作業マネージャーの両方に適用されます。タスクが実行されるまでの遅延時間の長さをミリ秒で指定します。 |
タスクが実行されるまでの時間の長さをミリ秒で示す整数。 |
|
タイマーサービスと作業マネージャーの両方に適用されます。連続するタスク実行間の一定間隔をミリ秒で指定します。 |
連続するタスク実行間の時間の長さをミリ秒で示す整数。 |
|
タイマーサービスだけに固有です。固定レート実行、固定遅延実行のいずれを使用するかを指定します。
|
true または false。true は、固定レート実行が使用されることを示します。false は、固定遅延実行が使用されることを示します。 |
このセクションでは、既存の接続上でビジネスタスク (コラボレーションルール) を実行する TCP/IP サーバーによって使用されるスケジューラを設定します。このスケジューラは、ユーザーが定義した実際のビジネスルールに影響を与えます。
使用可能な J2EE スケジューラは次の 2 つです (表 1–62 の表を参照)。
タイマーサービス: J2EE で使用可能です。このスケジューラは、「固定レートで」、「遅延」、「期間」、および「スケジュール型」プロパティーを使って設定されます。
作業マネージャー: J2EE (JCA 1.5 以上) で使用可能です。このスケジューラは、「遅延」、「期間」、および「スケジュール型」プロパティーを使って設定されます。
どちらのスケジューラも、インバウンド TCP/IP サーバーが必要とする機能を提供します。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–63 接続マップ - TCPIP インバウンドスケジュール - サービススケジュール
名前 |
説明 |
必要な値 |
---|---|---|
このインバウンド通信のスケジューラのタイプを指定します。次の 2 つのオプションがあります。
|
「タイマーサービス」または「作業マネージャー」を選択します。使用するコンテナが JCA 作業マネージャーをサポートしていない場合は、「タイマーサービス」を選択します。 |
|
タイマーサービスと作業マネージャーの両方に適用されます。タスクが 1 回実行されるようにスケジューリングするか、あるいは繰り返し実行されるようにスケジューリングするかを指定します。
|
「1 回」または「繰り返し」を選択します。 |
|
タイマーサービスと作業マネージャーの両方に適用されます。タスクが実行されるまでの遅延時間の長さをミリ秒で指定します。 |
タスクが実行されるまでの時間の長さをミリ秒で示す整数。 |
|
タイマーサービスと作業マネージャーの両方に適用されます。連続するタスク実行間の一定間隔をミリ秒で指定します。これは、スケジュール型が「繰り返し」の場合に使用されます (表 1–62 の表の「スケジュール型」プロパティーを参照) |
連続するタスク実行間の時間の長さをミリ秒で示す整数。 |
|
タイマーサービスだけに固有です。固定レート実行、固定遅延実行のいずれを使用するかを指定します。これは、「タイマーサービス」スケジューラの「繰り返し」スケジュール型で使用されます。
|
true または false。true は、固定レート実行が使用されることを示します。false は、固定遅延実行が使用されることを示します。 |
アプリケーション肯定応答イベントの処理方法を指定します。TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–64 接続マップ - HL7 肯定応答
名前 |
説明 |
必要な値 |
---|---|---|
外部アプリケーションが HL7 アプリケーション肯定応答を、メッセージの受信に成功したあとで送信するか、あるいはアプリケーションデータベースにメッセージが正常にコミットされたあとで送信するかを指定します。オプションは次のとおりです。
|
「A」または「C」。 デフォルト設定は「A」です。 |
|
外部システムに送信される HL7 アプリケーション肯定応答が、アダプタで生成されるか、あるいはアプリケーションサーバーから転送されるかを指定します。
|
true または false。 デフォルト設定は false です。 |
|
HL7 アプリケーション肯定応答をアプリケーションサーバーに転送するかどうかを指定します。HL7 アプリケーション肯定応答を受信した場合、HL7 アプリケーション肯定応答の内容を、アプリケーションサーバーに (データとして) 転送する必要がある場合があります。
|
true または false。 デフォルト設定は false です。 |
|
遅延 ACK のタイムアウト値をミリ秒で指定します。 このパラメータは、インバウンドコラボレーションコードで使用されます。 |
タイムアウトをミリ秒で示す数値。 デフォルト設定は 30000 (30 秒) です。 |
下位層プロトコル (LLP) の設定を提供します。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–65 接続マップ - 下位層プロトコル
名前 |
説明 |
必要な値 |
---|---|---|
LLP (Lower Layer Protocol) のタイプを指定します。有効なタイプは次のとおりです。
|
「MLLP」、「HLLP」、または「MLLP v2.0」。 「MLLP」がデフォルト設定値になります。 |
|
開始ブロック文字 (HL7 エンベロープ内の最初のエンベロープマーカー文字) を、10 進 ASCII 番号として指定します。 |
1 から 127 までの範囲内の 10 進数。競合が存在するのでないかぎり、値は ASCII の VT (10 進の 11) にすべきです。 デフォルト値は 11 です。 |
|
終了データ文字 (HL7 エンベロープ内の最後のエンベロープマーカー文字の 1 つ前の文字) を、10 進 ASCII 番号として指定します。指定可能な範囲は、1 から 127 までです。 |
1 から 127 までの範囲内の 10 進数。競合が存在するのでないかぎり、値は ASCII の FS (10 進の 28) にすべきです。 デフォルト値は 28 です。 |
|
終了ブロック文字 (HL7 エンベロープ内の最後のエンベロープマーカー文字) を、10 進 ASCII 番号として指定します。 |
1 から 127 までの範囲内の 10 進数。HL7 標準に厳格に準拠するには、このパラメータをキャリッジリターン (10 進の 13) に設定する必要があります。 デフォルト値は 13 です。 |
|
HLLP (Hybrid Lower Level Protocol) チェックサムが有効、無効のいずれであるかを指定します。 |
true または false。true は、HLLP チェックサムが有効であることを示します。 |
|
アダプタがピアから MLLP v2.0 コミット否定応答を受信した際にメッセージの送信を試みる回数の最大値。この回数のあと、アダプタは送信をあきらめます。 このパラメータは、アウトバウンドモードの HL7 アダプタによって使用されます。 |
アダプタがピアから MLLP v2.0 コミット否定応答を受信した際にメッセージの送信を試みる回数を示す整数。 デフォルト設定値は 5 です。 |
シーケンス番号プロトコルの設定を提供します。HL7 のシーケンス番号付けは、データの重複を回避しやすくするために使用されます。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–66 接続マップ - シーケンス番号プロトコル
名前 |
説明 |
必要な値 |
---|---|---|
シーケンス番号プロトコルが有効、無効のいずれであるかを指定します。HL7 のシーケンス番号付けは、データの重複を回避しやすくするために使用されます。true は、シーケンス番号が有効であることを示します。 |
true または false。 デフォルト設定は true です。 |
HL7 MSH ヘッダーセグメントの設定を提供します。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–67 接続マップ - HL7 MSH セグメント
名前 |
説明 |
必要な値 |
---|---|---|
セグメント ID と実際の先頭フィールドとの間の区切り文字を指定します。この値は、メッセージの残りの部分の区切り文字として使用される文字を定義します。 これは、HL7 MSH セグメント内の 1 番目のフィールド (MSH-01) です。 |
10 進 ASCII 番号としてのフィールド区切り文字値。指定可能な範囲は、1 から 127 までです。 デフォルト設定は 124 ですが、これは文字「|」です。 |
|
4 つのエンコーディング文字を次の順番で指定します。
|
対応する順番に並べられた HL7 エンコーディング文字。 デフォルト設定は「^~\& (それぞれ ASCII の 94、126、92、38)」です。 |
|
ネットワークエンタープライズ内の各種アプリケーションの中で、送信アプリケーションを指定します。ネットワークエンタープライズは、企業内での HL7 メッセージの交換に参加するアプリケーションから構成されます。 これは、HL7 MSH セグメント内の 3 番目のフィールド (MSH-03) です。 |
HL7 送信アプリケーション用のユーザー定義値。 デフォルト設定は「Sun HL7 adapter」です。 |
|
さまざまな組織の代わりに動作する同一アプリケーションの複数インスタンスの中で、送信アプリケーションを指定 (さらに特定) します。 これは、HL7 MSH セグメント内の 4 番目のフィールド (MSH-04) です。 |
HL7 送信施設用のユーザー定義値。 デフォルト設定は「Sun HL7 adapter」です。 |
|
ネットワークエンタープライズ内の各種アプリケーションの中で、受信アプリケーションを指定します。ネットワークエンタープライズは、企業内での HL7 メッセージの交換に参加するアプリケーションから構成されます。 これは、HL7 MSH セグメント内の 5 番目のフィールド (MSH-05) です。 |
HL7 受信アプリケーション用のユーザー定義値。 デフォルト設定は「Sun HL7 adapter」です。 |
|
さまざまな組織の代わりに動作する同一アプリケーションの複数インスタンスの中で、受信アプリケーションを指定 (さらに特定) します。 これは、HL7 MSH セグメント内の 6 番目のフィールド (MSH-06) です。 |
HL7 受信施設用のユーザー定義値。 デフォルト設定は「Sun HL7 adapter」です。 |
|
実装されたアプリケーションレベルのセキュリティー機能を指定します。 これは、HL7 MSH セグメント内の 8 番目のフィールド (MSH-08) です。 |
HL7 で開発中です。 |
|
MSH-11 のサブコンポーネント「処理 ID」を指定します。MSH-11 は、HL7 アプリケーション (レベル 7) 処理規則の定義に従ってメッセージが処理されるかどうかを示すために使用されます。 |
次のいずれかが必要です。
|
|
受信側のシステムが自身のバージョンと照合すべき特定の HL7 バージョンを指定します。 これは、HL7 MSH セグメント内の 12 番目のフィールド (MSH-12) です。 |
HL7 表 0104 - Version ID に表示される、HL7 標準のバージョン値。 デフォルト設定値は 2.5 です。 |
|
メッセージが作成された国を示すコードを指定します (HL7 表 0399 を参照)。通貨など、メッセージ内のデフォルト要素を指定するために使用されます。 これは、HL7 MSH セグメント内の 17 番目のフィールド (MSH-17) です。 |
国番号の値として、ISO 3166 の 3 文字 (アルファベット) 形式が使用されます。 デフォルト値は「USA」です。 |
|
メッセージで使用される文字セットを指定します (HL7 表 0211 を参照)。このフィールドを空白のままにすると、使用されている文字セットは 7 ビット ASCII セットであるとみなされます。 これは、HL7 MSH セグメント内の 18 番目のフィールド (MSH-18) です。 |
デフォルト設定は、「8859/1」 (印刷可能な 7 ビット ASCII 文字セット) です。 使用可能な値とその説明については、HL7 表 0211 を参照してください。 |
|
メッセージの主な言語を指定します。コードは ISO 639 のものを使用します。 これは、HL7 MSH セグメント内の 19 番目のフィールド (MSH-19) です。 |
2 文字の ISO 639 アルファベットコード。 |
|
任意の代替文字セットが使用されるために特殊な処理方式が必要になった場合に使用すべき、代替文字セット処理方式の値を指定します (HL7 表 0356 を参照)。 これは、HL7 MSH セグメント内の 20 番目のフィールド (MSH-20) です。 |
使用可能な値は「ISO 2022-1994」、「2.3」、および「<null>」(空) です。このフィールドを空白のままにすると、文字セットの切り替えが行われなくなります。 |
|
適合性ステートメント ID (V2.5 のメッセージプロファイル識別子) は、クエリーの適合性ステートメントに適用される一意の識別子であるか、あるいはメッセージプロファイル識別子として、あるメッセージプロファイルへの準拠 (文法、構文、使用方法など) を主張します。 これは、HL7 MSH セグメント内の 21 番目のフィールド (MSH-21) です。 |
HL7 適合性ステートメント ID の値。あるいは空白のままにします。 |
|
インバウンドの場合はデータメッセージの MSH セグメント、アウトバウンドの場合は ACK の MSH セグメントを検証するかどうかを指定します。 このパラメータは、インバウンドコラボレーションコードで使用されます。 注 – このプロパティーは、HL7 メッセージ自身の全体の構造検証には影響を与えません。構造検証は常に実行されます。 |
true または false。true は、コラボレーションが MSH セグメントを検証することを示します。 デフォルト設定は true です。 |
HL7 SFT セグメントの設定を提供します。SFT セグメントは HL7 version 2.5 以降で使用できます。このセグメントは、送信アプリケーションとして使用される 1 つ以上のソフトウェア製品に関する追加情報を提供します。このセグメントの主な目的は、診断用途です。サイト固有の契約に基づくその他の用途も考えられます。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–68 接続マップ - HL7 SFT セグメント
名前 |
説明 |
必要な値 |
---|---|---|
省略可能な SFT セグメントを ACK 内で有効にするかどうかを指定します。 注 – 「有効化」を true に設定した場合、HL7 のバージョンが 2.5 として設定されていなければ、アダプタの起動時にエラーが発生します。 |
true または false。true は、ACK 内の SFT セグメントを有効にすることを示します。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
ソフトウェアベンダー組織 |
HL7 セグメント SFT-01、具体的にはこのトランザクションを作成した送信ソフトウェアの発行または配布、あるいはその両方を行う企業の名前、を指定します。このフィールドとこのセグメントの残りのフィールドの目的は、送信アプリケーションのより完全なプロファイルを提供することです。「ソフトウェアベンダー組織」フィールドは、アプリケーションを保守する責任があるベンダーを特定します。 |
送信ソフトウェアの発行元またはベンダーの名前。 デフォルト設定は「Sun Microsystems, Inc.」です 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
HL7 セグメント、具体的には「ソフトウェア認定バージョンまたはリリース番号」を指定します。送信システムの最新のソフトウェアバージョン番号またはリリース番号があれば、HL7 メッセージを送信または受信しているアプリケーションのより完全なプロファイルを提供しやすくなります。 バージョン番号は、特定リリースのアプリケーションを識別する際に重要となります。場合によっては、受信アプリケーションが特定のソフトウェアの「認定」されたバージョンまたはリリースのリストに基づいて、このソフトウェア認定バージョン番号またはリリース番号を検証することもあります。これにより、受信アプリケーションが必要とする特定のビジネスルールに送信アプリケーションが準拠しているかどうかを判断しやすくなります。あるいは、送信ソフトウェアのバージョンに応じて異なる処理をソフトウェアに実行させることもできます。 |
ソフトウェア認定バージョン番号またはリリース番号。 デフォルト設定は 6.0.0 です。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-03、具体的にはこのトランザクションを送信したソフトウェア製品の名前、を指定します。ソフトウェア製品名は、送信アプリケーションを特定する際に重要となる要素の 1 つです。 |
送信ソフトウェア製品名。 デフォルト値は「Sun TCP/IP HL7 adapter Intelligent Adapter」です。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-04、具体的にはソフトウェアバイナリ ID、を指定します。このプロパティーは、HL7 version 2.5 以降で使用できます。ソフトウェアバイナリ ID は、ベンダーによって一意のソフトウェアバージョンインスタンスごとに発行されます。これらの ID は、同じソフトウェアの異なるバージョンを区別するために使用されます。主要 ID が同じであれば、ソフトウェアがバイナリレベルで同じであることになりますが、設定は異なる可能性があります。 |
一意のソフトウェアバイナリ ID。 デフォルト設定は 6.0.0 です。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-05、具体的にはソフトウェア製品の識別情報、を指定します。これには、ソフトウェアアプリケーションの説明、設定、ソフトウェアに施された変更など含めることができます。 このフィールドには、送信アプリケーションとそれが送信したトランザクションに関する任意の追加情報を含めることができます。この情報は診断目的に使用されますが、それにより、アプリケーションソフトウェアの識別をより柔軟に行える可能性があります。 |
特定の送信ソフトウェアの識別に役立つ可能性のある情報。このフィールドを使用するのは、診断を実行する場合だけにすべきです。 デフォルト値は、「これは、TCP/IP 接続経由での HL7 用 JCA アダプタです」です。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-06、具体的にはソフトウェアインストール日付、を指定します。これは、送信ソフトウェアが送信側のサイトにインストールされた日付です。ソフトウェアインストール日付はそれだけで、アプリケーションの動作に関する重要な情報になることも少なくありません。これは、送信アプリケーションのより完全なプロファイルを提供するために必要です。 |
送信アプリケーションソフトウェアのインストール日付。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
「通信制御」セクションは、TCP/IP 接続上でのデータ転送 (送信/受信) を制御します。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–69 接続マップ - 通信制御
名前 |
説明 |
必要な値 |
---|---|---|
アダプタがリコースアクションを実行する前に外部システムからの応答を待つ時間の長さ (ミリ秒) を指定します (表 1–70 の表の「応答なし時のアクション」を参照)。外部システムからのデータはすべて、応答とみなされます。 このプロパティーは、初回の読み取り/受信処理のタイムアウトに対応しています。いったん応答が受信されると、その後の読み取り/受信処理では、「SoTimeout」に指定されたタイムアウトが使用されます (表 1–58 の「So Timeout」を参照)。値 0 は、タイムアウトが無限であると解釈されます。 |
アダプタが外部システムから応答が到着するのを待つ時間の長さをミリ秒で示す整数。値 0 (ゼロ) は、タイムアウトが無限であると解釈されます。 デフォルト設定は 30000 (30 秒) です。 |
|
読み取り/受信処理から何も返されなくなったあと、アダプタが外部システムからのデータの読み取りを試みる最大回数を指定します。これは、応答が到着し始めたあとの読み取りまたは受信処理に適用されます。「空の読み取り」は、読み取り/受信処理でタイムアウトが発生したことを意味しますが、その際には、「TCPIP サーバーベース設定」セクションの「SoTimeout」パラメータが、適用されるタイムアウト設定として使用されます (表 1–58 の「So Timeout」を参照)。対応するリコースアクションは、表 1–70 の表の「読み取り失敗の最大試行回数に達したときのアクション」で指定されます。 |
最大試行回数を示す数値。 デフォルト設定は 5 です。 |
|
アダプタが外部システムからのデータを待っている間に許可する、応答タイムアウトの最大数を指定します。この数を超えるとリコースアクションが実行されます (表 1–70 の表の「応答なしの最大回数に達したときのアクション」を参照)。 このパラメータは、インバウンドコラボレーションコードで使用されます。このパラメータは、アウトバウンドアダプタによってのみ使用され、リコースアクションパラメータ「応答なし時のアクション」の「再送信」オプションと連携して動作します (表 1–70 の表の「応答なし時のアクション」を参照)。これは、後続のリコースアクションを実行する前に、指定された最大回数に達するまで最後のメッセージを再送信するように、アダプタを設定します。 |
リコースアクションが実行される前に発生可能な適切な回数を示す整数。 デフォルト設定は 30 です。 |
|
アダプタがリコースアクションを実行する前に受信する否定応答の最大数を指定します (表 1–70 の表の「NAK 受信の最大回数に達したときのアクション」を参照)。 このパラメータは、インバウンドコラボレーションコードで使用されます。 |
リコースアクションの実行前に受信される NAK の適切な最大数を示す数値。 デフォルト値は 30 です。 |
|
アダプタがリコースアクションを実行する前に送信する否定応答の最大数を指定します (表 1–70 の表の「NAK 送信の最大回数に達したときのアクション」を参照)。 このパラメータは、インバウンドコラボレーションコードで使用されます。 |
リコースアクションの実行前にアダプタから送信される NAK の適切な最大数を示す整数。 デフォルト値は 30 です。 |
|
アダプタがリコースアクションを実行する前に送信する Canned 否定応答の最大数を指定します (表 1–70 の表の「NAK 送信の最大回数に達したときのアクション」を参照)。 |
リコースアクションの実行前に送信する Canned NAK の適切な最大数。0 は、アダプタが Canned NAK の作成または送信を試みないことを示します。 デフォルト設定は 3 です。 |
|
メッセージジャーナルを有効にするかどうかを指定します。 このパラメータは、インバウンドコラボレーションコードで使用されます。 |
true または false。true は、ジャーナルを有効にすることを示します。 デフォルト設定は true です。 |
「HL7 リコースアクション」セクションは、設定された制約の範囲外で処理が行われた際にアダプタが実行するアクションを決定します。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、表 1–70 に示す最上位パラメータが含まれています。
表 1–70 接続マップ - HL7 リコースアクション
名前 |
説明 |
必要な値 |
---|---|---|
割り当てられた時間内に外部システムから ACK が受信されなかった場合にアダプタが実行するアクションを指定します。時間の長さは、「応答待機時間」パラメータによって決まります (表 1–69 の表の「応答待機時間」を参照)。オプションは次のとおりです。
|
「終了」、「再送信」、または「リセット」。 デフォルト設定は「リセット」です。 |
|
アダプタが外部システムへのメッセージ送信を許可された最大回数だけ試みても外部システムから応答 (HL7 アプリケーション肯定応答) がまったく得られなかった場合にアダプタが実行するアクションを指定します。アダプタが応答が得られないままメッセージを送信する最大回数は、「応答なしの最大回数」パラメータによって決まります (表 1–69 の表の「応答なしの最大回数」を参照)。オプションは次のとおりです。
|
「終了」または「リセット」。 デフォルト値は「リセット」です。 |
|
「空読み取りの最大再試行回数」パラメータに設定された空読み取りの上限に達したあとでアダプタが実行するアクションを指定します。このパラメータを使用するのは、インバウンドアダプタだけです。リコースオプションは次のとおりです。
|
「終了」または「リセット」。 デフォルト設定は「リセット」です。 |
|
アダプタが外部システムから HL7 アプリケーション NAK を受信した際に実行するアクションを指定します。オプションは次のとおりです。
|
「再送信」、「リセット」、または「メッセージをスキップ」。 デフォルト設定は「再送信」です。 |
|
「NAK 受信の最大試行回数」パラメータ (表 1–69 の表の「NAK 受信の最大試行回数」を参照) で設定された HL7 アプリケーション NAK の最大数が外部システムから受信された場合にアダプタが実行するアクションを指定します。オプションは次のとおりです。
|
「終了」、「リセット」、または「メッセージをスキップ」。 デフォルト設定は「メッセージをスキップ」です。 |
|
NAK 送信の最大試行回数 パラメータ (表 1–69 の表の「NAK 送信の最大試行回数」を参照) で設定された最大許容数の NAK をアダプタが外部システムに送信した場合に、アダプタが実行するアクションを指定します。オプションは次のとおりです。
|
「終了」または「リセット」。 デフォルト値は「終了」です。 |
接続マップからアクセスされる TCP/IP HL7 サーバーアウトバウンドアダプタの設定プロパティーは、次の各セクションに編成されています。
一般的な HL7 アウトバウンド設定を提供します。TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–71 接続マップ - 一般アウトバウンド設定
名前 |
説明 |
必要な値 |
---|---|---|
プログラムの内部に格納できるデータの最大サイズを指定します。有効な範囲は、1 から 2G バイト (Java の整数の最大値) までです。 |
1 から 2147483647 (2G バイト) の範囲内で、最大サイズをバイトで示す整数。デフォルト設定は 2147483647 です。 |
|
OTD ノードである State オブジェクトのスコープを定義するために使用されます。このパラメータの有効なオプションは、次のとおりです。
|
「リソースアダプタレベル」、「接続レベル」、または「OTD レベル」を選択します。デフォルト設定は「リソースアダプタレベル」です。 |
Java の Socket のオプションを提供します。詳細については、JDK の Javadoc を参照してください。TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–72 接続マップ - TCPIP アウトバウンド設定
名前 |
説明 |
必要な値 |
---|---|---|
アダプタによる TCP/IP 接続の確立方法を指定します。
|
「クライアント」または「サーバー」を選択します。「サーバー」モードが特に必要でないかぎり、この値はデフォルトの「クライアント」のままにしておいてください。 |
|
ServerSocket の SoTimeout の値をミリ秒で設定または取得します。ServerSocket.accept() で使用されます。 このオプションをゼロ以外のタイムアウトに設定すると、この ServerSocket の accept() を呼び出した際に、その期間だけブロックが発生します。タイムアウトの期限が切れると、java.net.SocketTimeoutException (または java.net.InterruptedIOException) がスローされますが、ServerSocket は有効なままです。 ブロック動作に入る前に、このオプションを有効にしてください。このパラメータが使用されるのは、「接続タイプ」が「サーバー」に設定されている場合だけです。 |
SoTimeout の値 (ミリ秒)。このタイムアウトは 0 (ゼロ) より大きくする必要があります。ゼロのタイムアウトは、タイムアウトが無限であると解釈されます。 デフォルト設定は 60000 (60 秒) です。 |
|
クライアントの SO_KEEPALIVE オプションが有効、無効のいずれであるかを指定します。ある TCP ソケットでこのオプションが設定されており、そのソケット経由で2 時間、どちらの方向にもデータがまったく交換されなかった場合、TCP は自動的に KEEPALIVE プローブをピアに送信します (実際の値は実装に依存する)。このプローブは TCP セグメントであり、ピアはこれに応答する必要があります。次の 3 つの応答のいずれかが予期されます。
|
true または false。true は、SO_KEEPALIVE オプションが有効であることを示します。 |
|
現在のソケットの SO_RCVBUF オプションの値を設定または取得します。これは、オペレーティングシステムがこのソケットの入力用に使用するバッファーのサイズです。これは、プラットフォームが受信ネットワーク入出力用に使用する配下のバッファーの概算サイズを提供します。 これを設定に使用すると、その値は、このソケット経由で受信されるデータ用に使用するバッファーのサイズに関する、アプリケーションからカーネルへの提案値になります。これを取得に使用すると、プラットフォームがこのソケット上でのデータ受信時に使用するバッファーの実際のサイズが返されます。 |
受信バッファーサイズを示す数値。 デフォルト設定は 8192 です。 |
|
現在のソケットの SO_SNDBUF オプションの値を設定または取得します。これは、オペレーティングシステムがこのソケットの出力用に使用するバッファーのサイズです。これは、プラットフォームが送信ネットワーク入出力用に使用する配下のバッファーの概算サイズを提供します。 これを設定に使用すると、その値は、このソケット経由で送信されるデータ用に使用するバッファーのサイズに関する、アプリケーションからカーネルへの提案値になります。これを取得に使用すると、プラットフォームがこのソケット上でのデータ送信時に使用するバッファーの実際のサイズが返されます。 |
送信バッファーサイズを示す数値。 デフォルト設定は 8192 です。 |
|
アダプタが linger-on-close タイムアウトを実行するかどうかを指定します。このオプションは、TCP Socket の close() からの即時リターンを無効化/有効化します。このパラメータは「SoLinger タイムアウト」と組み合わせて使用されます。
|
true または false。true の場合、SO_Linger オプションが有効になります。 |
|
サーバーの SoLinger タイムアウトを秒で指定します。「SoLinger タイムアウト」は「linger-on-close」タイムアウトを設定するために、「SoLinger」 (「SoLinger」プロパティーを参照) と組み合わせて使用されます。 「SoLinger」が true (有効) に設定された場合、「SoLinger タイムアウト」値の意味は、次のようになります。
|
-1 から 65535 までの整数。 値 -1 秒は、「SoLinger」オプションを無効にする (false に設定する) ことを示します。 値 0 (ゼロ) は、SoLinger が即時に強制的なクローズを実行することを示します。 値 1 から 65535 までは、タイムアウトの秒数を示します。 デフォルト設定は -1 秒です。 |
|
SoTimeout |
SoTimeout の値をミリ秒で設定または取得します。このオプションをゼロ以外のタイムアウトに設定すると、このソケットに関連付けられた InputStream 上で read() を呼び出した際に、設定された時間の間だけブロックが発生します。 タイムアウトの期限が切れると、java.io.InterruptedIOException (または java.net.SocketTimeoutException) がスローされますが、Socket は有効なままです。ブロック動作に入る前に、このオプションを有効にしてください。 |
SoTimeout の値 (ミリ秒)。このタイムアウトはゼロ (0) より大きくする必要があります。ゼロのタイムアウトは、タイムアウトが無限であると解釈されます。 デフォルト設定は 10000 (10 秒) です。 |
サーバーの TcpNoDelay オプション (つまり、Nagle のアルゴリズム) が有効、無効のいずれであるかを指定します。
|
true または false を選択します。 デフォルト設定は false です。 |
|
ソケットファクトリを実装した Java クラスの名前を指定します。このクラスは、ソケットを作成するために使用されます。ユーザー独自のソケット実装を用意した場合には、その実装を含む Java クラスの名前をここで入力します。ファクトリ実装クラスは、次のインタフェースを実装する必要があります。 com.stc.connector.tcpip.model.factory.TCPIPSocketFactory |
Java クラス名。 デフォルト値は次のとおりです com.stc.connector.tcpip.model.factory.TCPIPSocketFactoryImpl |
「TCPIP アウトバウンド設定」 - 「クライアント接続の確立」セクションは、接続の確立を制御するために使用される構成パラメータを定義します。これらのプロパティーが使用されるのは、「接続タイプ」が「クライアント」の場合だけです。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–73 接続マップ - TCPIP アウトバウンド設定 - クライアント接続の確立
名前 |
説明 |
必要な値 |
---|---|---|
外部システムへの接続を試みるまでにアダプタが待機する時間の長さ (ミリ秒) を指定します。 |
アダプタが接続を試みるまでの待機時間の長さをミリ秒で示す整数。 デフォルト設定は 0 です。 |
|
アダプタが接続確立要求の受信時に常に新しい接続の作成を試みるかどうかを指定します。
|
true または false を選択します。 デフォルト設定は false です。 |
|
アダプタが条件に一致する接続をコンテナから取得したが、その接続が、外部アプリケーションのロジックのために外部側の接続がクローズ/リセットされるなど、さまざまな理由により有効でなくなっていた場合に、再接続を自動的に試みるかどうかを指定します。
|
true または false を選択します。 デフォルト設定は true です。 |
|
アダプタが特定の外部 TCP/IP 宛先 (ホスト/ポート) への接続を試みる最大回数を指定します。この回数を超えるとアダプタは接続をあきらめます。 |
アダプタが接続を試みる回数を示す整数。 デフォルト設定は 3 です。 |
|
特定の外部 TCP/IP 宛先 (ホスト/ポート) への複数の接続試行間でのアダプタの待機時間の長さ (ミリ秒) を指定します。 |
複数の接続試行間でのアダプタの待機時間の長さをミリ秒で示す整数。 デフォルト設定は 30000 (つまり 30 秒) です。 |
サーバーポートのバインディングを制御するために使用される構成パラメータを指定します。これらのプロパティーが使用されるのは、「接続タイプ」が「サーバー」の場合だけです。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–74 接続マップ - TCPIP アウトバウンド設定 - サーバーポートのバインディング
名前 |
説明 |
必要な値 |
---|---|---|
localhost 上の指定された TCP/IP ポートへのバインドを、アダプタがあきらめてしまう前に試みる最大回数を指定します。 |
localhost 上の指定された TCP/IP ポートへのバインドをアダプタが試みる回数を示す整数。 デフォルト設定は 3 です。 |
|
localhost 上の指定された TCP/IP ポートへの複数のバインド試行間での、アダプタの待機時間の長さ (ミリ秒) を指定します。 |
指定された TCP/IP ポートへの複数のバインド試行間の時間の長さをミリ秒で示す整数。 デフォルト設定は 30000 (30 秒) です。 |
アプリケーション肯定応答イベントの処理方法を制御する HL7 肯定応答設定を提供します。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–75 接続マップ - HL7 肯定応答
名前 |
説明 |
必要な値 |
---|---|---|
外部アプリケーションがメッセージの受信に成功したあとで HL7 アプリケーション肯定応答を送信するように設定するか、あるいはアプリケーションデータベースにメッセージが正常にコミットされたあとで肯定応答を送信するように設定するかを指定します。有効なレベルは次のとおりです。
|
「A」または「C」。 デフォルト設定は「A」です。 |
|
インバウンド、アウトバウンドの両方のコラボレーションで使用されます。
|
true または false。 デフォルト設定は false です。 |
|
HL7 アプリケーション肯定応答をアプリケーションサーバーに転送するかどうかを指定します。HL7 アプリケーション肯定応答を受信した場合、HL7 アプリケーション肯定応答の内容を、アプリケーションサーバーに (データとして) 転送する必要がある場合があります。
|
true または false。 デフォルト設定は false です。 |
|
遅延 ACK のタイムアウト値をミリ秒で指定します。 このパラメータは、アウトバウンドコラボレーションコードで使用されます。 |
タイムアウトをミリ秒で示す整数。 デフォルト設定は 30000 です。 |
下位層プロトコル (LLP) の設定を提供します。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–76 接続マップ - 下位層プロトコル
名前 |
説明 |
必要な値 |
---|---|---|
LLP (Lower Layer Protocol) のタイプを指定します。有効なタイプは次のとおりです。
|
「MLLP」、「HLLP」、または「MLLP v2.0」。 「MLLP」がデフォルト設定値になります。 |
|
開始ブロック文字 (HL7 エンベロープ内の最初のエンベロープマーカー文字) を、10 進 ASCII 番号として指定します。 |
1 から 127 までの範囲内の 10 進数。競合が存在するのでないかぎり、値は ASCII の VT (10 進の 11) にすべきです。 デフォルト値は 11 です。 |
|
終了データ文字 (HL7 エンベロープ内の最後のエンベロープマーカー文字の 1 つ前の文字) を、10 進 ASCII 番号として指定します。指定可能な範囲は、1 から 127 までです。 |
1 から 127 までの範囲内の 10 進数。競合が存在するのでないかぎり、値は ASCII の FS (10 進の 28) にすべきです。 デフォルト値は 28 です。 |
|
終了ブロック文字 (HL7 エンベロープ内の最後のエンベロープマーカー文字) を、10 進 ASCII 番号として指定します。 |
1 から 127 までの範囲内の 10 進数。HL7 標準に厳格に準拠するには、このパラメータをキャリッジリターン (10 進の 13) に設定する必要があります。 デフォルト値は 13 です。 |
|
HLLP (Hybrid Lower Level Protocol) チェックサムが有効、無効のいずれであるかを指定します。 |
true または false。true は、HLLP チェックサムが有効であることを示します。 デフォルト設定は true です。 |
|
アダプタがピアから MLLP v2.0 コミット否定応答を受信した際にメッセージの送信を試みる回数の最大値。この回数のあと、アダプタは送信をあきらめます。 このパラメータは、アウトバウンドモードの HL7 アダプタによって使用されます。 |
アダプタがピアから MLLP v2.0 コミット否定応答を受信した際にメッセージの送信を試みる回数を示す整数。 デフォルト設定値は 5 です。 |
シーケンス番号プロトコルの設定を提供します。
アダプタのパラメータの多くが、データの移動方向、つまりアダプタがアプリケーションサーバーに対してインバウンド、アウトバウンドのいずれであるか、に固有のものとなっています。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–77 接続マップ - シーケンス番号プロトコル
名前 |
説明 |
必要な値 |
---|---|---|
シーケンス番号プロトコルが有効、無効のいずれであるかを指定します。HL7 のシーケンス番号付けは、データの重複を回避しやすくするために使用されます。true は、シーケンス番号が有効であることを示します。 |
true または false。 デフォルト設定は true です。 |
HL7 MSH ヘッダーセグメントの設定を提供します。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–78 接続マップ - HL7 肯定応答
名前 |
説明 |
必要な値 |
---|---|---|
セグメント ID と実際の先頭フィールドとの間の区切り文字を指定します。この値は、メッセージの残りの部分の区切り文字として使用される文字を定義します。 これは、HL7 MSH セグメント内の 1 番目のフィールド (MSH-01) です。 |
10 進 ASCII 番号としてのフィールド区切り文字値。指定可能な範囲は、1 から 127 までです。 デフォルト設定は 124 ですが、これは文字「|」です。 |
|
4 つのエンコーディング文字を次の順番で指定します。
|
対応する順番に並べられた HL7 エンコーディング文字。 デフォルト設定は「^~\& (それぞれ ASCII の 94、126、92、38)」です。 |
|
ネットワークエンタープライズ内の各種アプリケーションの中で、送信アプリケーションを指定します。ネットワークエンタープライズは、企業内での HL7 メッセージの交換に参加するアプリケーションから構成されます。 これは、HL7 MSH セグメント内の 3 番目のフィールド (MSH-03) です。 |
HL7 送信アプリケーション用のユーザー定義値。 デフォルト設定は「Sun HL7 adapter」です。 |
|
さまざまな組織の代わりに動作する同一アプリケーションの複数インスタンスの中で、送信アプリケーションを指定 (さらに特定) します。 これは、HL7 MSH セグメント内の 4 番目のフィールド (MSH-04) です。 |
HL7 送信施設用のユーザー定義値。 デフォルト設定は「Sun HL7 adapter」です。 |
|
ネットワークエンタープライズ内の各種アプリケーションの中で、受信アプリケーションを指定します。ネットワークエンタープライズは、企業内での HL7 メッセージの交換に参加するアプリケーションから構成されます。 これは、HL7 MSH セグメント内の 5 番目のフィールド (MSH-05) です。 |
HL7 受信アプリケーション用のユーザー定義値。 デフォルト設定は「Sun HL7 adapter」です。 |
|
さまざまな組織の代わりに動作する同一アプリケーションの複数インスタンスの中で、受信アプリケーションを指定 (さらに特定) します。 これは、HL7 MSH セグメント内の 6 番目のフィールド (MSH-06) です。 |
HL7 受信施設用のユーザー定義値。 デフォルト設定は「Sun HL7 adapter」です。 |
|
実装されたアプリケーションレベルのセキュリティー機能を指定します。 これは、HL7 MSH セグメント内の 8 番目のフィールド (MSH-08) です。 |
HL7 で開発中です。 |
|
MSH-11 のサブコンポーネント「処理 ID」を指定します。MSH-11 は、HL7 アプリケーション (レベル 7) 処理規則の定義に従ってメッセージが処理されるかどうかを示すために使用されます。 |
次のいずれかを入力します。
|
|
受信側のシステムが自身のバージョンと照合すべき特定の HL7 バージョンを指定します。 これは、HL7 MSH セグメント内の 12 番目のフィールド (MSH-12) です。 |
HL7 表 0104 - Version ID に表示される、HL7 標準のバージョン値。 デフォルト値は 2.5 です。 |
|
メッセージが作成された国を示すコードを指定します (HL7 表 0399 を参照)。通貨など、メッセージ内のデフォルト要素を指定するために使用されます。 これは、HL7 MSH セグメント内の 17 番目のフィールド (MSH-17) です。 |
国番号の値として、ISO 3166 の 3 文字 (アルファベット) 形式が使用されます。 デフォルト値は「USA」です。 |
|
メッセージで使用される文字セットを指定します (HL7 表 0211 を参照)。このフィールドを空白のままにすると、使用されている文字セットは 7 ビット ASCII セットであるとみなされます。 これは、HL7 MSH セグメント内の 18 番目のフィールド (MSH-18) です。 |
デフォルト設定は、「8859/1」 (印刷可能な 7 ビット ASCII 文字セット) です。使用可能な値とその説明については、HL7 表 0211 を参照してください。 |
|
メッセージの主な言語を指定します。コードは ISO 639 のものを使用します。 これは、HL7 MSH セグメント内の 19 番目のフィールド (MSH-19) です。 |
2 文字の ISO 639 アルファベットコード。 |
|
任意の代替文字セットが使用されるために特殊な処理方式が必要になった場合に使用すべき、代替文字セット処理方式の値を指定します (HL7 表 0356 を参照)。 これは、HL7 MSH セグメント内の 20 番目のフィールド (MSH-20) です。 |
使用可能な値は「ISO 2022-1994」、「2.3」、および「<null>」(空) です。このフィールドを空白のままにすると、文字セットの切り替えが行われなくなります。 |
|
適合性ステートメント ID (V2.5 のメッセージプロファイル識別子) は、クエリーの適合性ステートメントに適用される一意の識別子であるか、あるいはメッセージプロファイル識別子として、あるメッセージプロファイルへの準拠 (文法、構文、使用方法など) を主張します。 これは、HL7 MSH セグメント内の 21 番目のフィールド (MSH-21) です。 |
HL7 適合性ステートメント ID の値。あるいは空白のままにします。 |
|
インバウンドの場合はデータメッセージの MSH セグメント、アウトバウンドの場合は ACK の MSH セグメントを検証するかどうかを指定します。 このパラメータは、アウトバウンドコラボレーションコードで使用されます。 注 – このプロパティーは、HL7 メッセージ自身の全体の構造検証には影響を与えません。構造検証は常に実行されます。 |
true または false。true は、コラボレーションが MSH セグメントを検証することを示します。 デフォルト設定は true です。 |
HL7 SFT セグメントの設定を提供します。SFT セグメントは HL7 version 2.5 以降で使用できます。このセグメントは、送信アプリケーションとして使用される 1 つ以上のソフトウェア製品に関する追加情報を提供します。このセグメントの主な目的は、診断用途です。サイト固有の契約に基づくその他の用途も考えられます。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–79 接続マップ - HL7 SFT セグメント
名前 |
説明 |
必要な値 |
---|---|---|
省略可能な SFT セグメントを ACK メッセージ内で有効にするかどうかを指定します。 注 – 「有効化」を true に設定した場合、HL7 のバージョンが 2.5 として設定されていなければ、アダプタの起動時にエラーが発生します。 |
true または false。true は、SFT セグメントを有効にすることを示します。 デフォルト設定は true です。 |
|
HL7 セグメント SFT-01、具体的にはこのトランザクションを作成した送信ソフトウェアの発行または配布、あるいはその両方を行う企業の名前、を指定します。このフィールドとこのセグメントの残りのフィールドの目的は、送信アプリケーションのより完全なプロファイルを提供することです。 「ソフトウェアベンダー組織」フィールドは、アプリケーションを保守する責任があるベンダーを特定します。 |
送信ソフトウェアの発行元またはベンダーの名前。 デフォルト設定は「Sun Microsystems, Inc.」です 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-02、具体的には送信システムの最新のソフトウェアバージョン番号またはリリース番号である「ソフトウェア認定バージョン番号またはリリース番号」、を指定します。送信システムの最新のソフトウェアバージョン番号またはリリース番号があれば、HL7 メッセージを送信または受信しているアプリケーションのより完全なプロファイルを提供しやすくなります。 バージョン番号は、特定「リリース」のアプリケーションを識別する際に重要となります。場合によっては、受信アプリケーションが特定のソフトウェアの「認定」されたバージョンまたはリリースのリストに基づいて、このソフトウェア認定バージョン番号またはリリース番号を検証することもあります。これにより、受信アプリケーションが必要とする特定のビジネスルールに送信アプリケーションが準拠しているかどうかを判断しやすくなります。あるいは、送信ソフトウェアのバージョンに応じて異なる処理をソフトウェアに実行させることもできます。 |
ソフトウェア認定バージョン番号またはリリース番号。 デフォルト設定は 6.0.0 です。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-03、具体的にはこのトランザクションを送信したソフトウェア製品の名前、を指定します。ソフトウェア製品名は、送信アプリケーションを特定する際に重要となる要素の 1 つです。 |
送信ソフトウェア製品名。デフォルト値は「HL7 adapter」です。 デフォルト設定は「Sun TCP/IP HL7 adapter Intelligent Adapter」です。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-04、具体的にはソフトウェアバイナリ ID、を指定します。このプロパティーは、HL7 version 2.5 以降で使用できます。ソフトウェアバイナリ ID は、ベンダーによって一意のソフトウェアバージョンインスタンスごとに発行されます。 これらの ID は、同じソフトウェアの異なるバージョンを区別するために使用されます。ソフトウェア ID は、一意のソフトウェアバージョンインスタンスごとに発行されます。主要 ID が同じであれば、ソフトウェアがバイナリレベルで同じであることになりますが、設定は異なる可能性があります。 |
一意のソフトウェアバイナリ ID。 デフォルト設定は 6.0.0 です。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-05、具体的にはソフトウェア製品の識別情報、を指定します。これには、ソフトウェアアプリケーションの説明、設定、ソフトウェアに施された変更など含めることができます。このフィールドには、送信アプリケーションとそれが送信したトランザクションに関する任意の追加情報を含めることができます。 この情報は診断目的に使用されますが、それにより、アプリケーションソフトウェアの識別をより柔軟に行える可能性があります。 |
特定の送信ソフトウェアの識別に役立つ可能性のある情報。このフィールドを使用するのは、診断を実行する場合だけにすべきです。 デフォルト値は、「これは、TCP/IP 接続経由での HL7 用 JCA アダプタです」です。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
|
HL7 セグメント SFT-06、具体的にはソフトウェアインストール日付、を指定します。これは、送信ソフトウェアが送信側のサイトにインストールされた日付です。ソフトウェアインストール日付はそれだけで、アプリケーションの動作に関する重要な情報になることも少なくありません。これは、送信アプリケーションのより完全なプロファイルを提供するために必要です。 |
送信アプリケーションソフトウェアのインストール日付。 注 – このプロパティーは、HL7 version 2.5 または HL7 version 2.5.1 に適用されます。 |
TCP/IP 接続上でのデータ転送 (送信/受信) を制御します。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–80 接続マップ - 通信制御
名前 |
説明 |
必要な値 |
---|---|---|
アダプタがリコースアクションを実行する前に外部システムからの応答を待つ時間の長さ (ミリ秒) を指定します (表 1–81 の表の「応答なし時のアクション」を参照)。外部システムからのデータはすべて、応答とみなされます。 このプロパティーは、初回の読み取り/受信処理のタイムアウトに対応しています。いったん応答が受信されると、後続の読み取り/受信処理では、「SoTimeout」に指定されたタイムアウトが使用されます (表 1–72 の表の「So Timeout」を参照)。 |
アダプタが外部システムからの応答を待つ時間の長さをミリ秒で示す整数。値 0 (ゼロ) は、タイムアウトが無限であると解釈されます。 デフォルト設定は 30000 (30 秒) です。 |
|
読み取り/受信処理から何も返されなくなったあと、アダプタが外部システムからのデータの読み取りを試みる最大回数を指定します。これは、応答が到着し始めたあとの読み取りまたは受信処理に適用されます。 「空の読み取り」は、読み取り/受信処理でタイムアウトが発生したことを意味しますが、その際には、「TCPIP インバウンド設定」セクションの「SoTimeout」パラメータが、適用されるタイムアウト設定として使用されます (表 1–72 の表の「So Timeout」を参照)。 対応するリコースアクションは、表 1–81 の表の「読み取り失敗の最大試行回数に達したときのアクション」で指定されます。 |
最大試行回数を示す整数。 デフォルト設定は 5 です。 |
|
アダプタが外部システムからのデータを待っている間に許可する、応答タイムアウトの最大数を指定します。この数を超えるとリコースアクションが実行されます。 このパラメータは、アウトバウンドアダプタによってのみ使用され、表 1–81 の表のリコースアクションパラメータ「応答なし時のアクション」の「再送信」オプションと連携して動作します。これは、後続のリコースアクションを実行する前に、指定された最大回数に達するまで最後のメッセージを再送信するように、アダプタを設定します。 |
リコースアクションが実行される前に発生可能な適切な回数を示す整数。 デフォルト値は 5 です。 |
|
アダプタがリコースアクションを実行する前に受信する否定応答の最大数を指定します (表 1–81 の表の「NAK 受信の最大回数に達したときのアクション」を参照)。 このパラメータは、アウトバウンドコラボレーションコードで使用されます。 |
リコースアクションの実行前に受信される NAK の適切な最大数を示す整数。 デフォルト値は 5 です。 |
|
アダプタがリコースアクションを実行する前に送信する否定応答の最大数を指定します (表 1–81 の表の「NAK 送信の最大回数に達したときのアクション」を参照)。 |
リコースアクションの実行前にアダプタから送信される NAK の適切な最大数を示す整数。 デフォルト値は 5 です。 |
|
アダプタがリコースアクションを実行する前に送信する Canned 否定応答の最大数を指定します (表 1–81 の表の「NAK 送信の最大回数に達したときのアクション」を参照)。 |
リコースアクションの実行前に送信する Canned NAK の適切な最大数。0 は、アダプタが Canned NAK の作成または送信を試みないことを示します。 デフォルト値は 3 です。 |
|
メッセージジャーナルを有効にするかどうかを指定します。 このパラメータは、アウトバウンドコラボレーションコードで使用されます。 |
true または false。true は、ジャーナルを有効にすることを示します。 デフォルト値は false です。 |
設定された制約の範囲外で処理が行われた際にアダプタが実行するアクションを決定します。
TCP/IP HL7 アウトバウンドアダプタの接続マッププロパティーのこのセクションには、次の表に示す最上位パラメータが含まれています。
表 1–81 接続マップ - HL7 リコースアクション
名前 |
説明 |
必要な値 |
---|---|---|
割り当てられた時間内に外部システムから ACK が受信されなかった場合にアダプタが実行するアクションを指定します。時間の長さは、「応答待機時間」パラメータによって決まります (表 1–80 の表の「応答待機時間」を参照)。オプションは次のとおりです。
|
「終了」、「再送信」、または「リセット」。 デフォルト設定は「リセット」です。 |
|
アダプタが外部システムへのメッセージ送信を許可された最大回数だけ試みても外部システムから応答 (HL7 アプリケーション肯定応答) がまったく得られなかった場合にアダプタが実行するアクションを指定します。アダプタが応答が得られないままメッセージを送信する最大回数は、「応答なしの最大回数」パラメータによって決まります (表 1–80 の表の「応答なしの最大回数」を参照)。オプションは次のとおりです。
|
「終了」または「リセット」を選択します。 デフォルト値は「リセット」です。 |
|
「空読み取りの最大再試行回数」パラメータに設定された空読み取りの上限に達したあとでアダプタが実行するアクションを指定します。リコースオプションは次のとおりです。
|
「終了」または「リセット」を選択します。 デフォルト設定は「リセット」です。 |
|
アダプタが外部システムから HL7 アプリケーション NAK を受信した際に実行するアクションを指定します。オプションは次のとおりです。
|
「再送信」、「リセット」、または「メッセージをスキップ」を選択します。 デフォルト設定は「再送信」です。 |
|
「NAK 受信の最大試行回数」パラメータ (表 1–80 の表の「NAK 受信の最大試行回数」を参照) で設定された HL7 アプリケーション NAK の最大数が外部システムから受信された場合にアダプタが実行するアクションを指定します。オプションは次のとおりです。
|
「終了」、「リセット」、または「メッセージをスキップ」を選択します。 デフォルト設定は「メッセージをスキップ」です。 |
|
NAK 送信の最大試行回数 パラメータ (表 1–80 の表の「NAK 送信の最大試行回数」を参照) で設定された最大許容数の NAK をアダプタが外部システムに送信した場合に、アダプタが実行するアクションを指定します。オプションは次のとおりです。
|
「終了」または「リセット」を選択します。 デフォルト値は「終了」です。 |
インバウンドプロパティー設定によって、アダプタの入力処理動作が決まります。
接続マップからアクセスされる TCP/IP インバウンドアダプタの構成パラメータは、次の各セクションに編成されています。
次の節では、アダプタのアップグレードについて簡単に説明します。
「一般インバウンド設定」プロパティーは、サーバーの専用セッションモードおよび最大データサイズメッセージ設定を提供します。このセクションには、表 1–82 に示す最上位パラメータが含まれています。
表 1–82 接続マップ - 一般インバウンド設定
名前 |
説明 |
必要な値 |
---|---|---|
プログラムの内部に格納できるデータの最大サイズを定義できるようにします。 |
有効な範囲は、1 から 2G バイト (Java の整数の最大値) までです。 デフォルト設定は 2147483647 です。 |
|
OTD ノードである State オブジェクトのスコープを定義します。このパラメータのオプションは、次のとおりです。
|
次のいずれかを選択します。
デフォルト設定は「リソースアダプタレベル」です。 |
|
アダプタの専用セッションモードを有効化または無効化できるようにします。サーバーで専用セッションモードが有効になっている場合、現在のクライアントの要求が接続先のサーバーポートを占有することができます。 たとえば、このプロパティーが有効になった状態でクライアントがサーバーに接続した場合、作業が完了してセッションが切断されるまで、サーバーはそのクライアントだけにサービスを提供します。 この期間内に別のクライアントがサーバーへの接続を試みても、セッションが完了するまでそのクライアントは接続を行えません。 |
true または false を選択します。true は、専用セッションモードが有効であることを示します。 デフォルト設定は false です。 |
「TCPIPインバウンド設定」プロパティーは、サーバーの基本的な TCP/IP 値を提供します。「TCP/IP インバウンド設定」プロパティーには、表 1–83 に示す最上位パラメータが含まれています。
表 1–83 接続マップ - TCPIP インバウンド設定
名前 |
説明 |
必要な値 |
||
---|---|---|---|---|
アダプタによる TCP/IP 接続の確立方法を指定します。
|
「クライアント」または「サーバー」。「サーバー」がデフォルト設定です。「クライアント」モードが特に必要でないかぎり、この値はデフォルトの「サーバー」のままにしておいてください。 |
|||
サーバーの SO_TIMEOUT 値をミリ秒で設定または取得できるようにします。 |
サーバーの SO_TIMEOUT 値の単位はミリ秒です。 デフォルト値は 10000 ミリ秒 (10 秒) です。 |
|||
サーバーソケットファクトリを実装した Java クラスの名前を入力します。このクラスは、サーバーソケットを作成するために使用されます。ユーザー独自のサーバーソケット実装を用意した場合には、その実装を含む Java クラスの名前を入力します。ファクトリ実装クラスは、次のインタフェースを実装する必要があります。
|
有効な Java クラス名。デフォルトは次のとおりです。
|
|||
サーバーの SO_KEEPALIVE オプションが有効、無効のいずれであるかを指定します。これは、受け付けられたクライアントソケットで使用されます。 注 – 一部のプロパティーについては、その設定がサーバーソケット自体には直接関連付けられません。代わりに、プロパティーマップには、受け付けられたクライアントソケットに関連付けられた直接的なプロパティー設定が含まれます。 |
true または false。true は、サーバーの SO_KEEPALIVE オプションが有効であることを示します。 デフォルト設定は true です。 |
|||
現在のソケットに対するサーバーの SO_RCVBUF オプションの値を設定または取得できるようにします。これは、オペレーティングシステムがこのソケットの入力用に使用するバッファーのサイズです。これは、受け付けられたクライアントソケットで使用されます。 |
受信バッファーサイズを示す数値。 デフォルト設定は 8192 です。 |
|||
現在のソケットに対するサーバーの SO_SNDBUF オプションの値を設定または取得できるようにします。これは、オペレーティングシステムがこのソケットの出力用に使用するバッファーのサイズです。これは、受け付けられたクライアントソケットで使用されます。 |
送信バッファーサイズを示す数値。 デフォルト設定は 8192 です。 |
|||
サーバーの SO_LINGER オプションが有効、無効のいずれであるかを指定します。受け付けられたクライアントソケットで使用されます。 |
true または false。true の場合、SO_Linger オプションが有効になります。 デフォルト設定値は true です。 |
|||
サーバーの linger タイムアウトを秒で指定します。タイムアウトの最大値はプラットフォームに固有となります。この設定はソケットのクローズにのみ影響を与えます。受け付けられたクライアントソケットで使用されます。 |
linger タイムアウト (秒)。デフォルト設定は 30 秒ですが、これは、SO_LINGER オプションが無効であることを示します。 |
|||
サーバーの SO_TIMEOUT 値をミリ秒で設定または取得できるようにします。受け付けられたクライアントソケットで使用されます。 タイムアウト 0 (ゼロ) は、タイムアウトが無限であることを示します。この値を指定すると、アダプタは読み取りをいつまでも続けます。このアクションが発生すると、そのことがアダプタのログファイルに記録されます。 |
SO_TIMEOUT 値 (ミリ秒)。 デフォルト設定値は 10000 ミリ秒 (10 秒) です。 |
|||
サーバーの TCP_NODELAY オプション (つまり、Nagle のアルゴリズム) が有効、無効のいずれであるかを指定します。受け付けられたクライアントソケットで使用されます。 |
true または false。true を選択すると、TCP_NODELAY オプションが有効になります。 デフォルト設定値は false です。 |
「サーバーポートのバインディング」セクションは、サーバーポートバインディングの制御に使用されるパラメータを定義します。「TCP/IP インバウンド設定」 — 「サーバーポートのバインディング」プロパティーには、表 1–84 に示す最上位パラメータが含まれています。
表 1–84 接続マップ - TCPIP インバウンド設定 - サーバーポートのバインディング
名前 |
説明 |
必要な値 |
---|---|---|
localhost 上の指定された TCP/IP ポートへのバインドをアダプタが試みる最大回数を指定します。 |
バインドの試行回数を示す整数。 デフォルト設定は 3 です。 |
|
localhost 上の指定された TCP/IP ポートへの複数のバインド試行間での、アダプタの待機時間の長さ (ミリ秒) を指定します。 |
複数の試行間でのアダプタの待機時間の長さをミリ秒で示す整数。 デフォルト設定は 30000 (30 秒) です。 |
「クライアント接続の確立」プロパティーは、接続の確立を制御するために使用される構成パラメータをいくつか定義します。このセクションが使用されるのは、「接続タイプ」が「クライアント」に設定されている場合だけです。
TCP/IP インバウンドアダプタの接続マッププロパティーのこのセクションには、表 1–85 に示す最上位パラメータが含まれています。
表 1–85 接続マップ - TCPIP インバウンド設定 - クライアント接続の確立
名前 |
説明 |
必要な値 |
---|---|---|
外部システムへの接続を試みるまでにアダプタが待機する時間の長さ (ミリ秒) を指定します。 |
アダプタが外部システムへの接続を試みるまでの待機時間の長さ (ミリ秒) を示す数値。 デフォルト設定は 30000 (30 秒) です。 |
「インバウンド接続の管理」プロパティーは、インバウンドサーバー接続の管理に使用されるパラメータを定義します。たとえば、受け付けられた接続の接続プールやライフサイクルなどです。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、表 1–86 に示す最上位パラメータが含まれています。
表 1–86 接続マップ - TCPIP インバウンド設定 - インバウンド接続の管理
名前 |
説明 |
必要な値 |
---|---|---|
指定された TCP/IP ポート上で待機しているかそのポートを監視している特定のリスナー/モニターに許可される、同時接続の最大数を指定します。これは、このサーバーのサービスの能力または可用性を表します。クライアントからの接続要求ごとに 1 つの同時接続が割り当てられます。また、このパラメータは、このサーバーのサービスに同時に接続し、特定のリスナー/モニターのサービスを同時に受けることができるクライアントの最大数も表します。 |
特定の TCP/IP ポートで 1 つのリスナー/モニターから使用可能な同時接続の最大数を示す数値。0 は、制限がないことを示します。 デフォルト設定は 50 です。 |
|
アダプタが使用している受け付けられた接続のスコープを指定します。次の 2 つのオプションがあります。
|
「リソースアダプタレベル」または「コラボレーションレベル」を選択します。 デフォルト設定値は「リソースアダプタレベル」です。 |
|
クローズ通知の値を指定します。サーバーは、このパラメータの値に一致する内容を含む通知を受け取ると、接続を安全に閉じ、対応するすべてのスケジュールを取り消します。 |
接続を閉じるようにサーバーに通知するトリガー値を示す文字列。 デフォルト設定は「QUIT」です。 |
|
リクエスタ (クライアント) の非活動時間の長さ (ミリ秒) を指定します。アダプタは、クライアント側 (接続の反対側) の活動状態の検出を試みます。指定された期間中にクライアントの活動がなかった場合 (その接続経由でクライアントから入出力要求が到着しなかった場合)、その接続はサーバー側から閉じられ、リソースが解放されます。値の単位はミリ秒です。 |
リクエスタ (クライアント) の非活動時間の長さ (ミリ秒) を示す整数。この時間を過ぎるとサーバー側から接続が閉じられ、リソースが解放されます。値 0 を指定すると、アイドルタイムアウトは無効になります。 デフォルト設定は 60000 (1 分) です。 |
このセクションでは、インバウンド TCP/IP サーバーによって使用されるスケジューラを設定します。サーバーは、新しいクライアント接続確立要求の到着を待ちます。これらのパラメータは、指定されたポート上で待機するリスナー/モニターを設定するために使用されます。
使用可能な J2EE スケジューラは次の 2 つです (「スケジューラ」を参照)。
タイマーサービス: このスケジューラの設定は、「固定レートで」、「遅延」、および「期間」プロパティーを使って行われます。
作業マネージャー: J2EE (JCA 1.5 以上) で使用可能です。このスケジューラの設定は、「遅延」および「期間」プロパティーを使って行われます。
どちらのスケジューラも、インバウンド TCP/IP サーバーが必要とする機能を提供します。
TCP/IP HL7 インバウンドアダプタの接続マッププロパティーのこのセクションには、表 1–87 に示す最上位パラメータが含まれています。
表 1–87 接続マップ - TCPIP インバウンドスケジュール - リスナースケジュール
名前 |
説明 |
必要な値 |
---|---|---|
このインバウンド通信のスケジューラのタイプを指定します。次の 2 つのオプションがあります。
|
「タイマーサービス」または「作業マネージャー」を選択します。使用するコンテナが JCA 作業マネージャーをサポートしていない場合は、「タイマーサービス」を選択します。 |
|
このプロパティーの設定は、プロパティーエディタから確認はできるものの、無効になっています。使用できるスケジュール型は「繰り返し」だけですが、これは、このセクションの「期間」プロパティー (「期間」を参照) で定義される一定間隔でタスクが繰り返し実行されるようにスケジューリングされることを示します。 |
このプロパティーは無効になっています。 |
|
タイマーサービスと作業マネージャーの両方に適用されます。タスクが実行されるまでの遅延時間の長さをミリ秒で指定します。 |
タスクが実行されるまでの時間の長さをミリ秒で示す整数 (1000 ミリ秒は 1 秒に等しい)。 |
|
連続する繰り返しタスク実行間の一定間隔をミリ秒で指定します。これは、「繰り返し」スケジュール型で使用されます。「スケジュール型」参照してください。タイマーサービスと作業マネージャーの両方に適用されます。 |
連続するタスク実行間の時間の長さをミリ秒で示す整数。 正の整数を入力します。デフォルト設定は 100 です。この値を小さくすると、1 秒あたりのトランザクション数が増える可能性があります。 |
|
タイマーサービスだけに固有です。固定レート実行、固定遅延実行のいずれを使用するかを指定します。
|
true または false。true は、固定レート実行が使用されることを示します。false は、固定遅延実行が使用されることを示します。 |
このセクションでは、既存の接続上でビジネスタスク (コラボレーションルール) を実行する TCP/IP サーバーによって使用されるスケジューラを設定します。このスケジューラは、ユーザーが定義した実際のビジネスルールに影響を与えます。
使用可能な J2EE スケジューラは次の 2 つです (「スケジューラ」を参照)。
タイマーサービス: このスケジューラは、「固定レートで」、「遅延」、「期間」、および「スケジュール型」プロパティーを使って設定されます。
作業マネージャー: J2EE (JCA 1.5 以上) で使用可能です。このスケジューラは、「遅延」、「期間」、および「スケジュール型」プロパティーを使って設定されます。
どちらのスケジューラも、インバウンド TCP/IP サーバーが必要とする機能を提供します。
TCP/IP インバウンドアダプタの接続マッププロパティーのこのセクションには、表 1–88 に示す最上位パラメータが含まれています。
表 1–88 接続マップ - TCPIP インバウンド設定 - サービススケジュール
名前 |
説明 |
必要な値 |
---|---|---|
このインバウンド通信のスケジューラのタイプを指定します。次の 2 つのオプションがあります。
|
「タイマーサービス」または「作業マネージャー」を選択します。使用するコンテナが JCA 作業マネージャーをサポートしていない場合は、「タイマーサービス」を選択します。 |
|
タイマーサービスと作業マネージャーの両方に適用されます。タスクが 1 回実行されるようにスケジューリングするか、あるいは繰り返し実行されるようにスケジューリングするかを指定します。
|
「1 回」または「繰り返し」を選択します。 |
|
タイマーサービスと作業マネージャーの両方に適用されます。タスクが実行されるまでの遅延時間の長さをミリ秒で指定します。 |
タスクが実行されるまでの時間の長さをミリ秒で示す整数 (1000 ミリ秒は 1 秒に等しい)。 |
|
連続する繰り返しタスク実行間の待機間隔をミリ秒で指定します。これは、スケジュール型が「繰り返し」の場合に使用されます (「スケジュール型」を参照)。タイマーサービスと作業マネージャーの両方に適用されます。 |
連続するタスク実行間の時間の長さをミリ秒で示す整数 (1000 ミリ秒は 1 秒に等しい)。 正の整数を入力します。デフォルト設定は 100 です。この値を小さくすると、1 秒あたりのトランザクション数が増える可能性があります。 |
|
タイマーサービスだけに固有です。固定レート実行、固定遅延実行のいずれを使用するかを指定します。これは、「タイマーサービス」スケジューラの「繰り返し」スケジュール型で使用されます。
|
true または false。true は、固定レート実行が使用されることを示します。false は、固定遅延実行が使用されることを示します。 |
TCP/IP インバウンドアダプタの接続マッププロパティーのこのセクションには、表 1–89 に示す最上位パラメータが含まれています。
表 1–89 接続マップ - TCPIP インバウンド設定 - エンベロープメッセージ
名前 |
説明 |
必要な値 |
||
---|---|---|---|---|
エンベロープタイプを指定します。エンベロープタイプは、メッセージの開始位置と終了位置を定義します。 |
エンベロープタイプを示す次のプロパティーのいずれかを入力します。
デフォルトは「開始と終了をマーク」です。 |
|||
「開始と終了をマーク」はプロパティー「読み取るバイト数」、「ignore-until 文字の値」、および「store-until 文字の値」によってサポートされます。 |
||||
「終了をマーク」はプロパティー「store-until 文字の値」によってサポートされます。 |
||||
「長さを固定」はプロパティー「読み取るバイト数」によってサポートされます。 |
||||
「長さを先頭に付加」はプロパティー「長さの幅」および「数値表現」によってサポートされます。 |
||||
「マークおよび固定」はプロパティー「読み取るバイト数」、「ignore-until 文字の値」、および「store-until 文字の値」によってサポートされます。 |
||||
「アクティブな接続ごと」はプロパティー「アクティブな接続ごと」によってサポートされます。 |
||||
「カスタム」はプロパティー「カスタムエンベロープクラス名」および「カスタム定義プロパティー」によってサポートされます。 注 – マークおよび固定を除くすべてのエンベロープタイプでは、データはペイロードにすぎません。このエンベロープタイプでのデータの処理方法については、「マークおよび固定」を参照してください。 |
||||
「エンベロープタイプ」プロパティーが「カスタム」に設定された場合に使用される Java クラス名を指定します。 Java クラスを使って作成したカスタムエンベロープを使用する場合、そのクラスを含む Java JAR ファイルを、コラボレーションエディタのファイルインポート機能を使って目的とする任意のコラボレーション内にインポートできます。 このクラス名は、com.abc.MyClass などの完全修飾クラス名にすべきです。このクラスが実装する必要のあるインタフェースは、次のとおりです
および
詳細については、「カスタマイズされたエンベロープ処理」を参照してください。 |
完全な Java クラス名。 完全修飾クラス名。「エンベロープタイプ」が「カスタム」でない場合は「なし」。 デフォルト設定は「なし」です。 |
|||
「エンベロープタイプ」の値が「カスタム」に設定された場合に使用されます。一連のユーザー定義パラメータを指定します。区切り文字を含むこの情報を解析し、カスタマイズされたエンベロープメッセージ実装を生成することができます。 |
テキスト文字列。 |
|||
次のエンベロープタイプで使用されます。
読み取るバイト数を指定します。アダプタが受信するイベントの長さはすべて同じであると仮定されています。 |
バイト数を示す整数。 デフォルト設定は 1 です。 |
|||
「エンベロープタイプ」の値が「長さを先頭に付加」の場合に使用されます。エンベロープ長の幅を指定します。言い換えると、これは、長さのフィールドを表現するために使用される桁数を指定します。 |
1 から 10 までの範囲の整数。このプロパティーは、「ネットワーク short」の場合は 2 に、「ネットワーク long」の場合は 4 に、それぞれ設定する必要があります。 デフォルト設定値は 1 です。 |
|||
「エンベロープタイプ」の値が「長さを先頭に付加」の場合に使用されます。先頭に付加される長さの数値をどのような方法で表現するかを指定します。この値は、次のいずれかの形式で表現されます。
|
次のいずれかを選択します。
デフォルト設定は「10 進数」です。 |
|||
エンベロープタイプ「開始と終了をマーク」および「マークおよび固定」で使用されます。ignore-until (開始ブロックと同じ) 文字の値を指定します。この文字が検出されるまで、すべての受信文字が無視されます。 |
10 進 ASCII 番号。指定可能な範囲は、1 から 127 までです。 デフォルト設定は 11 です。 |
|||
エンベロープタイプ「開始と終了をマーク」、「終了をマーク」、および「マークおよび固定」で使用されます。エンベロープの終了ブロックまたはマーカーの位置にある文字を指定します。この文字が検出されるまで、すべての受信文字が格納されます。 |
10 進 ASCII 番号。指定可能な範囲は、1 から 127 までです。 デフォルト設定は 12 です。 |
バージョン 6 では、新しいバージョンの設定テンプレートが使用されます。以前の 5.1.x プロジェクトが、インポートされるか最新版への「インプレイスアップグレード」を経験する場合、その設定テンプレートが設計時または構築時にアップグレードされます。
設計時に接続マップまたは環境プロパティーのウィンドウを開くと、次の図に示すような警告ウィンドウが表示され、設定テンプレートが自動的にアップグレードされます。変更を一切行わないで環境プロパティーを更新し、プロジェクトを実行できるようになりました。
接続マップまたは環境プロパティーのウィンドウを先に開かないでプロジェクトの構築を試みた場合、コード生成時に設定テンプレートが自動的にアップグレードされます。この構築時アップグレードシナリオが完了すると、警告ウィンドウが表示されることは二度となくなります。
アウトバウンド TCP/IP アダプタプロパティーによって、アダプタの出力処理動作が決まります。アウトバウンド TCP/IP アダプタ接続マッププロパティーは、次の各セクションに編成されています。
「一般アウトバウンド設定」プロパティーは、一般的な TCP/IP アウトバウンド設定情報を提供します。このセクションには、表 1–90 に示す最上位パラメータが含まれています。
表 1–90 接続マップ - 一般アウトバウンド設定
名前 |
説明 |
必要な値 |
---|---|---|
プログラムの内部に格納できるデータの最大量を指定します。 |
有効な範囲は、1 から 2147483647 バイト (2G バイト — Java の整数の最大値) までです。 デフォルト設定は 2147483647 です。 |
|
OTD ノードである State オブジェクトのスコープを指定します。このパラメータのオプションは、次のとおりです。
|
次のいずれかを選択します。
デフォルト設定は「リソースアダプタレベル」です。 |
「TCPIP アウトバウンド設定」プロパティーは、java の Socket のオプションを提供します。詳細については、JDK の Javadoc を参照してください。「TCP/IP アウトバウンド設定」プロパティーには、表 1–91 に示す最上位パラメータが含まれています。
SO_KEEPALIVE など、これらの基本設定によって参照されるオプションの完全な情報については、Sun Microsystems の対応する Java ドキュメントを参照してください。
名前 |
説明 |
必要な値 |
||
---|---|---|---|---|
アダプタによる TCP/IP 接続の確立方法を指定します。
|
「クライアント」または「サーバー」。「サーバー」がデフォルト設定です。「サーバー」モードが特に必要でないかぎり、この値はデフォルトの「クライアント」のままにしておいてください。 |
|||
ServerSocket の SoTimeout の値をミリ秒で設定または取得します。ServerSocket.accept() で使用されます。このオプションをゼロ以外のタイムアウトに設定すると、この ServerSocket の accept() を呼び出した際に、その期間だけブロックが発生します。タイムアウトの期限が切れると、java.net.SocketTimeoutException (または java.net.InterruptedIOException) がスローされますが、ServerSocket は有効なままです。 ブロック動作に入る前に、このオプションを有効にしてください。このパラメータが使用されるのは、「接続タイプ」が「サーバー」に設定されている場合だけです。 |
SoTimeout 値をミリ秒で示す整数。 デフォルト値は 60000 ミリ秒 (60 秒) です。 このタイムアウトは 0 (ゼロ) より大きくする必要があります。タイムアウト値 0 は、タイムアウトが無限であると解釈されます。 |
|||
クライアントの SO_KEEPALIVE オプションが有効、無効のいずれであるかを指定します。 |
true または false。true は、サーバーの SO_KEEPALIVE オプションが有効であることを示します。 デフォルト設定は true です。 |
|||
現在のソケットに対するクライアントの SO_RCVBUF オプションの値を設定または取得できるようにします。これは、オペレーティングシステムがこのソケットの入力用に使用するバッファーのサイズです。これは、プラットフォームが受信ネットワーク入出力用に使用する配下のバッファーのサイズに関するヒントを設定します。 これを設定に使用すると、その値は、このソケット経由で受信されるデータ用に使用するバッファーのサイズに関する、アプリケーションからカーネルへの提案値になります。 これを取得に使用すると、プラットフォームがこのソケット上でのデータ受信時に実際に使用しているバッファーのサイズが返されます。 |
受信バッファーサイズを示す整数。 デフォルト設定は 8192 です。 |
|||
現在のソケットに対するクライアントの SO_SNDBUF オプションの値を設定または取得できるようにします。これは、オペレーティングシステムがこのソケットの出力用に使用するバッファーのサイズです。 |
送信バッファーサイズを示す数値。 デフォルト設定は 8192 です。 |
|||
クライアントの SO_LINGER オプションが有効、無効のいずれであるかを指定します。 |
true または false。true の場合、SO_Linger オプションが有効になります。 |
|||
クライアントの linger タイムアウトを秒で指定します。タイムアウトの最大値はプラットフォームに固有となります。この設定はソケットのクローズにのみ影響を与えます。 |
linger タイムアウト (秒)。デフォルト設定は 30 秒ですが、これは、SO_LINGER オプションが無効であることを示します。 |
|||
クライアントの SO_TIMEOUT 値をミリ秒で設定または取得できるようにします。 |
SO_TIMEOUT 値 (ミリ秒)。 デフォルト設定値は 10000 ミリ秒 (10 秒) です。 |
|||
クライアントの TCP_NODELAY オプション (つまり、Nagle のアルゴリズム) が有効、無効のいずれであるかを指定します。 |
true または false。true を選択すると、TCP_NODELAY オプションが有効になります。 |
|||
クライアントソケットファクトリを実装した Java クラスの名前を入力します。このクラスは、クライアントソケットを作成するために使用されます。ユーザー独自のクライアントソケット実装を用意した場合には、その実装を含む Java クラスの名前を入力します。ファクトリ実装クラスは、次のインタフェースを実装する必要があります。
|
有効な Java クラス名。デフォルトは次のとおりです。
|
「クライアント接続の確立」プロパティーは、接続の確立を制御するために使用される構成パラメータをいくつか定義します。
TCP/IP アウトバウンドアダプタの接続マッププロパティーのこのセクションには、表 1–92 に示す最上位パラメータが含まれています。
このセクションが使用されるのは、「接続タイプ」が「クライアント」に設定されている場合だけです。
名前 |
説明 |
必要な値 |
---|---|---|
外部システムへの接続を試みるまでにアダプタが待機する時間の長さ (ミリ秒) を指定します。 |
アダプタが接続を試みるまでの待機時間の長さ (ミリ秒) を示す数値。 デフォルト設定は 0 です。 |
|
アダプタが接続確立要求の受信時に常に新しい接続の作成を試みるかどうかを指定します。
|
true または false。 デフォルト設定は false です。 |
|
アダプタが条件に一致する接続をコンテナから取得したが、その接続が、外部アプリケーションのロジックのために外部側の接続がクローズ/リセットされるなど、さまざまな理由により有効でなくなっていた場合に、再接続を自動的に試みるかどうかを指定します。 このプロパティーが有効になるのは、インテグレーションサーバーの接続プール内に既存の接続が存在している場合だけであり、プールが空の場合の初期トリガー中には有効になりません。
|
true または false。 デフォルト設定は true です。 |
|
アダプタが特定の外部 TCP/IP 宛先 (ホスト/ポート) への接続を試みる最大回数を指定します。この回数を超えるとアダプタは接続をあきらめます。 |
アダプタが接続を試みる回数を示す整数。 |
|
特定の外部 TCP/IP 宛先 (ホスト/ポート) への複数の接続試行間でのアダプタの待機時間の長さ (ミリ秒) を指定します。 |
複数の接続試行間でのアダプタの待機時間の長さをミリ秒で示す整数。デフォルト設定は 30000 (つまり 30 秒) です。 |
「サーバーポートのバインディング」セクションは、サーバーポートバインディングの制御に使用されるパラメータを定義します。このパラメータが使用されるのは、「接続タイプ」が「サーバー」に設定されている場合だけです。「TCP/IP アウトバウンド設定」 — 「サーバーポートのバインディング」プロパティーには、表 1–93 に示す最上位パラメータが含まれています。
表 1–93 接続マップ - TCPIP アウトバウンド設定 - サーバーポートのバインディング
名前 |
説明 |
必要な値 |
---|---|---|
localhost 上の指定された TCP/IP ポートへのバインドをアダプタが試みる最大回数を指定します。 |
localhost 上の指定された TCP/IP ポートへのバインドの再試行回数を示す整数。 |
|
localhost 上の指定された TCP/IP ポートへの複数のバインド試行間での、アダプタの待機時間の長さ (ミリ秒) を指定します。 |
アダプタが指定された TCP/IP ポートにバインドするまでの時間の長さをミリ秒で示す整数。 デフォルト設定は 30000 (30 秒) です。 |
これらのプロパティーは、アウトバウンドアダプタのエンベロープメッセージ形式の設定です。これらのプロパティーは、インバウンドアダプタの場合と同じように動作します。
ここでは、サーバーのエンベロープメッセージ形式プロパティーについて説明します。これらのプロパティーはすべて、TCP/IP エンベロープ処理に関連するものです。TCP/IP アウトバウンドアダプタの接続マッププロパティーのこのセクションには、表 1–94 に示す最上位パラメータが含まれています。
表 1–94 接続マップ - TCPIP アウトバウンド設定 - エンベロープメッセージ
名前 |
説明 |
必要な値 |
||
---|---|---|---|---|
エンベロープタイプを指定します。エンベロープタイプは、メッセージの開始位置と終了位置を定義します。 |
エンベロープタイプを示す次のプロパティーのいずれかを入力します。
デフォルトは「開始と終了をマーク」です。 |
|||
「開始と終了をマーク」はプロパティー「読み取るバイト数」、「ignore-until 文字の値」、および「store-until 文字の値」によってサポートされます。 |
||||
「終了をマーク」はプロパティー「store-until 文字の値」によってサポートされます。 |
||||
「長さを固定」はプロパティー「読み取るバイト数」によってサポートされます。 |
||||
「長さを先頭に付加」はプロパティー「長さの幅」および「数値表現」によってサポートされます。 |
||||
「マークおよび固定」はプロパティー「読み取るバイト数」、「ignore-until 文字の値」、および「store-until 文字の値」によってサポートされます。 |
||||
「アクティブな接続ごと」はプロパティー「アクティブな接続ごと」によってサポートされます。 |
||||
「カスタム」はプロパティー「カスタムエンベロープクラス名」および「カスタム定義プロパティー」によってサポートされます。 最適なパフォーマンスが得られるように、すべてのエンベロープメッセージでメソッド receiveEnvelopedMsg() を使用してください。このメソッドでは終了条件としてエンベロープが使用されるのに対し、ほかの受信メソッド receiveBytes() および receiveString() では終了条件としてタイムアウトが使用されます。 注 – マークおよび固定を除くすべてのエンベロープタイプでは、データはペイロードにすぎません。このエンベロープタイプでのデータの処理方法については、「マークおよび固定」を参照してください。 |
||||
「エンベロープタイプ」プロパティーが「カスタム」に設定された場合に使用される Java クラス名を指定します。 Java クラスを使って作成したカスタムエンベロープを使用する場合、そのクラスを含む Java JAR ファイルを、コラボレーションエディタのファイルインポート機能を使って目的とする任意のコラボレーション内にインポートできます。 このクラス名は、com.abc.MyClass などの完全修飾クラス名にすべきです。このクラスが実装する必要のあるインタフェースは、次のとおりです
および
詳細については、「カスタマイズされたエンベロープ処理」を参照してください。 |
完全な Java クラス名。 完全修飾クラス名。「エンベロープタイプ」が「カスタム」でない場合は「なし」。 デフォルト設定は「なし」です。 |
|||
「エンベロープタイプ」の値が「カスタム」に設定された場合に使用されます。一連のユーザー定義パラメータを指定します。区切り文字を含むこの情報を解析し、カスタマイズされたエンベロープメッセージ実装を生成することができます。 |
テキスト文字列。 |
|||
次のエンベロープタイプで使用されます。
読み取るバイト数を指定します。アダプタが受信するイベントの長さはすべて同じであると仮定されています。 |
バイト数を示す整数。 デフォルト設定は 1 です。 |
|||
「エンベロープタイプ」の値が「長さを先頭に付加」の場合に使用されます。エンベロープ長の幅を指定します。言い換えると、これは、長さのフィールドを表現するために使用される桁数を指定します。 |
1 から 10 までの範囲の整数。このプロパティーは、「ネットワーク short」の場合は 2 に、「ネットワーク long」の場合は 4 に、それぞれ設定する必要があります。 デフォルト設定値は 1 です。 |
|||
「エンベロープタイプ」の値が「長さを先頭に付加」の場合に使用されます。先頭に付加される長さの数値をどのような方法で表現するかを指定します。この値は、次のいずれかの形式で表現されます。
|
次のいずれかを選択します。
デフォルト設定は「10 進数」です。 |
|||
エンベロープタイプ「開始と終了をマーク」および「マークおよび固定」で使用されます。ignore-until (開始ブロックと同じ) 文字の値を指定します。この文字が検出されるまで、すべての受信文字が無視されます。 |
10 進 ASCII 番号。指定可能な範囲は、1 から 127 までです。 デフォルト設定は 11 です。 |
|||
エンベロープタイプ「開始と終了をマーク」、「終了をマーク」、および「マークおよび固定」で使用されます。エンベロープの終了ブロックまたはマーカーの位置にある文字を指定します。この文字が検出されるまで、すべての受信文字が格納されます。 |
10 進 ASCII 番号。指定可能な範囲は、1 から 127 までです。 デフォルト設定は 12 です。 |