3.5.6 ビジネスロジックの実行(非同期通信)

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

目次索引

第3章通信フレームワーク

> 3.5 サーブレット連携機能(簡易通信方式)

3.5.6 ビジネスロジックの実行(非同期通信)

JavaScriptアプリケーションからビジネスロジックを非同期通信で呼び出すには、RcfRequestオブジェクトのsend関数を使用します。

■RcfRequest.send関数

JavaScriptアプリケーションとビジネスロジック間を非同期で通信するための関数です。
JavaScriptアプリケーションの送信データであるオブジェクトを、非同期通信を使用して送信(POST)します。また、ビジネスロジックの処理結果をJavaScriptのオブジェクトとして受け取り、JavaScriptアプリケーションのコールバック関数にパラメタとして渡します。

■RcfRequest.send関数の記述形式

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

RcfRequest.send(dataObj, requestParams, option);

dataObj
サーバ側に送信するデータのオブジェクトです。
データを送信しない場合は、nullを指定します。

requestParams
JavaBeanのIDや任意のリクエストパラメタなど、ビジネスロジックの動作を制御するための値を格納したリクエストパラメタオブジェクトです。
リクエストパラメタが不要な場合は、nullを指定します。

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

プロパティ名	概要	型	省略可否
beanId	送信データを格納するJavaBeanの識別子アプリケーションがJavaBeanを特定するために使用します。	string	dataObjがnullの場合は省略可それ以外の場合は省略不可
任意	アプリケーションが任意に設定できるリクエストパラメタリクエストパラメタの名前には、任意の名前を指定できます。ただし、以下の予約名を除きます。予約名: beanId、call-id、version、“uji.”または“rcf.”で始まる名前	string	可

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

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

プロパティ名	概要	型	省略可否
url	サーブレットのURL 任意のクエリ文字列やURLリライティングで使用するセションIDをURLに付加する方法については、“リクエスト送信時のURLについて”を参照してください。 urlプロパティに指定するURLには、クエリ文字列やセションIDを含めないでください。	string	不可
callback	レスポンスハンドラ(正常終了時のコールバック) ビジネスロジックからの戻り値は、第1引数に渡されます。	function	不可
errorHandler	エラーハンドラ(エラー発生時のコールバック) 第1引数にエラーオブジェクトが渡されます。詳細は、“通信フレームワーク内のエラー”を参照してください。	function	可
timeout	タイムアウト時間(ミリ秒) サーバからのレスポンスが完了するまでの最大待ち時間です。この時間を超えると、エラーハンドラ呼出しとなります。省略値は、120000(120秒)です。なお、0を指定することはできません。	number	可
preInvoke	メソッド呼出し直前に呼ばれるコールバック引数はありません。	function	可
postInvoke	メソッド呼出し完了直後に呼ばれるコールバック引数はありません。	function	可

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

各種コールバック関数がnullの場合、コールバック呼出しは行われません。

プロパティの型がfunctionとなっているものは、JavaScriptの関数を指定します。
以下に、callbackプロパティにレスポンスハンドラを記述する例を示します。

var option = {
  ...,
  // サーバからの戻り値を引数に指定
  // 引数の名前は任意
  callback:function(res){
    // サーバからの戻り値に対する処理を記述
    ...;
  }
};

■RcfRequest.send関数の記述例

以下に、RcfRequest.send関数の記述例を示します。
以下の例では、“databean”をIDとするJavaBeanにデータが格納されます。

function clickExecuteButton() {
    // dataObjの作成
    var dataObj = new Object();
    dataObj.key = ...;
    // requestParamsの作成
    var reqParam = {
        beanId :'databean',  // JavaBeanのIDを指定
        command:'init'       // コマンド名を指定(任意)
    };
    // optionの作成
    var option = {
        url:'entry',
        callback:function(res){
           // 受信したオブジェクト(res)の処理
           ...;
        }
    };
    try {
        RcfRequest.send(dataObj, reqParam, option);
    } catch (e) {
        alert("Application Error (" + e.message + " )");
    }
}

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

RcfRequest.send関数が通知する例外については“通信フレームワーク(JavaScript)に関するメッセージ”および“サーブレット連携機能に関するメッセージ”を参照してください。

目次索引