ゲートウェイ・サーブレットのパラメーター

デフォルトでは、ゲートウェイ・サーブレットには hptGatewayProperties というパラメーターのみが定義されています。このパラメーターは、ゲートウェイ・プロパティー・ファイルを指定します。 ゲートウェイ・プロパティー・ファイルは、ゲートウェイ・サーブレットの残りのパラメーターを設定します。デフォルトでは、ゲートウェイ・プロパティー・ファイルは Java™ Resources フォルダー内にある gw.properties です。このファイル内のコメントは、ポンド記号 (#) で始まります。

あるいは、ゲートウェイ・サーブレット・パラメーターを hptGatewayProperties パラメーターに指定したのと同じ場所で設定することもできます。ただし、ベスト・プラクティスとしては、パラメーターはゲートウェイ・プロパティー・ファイルに設定します。ゲートウェイ・プロパティー・ファイル内のパラメーターは、Web アプリケーション・サーバーで指定したプロパティーを上書きします。

リンケージのプロパティーは、リンケージ・プロパティー・ファイルで設定されています。このファイルは、hptLinkageProperties ゲートウェイ・サーブレット・パラメーターで指定されます。『Web トランザクションのリンケージ・プロパティー』を参照してください。

ゲートウェイ・サーブレット・パラメーターは、照会ストリングを介してゲートウェイ・サーブレットにコマンドを渡すゲートウェイ照会パラメーターと同じではありません。ゲートウェイ照会パラメーターについては、Web トランザクションのゲートウェイ照会パラメーターを参照してください。

表 1. ゲートウェイ・サーブレットのパラメーター
サーブレット・パラメーター パラメーター値 コメント
hptDateMask yyyy/dd/mm 非数値のデータ・フィールドを含む UI レコードがある場合には必須です。 そのようなフィールドの場合は、層 2 と層 3 の間でいずれかの方向に渡される日時値は、内部的には日付と時刻を表す長グレゴリオ形式に一致している必要があります。パラメーター hptDateMask は、その形式を指定します。C++ プログラムとして生成される Web トランザクションの場合は、この形式は、環境変数 EZERGRGL で指定されている形式に一致している必要があります。COBOL プログラムとして生成される Web トランザクションの場合は、hptDateMask の形式は、サーバーのインストール時に指定された日時形式に一致している必要があります。
hptDisableRMIIDManager Y ゲートウェイ・サーブレットは、固有の ID を使用して各ユーザーのセッションを識別します。VisualAge® Generator では、セッション ID マネージャーと呼ばれる別のプログラムが ID を作成しました。 ゲートウェイ・サーブレットは、リモート・メソッド呼び出し (RMI) を使用してそのプログラムと通信しました。hptDisableRMIIDManager が Y に設定されている場合、EGL がセッション ID を作成します。これは、Web トランザクション・サポートを使用するプロジェクトの gw.properties ファイル内で事前設定されています。
hptEntryApp web_transaction エントリー・ページを提供する Web トランザクションを指定します。 プログラム名は、層 3 環境における名前 (例えば、CICS® 定義など) に一致している必要があります。 また、プログラム名のエントリーは、パラメーター hptLinkageProperties が参照するファイルに含まれている必要があります。

hptEntryPage または hptEntryApp のいずれかが必須です。 両方を指定した場合は、hptEntryPage が使用されます。

hptEntryPage /entry_page_jsp エントリー・ページ JSP を文書ルートを基準にして指定します。

hptEntryPage または hptEntryApp のいずれかが必須です。 両方を指定した場合は、hptEntryPage が使用されます。

エントリー・ページ JSP の HTML 出力では、ユーザーによって呼び出される Web トランザクションの名前は、hptAppId に割り当てられている必要があります。 また、Web トランザクションを呼び出す実行ボタンの名前は hptExec で、Web アプリケーション・サーバー・セッションを終了する実行ボタンの名前は hptLogout である必要があります。

実用サンプルとして Vagen1EntryPage.jsp が提供されています。このサンプルでは、各 Web トランザクション名は、<SELECT> 構造の VALUE 節に含まれており、その構造の NAME 節は hptAppId を参照しています。

hptErrorLog gateway_servlet_log_file オプション。イベントおよびエラーのトレース用のログ・ファイルの完全修飾パスを指定します。このパラメーターを指定しないと、トレース情報は Web サーバーのコンソールに出力されます。
hptExDateMask yyyy/dd/mm オプション。Web ページ上での日付のフォーマット設定を決定します。これは、バックエンド Web トランザクションで使用される日付フォーマットを指定する hptDateMask とは異なります。
hptExpiredPasswordPage /expired_password_page _jsp オプション。有効期限が切れたパスワード・ページ JSP を文書ルートを基準にして指定します。

有効期限が切れたパスワード・ページ JSP の HTML 出力では、ユーザー ID 入力フィールドの名前は hptUserid、古いパスワード入力フィールドの名前は hptPassword、新しいパスワード入力フィールドの名前は hptNewPassword、新しいパスワード入力確認フィールドの名前は hptConfirmNewPassword、そして実行ボタンの名前は hptExpiredPasswordPageLogin である必要があります。

実用サンプルとして ExpiredPasswordPage.jsp が提供されています。

パラメーター hptExpiredPasswordPage の効果があるは、hptLogonCheck も指定されている場合のみです。

hptGatewayProperties gateway_properties_file オプション。他のゲートウェイ・サーブレット・パラメーターを含むファイルの完全修飾パスを指定します。
hptIDManagerHost host_name オプション。セッション ID マネージャーが稼働しているマシンの TCP/IP ホスト名を指定します。デフォルトは localhost です。hptDisableRMIIDManager が Y に設定されている場合は使用されません。
hptLinkageProperties linkage_properties_file 必須。リンケージ・プロパティー・ファイルの完全修飾名を指定します。このファイルは、ゲートウェイ・サーブレットと各 Web トランザクションの間の接続を確立します。Web トランザクションのリンケージ・プロパティーを参照してください。
hptLogonCheck fully_qualified_class_name オプション。ユーザー認証を処理するログオン確認クラスを指定します。

実用的なサンプルとして RACFValidateLogin が提供されています。そのサンプルを使用するには、hptLogonCheck= com.ibm.hpt.gateway を指定します。 RACFValidateLogin

hptLogonPage /logon_page_jsp オプション。ログオン・ページ JSP を文書ルートを基準にして指定します。このパラメーターが省略されている場合、または hptPublicPassword と hptPublicUserid が存在している場合、ログオン・ページは表示されません。

ログオン・ページ JSP の HTML 出力では、ユーザー ID 入力フィールドの名前は hptUserid、パスワード入力フィールドの名前は hptPassword、そして実行ボタンの名前は hptLogin である必要があります。

実用サンプルとして Vagen1LogonPage.jsp が提供されています。

hptLogOpt 1 デフォルトでは、ロギングはオンで、Web サーバーのコンソールに送信されます (hptErrorLog を参照)。 ロギングをオフにするには、hptLogOpt を 1 に設定します。
hptPublicPassword password hptPublicUserId と組み合わせて、hptLogonPage で指定されたログオン画面をユーザーがバイパスできるようにします。 設定されている場合、すべての Web トランザクションが同じユーザー ID で実行されます。
hptPublicUserId user_id hptPublicPassword と組み合わせて、hptLogonPage で指定されたログオン画面をユーザーがバイパスできるようにします。 設定されている場合、すべての Web トランザクションが同じユーザー ID で実行されます。
hptSessionIdManagerPort port_number セッション ID マネージャーのポートを指定します。 このパラメーターは、デフォルト・ポートを使用しておらず、hptDisableRMIIDManager が Y に設定されていない場合にのみ指定します。
hptSessionIDPrefix prefix セッション ID マネージャーを使用するかどうかには関係なく、すべてのセッション ID に自動的に付加されるデフォルトの接頭部 CU を置換します。 これは 1 から 3 文字までの長さでなければなりません。
hptValidApps web_tran_name [, web_tran_name ...] 実行が許可される Web トランザクションの名前のコンマ区切りリスト。 hptValidApps が設定されていない場合、すべての Web トランザクションを実行できます。 設定されている場合、リスト内にないトランザクションを実行する要求が送信されると、GatewayServlet はエラー・メッセージを出します。 名前をアスタリスクのワイルドカード文字で終了することもできます。
以下のコードは、ゲートウェイ・プロパティー・ファイルの例を示しています。
hptLogonPage=/Vagen1LogonPage.jsp
hptEntryPage=/Vagen1EntryPage.jsp
#hptEntryApp=WEBTXN1
hptErrorLog=c:/traces/Vagen1Gateway.log
hptLinkageProperties=c:/linktabs/csogwLinkage.properties

フィードバック