Web サービス › Web サービスを有効にする方法 › 前提条件の確認 › クライアント プログラムが API にアクセスする方法

クライアント プログラムが API にアクセスする方法

Web サービスは、クライアント アプリケーションを有効にし、SOAP （Simple Object Access Protocol）を使用して Web サービスと通信する Java2 および Apache AXIS2/JAVA コンポーネントによって構築されたマルチスレッド アプリケーションです。 クライアントと Web サービスは、SOAP メッセージを使用して通信します。 SOAP メッセージ、要求、および応答は、クライアントと HTTP Web サーバ間で TCP/IP を使用して送信されます。

以下の図は、クライアント、Web サービス、および CA Endevor SCM API 間の情報の流れを示しています。

図に示すように、クライアント アプリケーションは、Web サービスを使用して CA Endevor SCM API にアクセスします。 以下に、この処理の詳細を示します。

• クライアント アプリケーションは、WSDL （Web Services Description Language）ファイル内の定義に基づいて SOAP メッセージをフォーマットして HTTP サーバに送信します。 要求には、クライアントがアクセスする CA Endevor SCM データ ソースの名前が含まれます。
• Web サービスは、クライアント呼び出しによって要求されたデータ ソースの名前と設定ファイルを照合します。 1 つ以上の設定ファイルが HTTP Web サーバに格納され、CA Endevor SCM API へのアクセスが有効になります。 設定ファイルは、要求を CA Endevor SCM に渡すことができる API STC（STC プール）の名前と数を指定します。 CA Common Services CAICCI 生成機能は、指定された数の API STC を生成します。

  Web サービスを有効にして要求を処理し、API と通信するには、CA Endevor SCM がインストールされている z/OS 環境で、以下のような CA Common Services コンポーネントが必要です。

  • CAICCI は、Web サービスと API 間の通信を可能にする共通の通信ソフトウェア層を提供します。
  • CAIENF を設定して、CAICCI 生成機能を有効にし、CA Endevor SCM が Web サービス要求に対して STC プールをスケジュール、実行、および監視できるようにする必要があります。

このプロセスは、以下の標準技術を使用します。

• XML 言語 – Web サービス コンポーネントによって使用されるデータ形式。 Web サービス アプリケーション間の通信は、XML 形式で書き込まれます。
• SOAP （Simple Object Access Protocol） – アプリケーション間通信のための XML ベースのメッセージング プロトコルおよびエンコード形式。 SOAP メッセージは、アプリケーション間で送信される XML メッセージです。 SOAP メッセージは、SOAP 構造で囲まれた標準の XML 形式で記述されたテキスト ファイルです。 SOAP は、XML データを送信および解釈する方法をアプリケーションが理解できるようにします。
• WSDL （Web Services Description Language） - サービス記述プロトコルの 1 つ。 Web サービスの WSDL ファイルは、クライアント プログラムと Web サービス間のインターフェースとして機能する動的な XML ファイルです。 Web サービスの WSDL ファイルには、クライアント プログラムが利用可能な CA Endevor SCM の操作、およびクライアントと Web サービスの対話に必要な SOAP プロトコル バインディングとメッセージ形式が記述されています。

  ユーザ作成のクライアント アプリケーション用の Web サービスを使用する場合、Web 開発者は、WSDL ファイルからクライアント スタブを作成する必要があります。 クライアント スタブは、関数呼び出しで使用されるパラメータの変換、および関数の実行後にサーバから渡される結果の再変換を行います。 クライアント スタブは、Web サービス スタブと対話します。 詳細については、「ユーザ作成のクライアント プログラム」を参照してください。