intra-mart 6.1.14

jp.co.intra_mart.foundation.http.ajax
クラス ImAjaxUtil

java.lang.Object
  拡張jp.co.intra_mart.foundation.http.ajax.ImAjaxUtil

public class ImAjaxUtil
extends Object

CSJSライブラリ「ImAjax」で通信を行う際に有用なサーバサイドのユーティリティクラスです。


CSJSライブラリ「ImAjax」で通信を行う際、 レスポンスヘッダにエラーコードとエラーメッセージを設定することが可能です。
レスポンスヘッダのフォーマットは以下の通りです。

ヘッダー名 ヘッダー値
x-jp-co-intra-mart-ajax-error-code エラーコード
x-jp-co-intra-mart-ajax-error-message エラーコードに紐づくエラーメッセージ

エラーメッセージは、JavaScript(=EcmaScript) のencodeURIComponent()を利用して、 自動的にエンコードされます。
(エンコード処理は、ResponseCharacterEncodingFilter 内で実行されます)

導入されたバージョン:
6.1
バージョン:
1.0

フィールドの概要
static String IM_AJAX_USER_AGENT_FIREFOX
          「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Firefox
static String IM_AJAX_USER_AGENT_IE
          「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Internet Explorer
static String IM_AJAX_USER_AGENT_NETSCAPE
          「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Netscape
static String IM_AJAX_USER_AGENT_OPERA
          「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Opera
static String IM_AJAX_USER_AGENT_SAFARI
          「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Safari
static String REQUEST_HEADER_NAME_IM_AJAX_REQUEST
          ImAjaxからの通信だということを判定可能にするためのリクエスト・ヘッダ名。
static String REQUEST_HEADER_NAME_IM_AJAX_USER_AGENT
          ブラウザの種類を判定可能にするためのリクエスト・ヘッダ名。
static String RESPONSE_HEADER_NAME_IM_AJAX_ERROR_CODE
          ImAjaxへエラーコードを通知するためのレスポンス・ヘッダ名。
static String RESPONSE_HEADER_NAME_IM_AJAX_ERROR_MESSAGE
          ImAjaxへエラーメッセージを通知するためのレスポンス・ヘッダ名。
 
コンストラクタの概要
ImAjaxUtil()
           
 
メソッドの概要
static void setErrorResponseHeaders(HttpServletResponse response, String errorCode)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(HttpServletResponse response, String errorCode, String arg)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(HttpServletResponse response, String errorCode, String[] args)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(HttpServletResponse response, String errorCode, String arg1, String arg2)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(HttpServletResponse response, String errorCode, String arg1, String arg2, String arg3)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(String errorCode)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(String errorCode, String arg)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(String errorCode, String[] args)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(String errorCode, String arg1, String arg2)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
static void setErrorResponseHeaders(String errorCode, String arg1, String arg2, String arg3)
          レスポンスヘッダにエラーコードとエラーメッセージを設定します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

REQUEST_HEADER_NAME_IM_AJAX_REQUEST

public static final String REQUEST_HEADER_NAME_IM_AJAX_REQUEST
ImAjaxからの通信だということを判定可能にするためのリクエスト・ヘッダ名。

関連項目:
定数フィールド値

REQUEST_HEADER_NAME_IM_AJAX_USER_AGENT

public static final String REQUEST_HEADER_NAME_IM_AJAX_USER_AGENT
ブラウザの種類を判定可能にするためのリクエスト・ヘッダ名。

関連項目:
定数フィールド値

IM_AJAX_USER_AGENT_IE

public static final String IM_AJAX_USER_AGENT_IE
「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Internet Explorer

関連項目:
定数フィールド値

IM_AJAX_USER_AGENT_FIREFOX

public static final String IM_AJAX_USER_AGENT_FIREFOX
「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Firefox

関連項目:
定数フィールド値

IM_AJAX_USER_AGENT_NETSCAPE

public static final String IM_AJAX_USER_AGENT_NETSCAPE
「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Netscape

関連項目:
定数フィールド値

IM_AJAX_USER_AGENT_OPERA

public static final String IM_AJAX_USER_AGENT_OPERA
「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Opera

関連項目:
定数フィールド値

IM_AJAX_USER_AGENT_SAFARI

public static final String IM_AJAX_USER_AGENT_SAFARI
「x-jp-co-intra-mart-ajax-user-agent」の設定値 : Safari

関連項目:
定数フィールド値

RESPONSE_HEADER_NAME_IM_AJAX_ERROR_CODE

public static final String RESPONSE_HEADER_NAME_IM_AJAX_ERROR_CODE
ImAjaxへエラーコードを通知するためのレスポンス・ヘッダ名。

関連項目:
定数フィールド値

RESPONSE_HEADER_NAME_IM_AJAX_ERROR_MESSAGE

public static final String RESPONSE_HEADER_NAME_IM_AJAX_ERROR_MESSAGE
ImAjaxへエラーメッセージを通知するためのレスポンス・ヘッダ名。

関連項目:
定数フィールド値
コンストラクタの詳細

ImAjaxUtil

public ImAjaxUtil()
メソッドの詳細

setErrorResponseHeaders

public static void setErrorResponseHeaders(String errorCode)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
errorCode - エラーコード
例外:
AccessSecurityException - メッセージを取得に失敗した場合、または引数が不正な場合にスローされます。

setErrorResponseHeaders

public static void setErrorResponseHeaders(String errorCode,
                                           String arg)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
errorCode - エラーコード
arg - 置換文字列

setErrorResponseHeaders

public static void setErrorResponseHeaders(String errorCode,
                                           String arg1,
                                           String arg2)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
errorCode - エラーコード
arg1 - 置換文字列1
arg2 - 置換文字列2

setErrorResponseHeaders

public static void setErrorResponseHeaders(String errorCode,
                                           String arg1,
                                           String arg2,
                                           String arg3)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
errorCode - エラーコード
arg1 - 置換文字列1
arg2 - 置換文字列2
arg3 - 置換文字列3

setErrorResponseHeaders

public static void setErrorResponseHeaders(String errorCode,
                                           String[] args)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
errorCode - エラーコード
args - 置換文字列の配列

setErrorResponseHeaders

public static void setErrorResponseHeaders(HttpServletResponse response,
                                           String errorCode)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
response - レスポンス
errorCode - エラーコード

setErrorResponseHeaders

public static void setErrorResponseHeaders(HttpServletResponse response,
                                           String errorCode,
                                           String arg)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
response - レスポンス
errorCode - エラーコード
arg - 置換文字列

setErrorResponseHeaders

public static void setErrorResponseHeaders(HttpServletResponse response,
                                           String errorCode,
                                           String arg1,
                                           String arg2)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
response - レスポンス
errorCode - エラーコード
arg1 - 置換文字列1
arg2 - 置換文字列2

setErrorResponseHeaders

public static void setErrorResponseHeaders(HttpServletResponse response,
                                           String errorCode,
                                           String arg1,
                                           String arg2,
                                           String arg3)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
response - レスポンス
errorCode - エラーコード
arg1 - 置換文字列1
arg2 - 置換文字列2
arg3 - 置換文字列3

setErrorResponseHeaders

public static void setErrorResponseHeaders(HttpServletResponse response,
                                           String errorCode,
                                           String[] args)
レスポンスヘッダにエラーコードとエラーメッセージを設定します。
現在ログインしているユーザのロケールでメッセージを設定します。
ヘッダがすでに設定されていた場合は、新しい値が以前の値を上書きします。

レスポンスヘッダのフォーマットは、こちらを参照してください。

パラメータ:
response - レスポンス
errorCode - エラーコード
args - 置換文字列の配列

intra-mart 6.1.14

Copyright © 2000-2010 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.