特定のサーバーへの API 呼び出しの指定

このアプリケーションには、カスタム API をリモートまたはローカルのいずれかで呼び出したときに、これらの API 呼び出しを特定のサーバーまたはサーバーのグループに経路指定する機能が用意されています。

このタスクについて

この機能を使用可能にするには、サーバーおよびプロトコルを yifclient.properties ファイルおよび必要な API で指定する必要があります。 エンドポイントは、API 呼び出しを経路指定するために使用される構成済みのサーバーまたはプロトコルです。

XAPI クライアントが複数の URL に対して構成されている場合、接続の試行はグループ内の各サーバーに対して順番に行われます。 接続できたが別の何かが失敗した場合、他のサーバーへの接続試行は行われず、例外がスローされます。

API 呼び出しを特定のサーバーまたはサーバーのグループに指定するには、以下のステップを実行します。

手順

  1. ディレクトリー <runtime_sandbox>/resources/の下の yifclient.properties ファイルに endpoint 属性を指定します。 yifclient.properties ファイルを変更して、エンドポイントの宣言と使用法を以下の形式で組み込みます。
    endpoint.Server_Name.apifactory.protocol=HTTP 
    endpoint.Server_Name.httpapi.url=http://server:port/context_root/
    interop/InteropHttpServlet
    複数の URL に対して XAPI クライアントを構成するには、グループをコンマ区切りリストとして定義します。
    endpoint.Server_Name.httpapi.url=http://server1:port1/context_root1/
    interop/InteropHttpServlet,http://server2:port2/context_root2/
    interop/InteropHttpServlet... 

    endpoint.Server_Name によって、名前 Server_Name のサーバーが指定されます。 例えば、endpoint.INBOXSERVER は、名前 INBOXSERVER のエンドポイントを作成します。 プロパティーをエンドポイント名に割り当てて、他のすべての割り当て済みプロパティーより優先することができます。

    エンドポイントに構成されたプロトコルは、次の行で指定されているように HTTP です。endpoint.Server_Name.apifactory.protocol=HTTP

    2 行目で指定された設定 endpoint.Server_Name.httpapi.url は、エンドポイントで指定されたサーバーへの接続に使用されます。

  2. 指定のサーバーへの接続に使用されるプロトコルを構成します。 HTTP、HTTPS、EJB、LOCAL、AUTO などのプロトコルは、エンドポイント名として予約されています。 これらのいずれかをエンドポイントに構成すると、システムは、(規定どおりに) API 呼び出しの経路指定にデフォルトの接続設定を使用します。
  3. 各 API に対して、使用するエンドポイントを指定します。
    yfs.api.apiname.endpoint=ENDPOINT

    API は、エンドポイント属性で指定されたサーバーを呼び出します。

    注: エンドポイントが API 用に構成されていない場合は、デフォルトの (ローカル) サーバー、またはすべての API 用に構成された一般的なサーバーを使用します。 API レベルで設定されたプロパティーは、他の一般的なプロパティーより優先されます。