4.2 クライアント通信API

Ajaxフレームワークユーザーズガイド

目次索引

4.2 クライアント通信API

クライアント通信APIを利用すると、Webブラウザ上のJavaScriptからWebサービスを呼び出すことができます。

マッシュアップフレームワークでは、マッシュアッププロキシを経由して、Webサービスにアクセスします。クライアント通信APIは、ブラウザとマッシュアッププロキシ間の非同期通信を行うJavaScript API(MuRequest.send)を提供します。このAPIを使用することにより、クロスドメイン制約に影響されることなく、指定したWebサービスに任意のデータを送信し、結果を非同期で受信することができます。

以下に、MuRequest.send関数について説明します。

■MuRequest.send関数の記述形式

以下に、MuRequest.send関数の記述形式を示します。

MuRequest.send (dataObj, requestParams, option);

dataObj
アダプタがWebサービスに送信するクエリ文字列を表すオブジェクトです。
string、number、boolean型のプロパティを持ちます。
クエリ文字列を送信しない場合は、nullを指定します。
以下の形式のオブジェクトを指定します。この形式以外のオブジェクトは、クエリ文字列として送信されません。
{key1:<string>, key2:<string>}

requestParams
アクセスするサービスを一意に決定するためのID(以降、サービスIDと呼びます)や、マッシュアッププロキシの動作を制御するための値を格納したリクエストパラメタオブジェクトです。
リクエストパラメタが不要な場合は、nullを指定します。

以下に、リクエストパラメタオブジェクトのプロパティを示します。

プロパティ名	概要	型	省略可否
serviceId	サービスID サービス管理機能で定義したサービスIDを指定します。	string	不可
type	マッシュアッププロキシからのレスポンス形式以下のどちらかの形式を指定します。 xml: XML形式の文字列 json: JavaScriptオブジェクト大文字/小文字の区別はなく、省略値は、jsonです。	string	可

プロパティ名

概要

型

省略可否

serviceId

サービスID
サービス管理機能で定義したサービスIDを指定します。

string

不可

type

マッシュアッププロキシからのレスポンス形式
以下のどちらかの形式を指定します。

xml: XML形式の文字列
json: JavaScriptオブジェクト

大文字/小文字の区別はなく、省略値は、jsonです。

string

可

option
MuRequestの動作を制御するための値を格納した通信設定オブジェクトです。
optionにnullが指定された場合、または省略された場合は、通信せずにエラーが発生します。

以下に、通信設定オブジェクトのプロパティを示します。

プロパティ名	概要	型	省略可否
url	通信先のURL “muf/proxy”を指定します。サブフォルダに配置されているHTML/JSPファイルからマッシュアッププロキシを呼び出す場合、urlプロパティで指定する“muf/proxy”について、パスの考慮が必要です。アプリケーションフォルダを基点とした“muf/proxy”が参照できるように相対パスで指定してください。例えば、アプリケーションフォルダ直下の“JSP”フォルダにHTML/JSPファイルが存在する場合は、“../ muf/proxy”を指定してください。HTML/JSPファイルがインクルードされている場合には、インクルード元のHTML/JSPファイルが存在するフォルダを基点とした相対パスで指定してください。 URLには、任意のクエリ文字列やURLリライティングで使用するセションIDを付加することができます。詳細は、“リクエスト送信時のURLについて”を参照してください。	string	不可
callback	レスポンスハンドラ(正常終了時のコールバック) 第1引数にサーバから返却されたJavaScriptオブジェクトが渡されます。リクエストパラメタオブジェクトのtypeがxmlの場合はStringオブジェクト、typeがjsonの場合はマッシュアッププロキシ側で規定したJavaScriptオブジェクトです。	function	不可
errorHandler	エラーハンドラ(エラー発生時のコールバック) 第1引数にエラーオブジェクトが渡されます。詳細は、“マッシュアップフレームワーク内のエラー”を参照してください。	function	可
timeout	タイムアウト時間(ミリ秒) サーバからのレスポンスが完了するまでの最大待ち時間です。この時間を超えると、エラーハンドラ呼出しとなります。省略値は、120000(120秒)です。なお、0を指定することはできません。	number	可
preInvoke	メソッド呼出し直前に呼ばれるコールバック引数はありません。	function	可
postInvoke	メソッド呼出し完了直後に呼ばれるコールバック引数はありません。	function	可

■MuRequest.send関数の記述例

以下に、Webサービスにアクセスし、結果を表示する場合の、MuRequest.send関数の記述例を示します。

function clickExecuteButton(){
    dataObj={key1:'value1',key2:'value2'};
    var requestParams = {
        serviceId:'serviceA',//サービスIDを指定
        type:'json'//レスポンス形式を指定
    };
    var option = {
        url:'muf/proxy',
        callback:function(data){/* ここに処理を記述 */},
        errorHandler:function(err){/* ここに失敗時の処理を記述 */}
    };
    MuRequest.send(dataObj,requestParams,option);
}

■MuRequest.send関数が通知する例外

MuRequest.send関数が通知する例外については、“通信フレームワーク(JavaScript)に関するメッセージ”を参照してください。

目次索引