nablarch.fw.messaging.realtime.http.client

クラス HttpMessagingClient

java.lang.Object

nablarch.fw.messaging.realtime.http.client.HttpMessagingClient

すべての実装されたインタフェース:

MessageSenderClient

@Published(tag="architect")
public class HttpMessagingClient
extends java.lang.Object
implements MessageSenderClient

HTTPを利用したメッセージング機能の実装。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	SYNCMESSAGE_STATUS_CODE SyncMessageのヘッダレコードからステータスコードを取り出すために使用するキー

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
HttpMessagingClient()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	addCommonValue(HttpProtocolClient.HttpRequestMethodEnum httpMethod, MessageSenderSettings settings, SyncMessage requestMessage) 要求電文に、共通プロトコルヘッダ相当部分及びフレームワーク制御ヘッダ部で使用する要素を追加する。
protected SimpleDataConvertResult	bodyStringToMap(java.lang.String uri, HttpProtocolClient.HttpRequestMethodEnum httpMethod, SyncMessage requestMessage, HttpResult httpResult) 返信のボディ部分を解析し、応答電文に設定するデータを生成する。
protected HttpInputStreamReader	createCharHttpStreamReader() HTTPリクエストを発行後、OutputStreamを読み取り結果を返却させるためのIFを生成する。
protected HttpOutputStreamWriter	createCharHttpStreamWritter(java.lang.String charset, java.lang.String bodyText) HTTPリクエストを発行時の送信内容を保持するオブジェクトを生成する。
protected HttpProtocolClient	createHttpProtocolClient() HTTPプロトコルを実装したクラスのインスタンスを生成する。
protected HttpResult	execute(HttpProtocolClient httpProtocolClient, HttpProtocolClient.HttpRequestMethodEnum httpMethod, java.lang.String uri, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerInfo, java.util.Map<java.lang.String,java.lang.String> urlParams, java.lang.String charset, java.lang.String bodyText) HTTPリクエストを送出する。
protected java.lang.String	getAccept() レスポンスの本文として受信可能なタイプを取得します
protected java.util.List<java.lang.String>	getExistBodyHttpMethod() 送信にbody部が存在するHTTPメソッドのリストを取得する。
java.lang.String	getQueryStringEncoding() クエリストリングをエンコードする際に使用する文字コードを取得する。
protected java.lang.String	getRequestContentsType(HttpProtocolClient.HttpRequestMethodEnum httpMethod, SimpleDataConvertResult requestBodyDataConvertResult) 送信時に設定するコンテンツタイプを取得する。
protected java.lang.String	getRequestMessageFormatFileNamePattern() 要求電文のフォーマット定義ファイル名のパターンを取得する。
protected java.lang.String	getResponseMessageFormatFileNamePattern() 応答電文のデータフォーマット定義ファイル名パターンを取得する。
java.lang.String	getUserIdToFormatKey() ユーザIDとフォーマット定義ファイル上のキーとの対応を取得する。
protected java.util.Map<java.lang.String,java.lang.Object>	headerToMap(SyncMessage requestMessage, HttpResult httpResult) 返信のヘッダ部分を解析し、応答電文に設定するデータを生成する。
protected void	initHttpProtocolClient(HttpProtocolClient argHttpProtocolClient, MessageSenderSettings settings, java.lang.String mimeType) HTTPプロトコルを実装したクラスのインスタンスの初期化を行う。
protected SimpleDataConvertResult	mapToBodyString(java.lang.String uri, HttpProtocolClient.HttpRequestMethodEnum httpMethod, SyncMessage requestMessage) HTTP通信のボディ部を生成する。
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	mapToHeaderMap(SyncMessage requestMessage) HTTPヘッダに含める内容を生成する。
protected java.util.Map<java.lang.String,java.lang.String>	mapToQueryMap(java.lang.String preUri, HttpProtocolClient.HttpRequestMethodEnum httpMethod, SyncMessage requestMessage) クエリストリングを生成する。
protected java.lang.String	mapToUriString(java.lang.String preUri, HttpProtocolClient.HttpRequestMethodEnum httpMethod, SyncMessage requestMessage) URIを生成する。
SyncMessage	sendSync(MessageSenderSettings settings, SyncMessage requestMessage) HTTPを使用したリアルタイム通信通信を行う。
void	setQueryStringEncoding(java.lang.String queryStringEncoding) クエリストリングをエンコードする際に使用する文字コードを設定する。
void	setUserIdToFormatKey(java.lang.String userIdToFormatKey) ユーザIDとフォーマット定義ファイル上のキーとの対応を設定する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

SYNCMESSAGE_STATUS_CODE

public static final java.lang.String SYNCMESSAGE_STATUS_CODE

SyncMessageのヘッダレコードからステータスコードを取り出すために使用するキー

関連項目:

定数フィールド値

コンストラクタの詳細

HttpMessagingClient

public HttpMessagingClient()

メソッドの詳細

sendSync

public SyncMessage sendSync(MessageSenderSettings settings,
                            SyncMessage requestMessage)
                     throws MessagingException

HTTPを使用したリアルタイム通信通信を行う。

定義:

sendSync インタフェース内 MessageSenderClient

パラメータ:

settings - MessageSenderの設定情報

requestMessage - 要求電文

戻り値:

応答電文

例外:

MessagingException - 通信に失敗した際に送出される。

addCommonValue

protected void addCommonValue(HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                              MessageSenderSettings settings,
                              SyncMessage requestMessage)

要求電文に、共通プロトコルヘッダ相当部分及びフレームワーク制御ヘッダ部で使用する要素を追加する。

パラメータ:

httpMethod - HTTPメソッド

settings - MessageSenderの設定情報

requestMessage - 要求電文

createHttpProtocolClient

protected HttpProtocolClient createHttpProtocolClient()

HTTPプロトコルを実装したクラスのインスタンスを生成する。

戻り値:

HTTPプロトコルを用いた通信を行うクラスのインスタンス

initHttpProtocolClient

protected void initHttpProtocolClient(HttpProtocolClient argHttpProtocolClient,
                                      MessageSenderSettings settings,
                                      java.lang.String mimeType)

HTTPプロトコルを実装したクラスのインスタンスの初期化を行う。

パラメータ:

argHttpProtocolClient - 初期化対象のHttpProtocolClientのインスタンス

settings - MessageSenderの設定情報

mimeType - 送信するデータの種別

getAccept

protected java.lang.String getAccept()

レスポンスの本文として受信可能なタイプを取得します

戻り値:

レスポンスの本文として受信可能なタイプ

mapToUriString

protected java.lang.String mapToUriString(java.lang.String preUri,
                                          HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                          SyncMessage requestMessage)

URIを生成する。

このメソッドはURI生成ルールのカスタマイズのために存在している。本クラスの実装では、引数preUriを返却する。

パラメータ:

preUri - メッセージ送信定義に記述されているURI

httpMethod - HTTPメソッド

requestMessage - 要求電文

戻り値:

URI

mapToQueryMap

protected java.util.Map<java.lang.String,java.lang.String> mapToQueryMap(java.lang.String preUri,
                                                                         HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                                                         SyncMessage requestMessage)

クエリストリングを生成する。

このメソッドはクエリストリング生成ルールのカスタマイズのために存在している。本クラスの実装では、空のMapを返す。

パラメータ:

preUri - メッセージ送信定義に記述されているURI

httpMethod - HTTPメソッド

requestMessage - 要求電文

戻り値:

URI

mapToHeaderMap

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> mapToHeaderMap(SyncMessage requestMessage)

HTTPヘッダに含める内容を生成する。

パラメータ:

requestMessage - 要求電文

戻り値:

HTTPヘッダに含める内容を格納したMap

mapToBodyString

protected SimpleDataConvertResult mapToBodyString(java.lang.String uri,
                                                  HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                                  SyncMessage requestMessage)
                                           throws HttpMessagingInvalidDataFormatException

HTTP通信のボディ部を生成する。

パラメータ:

uri - 接続先

httpMethod - HTTPメソッド

requestMessage - 要求電文

戻り値:

変換後の文字列

例外:

HttpMessagingInvalidDataFormatException - 電文フォーマット変換に失敗した場合に送出される。

getRequestContentsType

protected java.lang.String getRequestContentsType(HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                                  SimpleDataConvertResult requestBodyDataConvertResult)

送信時に設定するコンテンツタイプを取得する。

パラメータ:

httpMethod - HTTPメソッド

requestBodyDataConvertResult - 本文のデータ変換結果

戻り値:

コンテンツタイプ

execute

protected HttpResult execute(HttpProtocolClient httpProtocolClient,
                             HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                             java.lang.String uri,
                             java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerInfo,
                             java.util.Map<java.lang.String,java.lang.String> urlParams,
                             java.lang.String charset,
                             java.lang.String bodyText)

HTTPリクエストを送出する。

パラメータ:

httpProtocolClient - HTTPリクエストを発行するオブジェクト

httpMethod - HTTPメソッド

uri - 送信先

headerInfo - HTTPリクエストのヘッダ情報

urlParams - URLパラメータ

charset - 文字コード

bodyText - HTTPリクエストの本文

戻り値:

送信結果

createCharHttpStreamReader

protected HttpInputStreamReader createCharHttpStreamReader()

HTTPリクエストを発行後、OutputStreamを読み取り結果を返却させるためのIFを生成する。

戻り値:

OutputStreamを読み取り結果を返却させるためのIF

createCharHttpStreamWritter

protected HttpOutputStreamWriter createCharHttpStreamWritter(java.lang.String charset,
                                                             java.lang.String bodyText)

HTTPリクエストを発行時の送信内容を保持するオブジェクトを生成する。

パラメータ:

charset - 文字コード

bodyText - 送信時の本文

戻り値:

送信内容を表すオブジェクト

headerToMap

protected java.util.Map<java.lang.String,java.lang.Object> headerToMap(SyncMessage requestMessage,
                                                                       HttpResult httpResult)

返信のヘッダ部分を解析し、応答電文に設定するデータを生成する。

パラメータ:

requestMessage - 要求電文

httpResult - 送信結果

戻り値:

解析後のMap

bodyStringToMap

protected SimpleDataConvertResult bodyStringToMap(java.lang.String uri,
                                                  HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                                  SyncMessage requestMessage,
                                                  HttpResult httpResult)
                                           throws HttpMessagingInvalidDataFormatException

返信のボディ部分を解析し、応答電文に設定するデータを生成する。

パラメータ:

uri - 接続先

httpMethod - HTTPメソッド

requestMessage - 要求電文

httpResult - 送信結果

戻り値:

解析後のMap

例外:

HttpMessagingInvalidDataFormatException - 電文フォーマット変換に失敗した場合に送出される。

getResponseMessageFormatFileNamePattern

protected java.lang.String getResponseMessageFormatFileNamePattern()

応答電文のデータフォーマット定義ファイル名パターンを取得する。

戻り値:

応答電文のデータフォーマット定義ファイル名パターン

getRequestMessageFormatFileNamePattern

protected java.lang.String getRequestMessageFormatFileNamePattern()

要求電文のフォーマット定義ファイル名のパターンを取得する。

戻り値:

要求電文のフォーマット定義ファイル名のパターン

getUserIdToFormatKey

public java.lang.String getUserIdToFormatKey()

ユーザIDとフォーマット定義ファイル上のキーとの対応を取得する。

戻り値:

フォーマット定義ファイル上のキー

setUserIdToFormatKey

public void setUserIdToFormatKey(java.lang.String userIdToFormatKey)

ユーザIDとフォーマット定義ファイル上のキーとの対応を設定する。

パラメータ:

userIdToFormatKey - フォーマット定義ファイル上のキー

getExistBodyHttpMethod

protected java.util.List<java.lang.String> getExistBodyHttpMethod()

送信にbody部が存在するHTTPメソッドのリストを取得する。

戻り値:

送信にbody部が存在するHTTPメソッドのリスト

getQueryStringEncoding

public java.lang.String getQueryStringEncoding()

クエリストリングをエンコードする際に使用する文字コードを取得する。

戻り値:

文字コード

setQueryStringEncoding

public void setQueryStringEncoding(java.lang.String queryStringEncoding)

クエリストリングをエンコードする際に使用する文字コードを設定する。

パラメータ:

queryStringEncoding - 文字コード