HttpMessagingClient (NablarchApi)

java.lang.Object
- nablarch.fw.messaging.realtime.http.client.HttpMessagingClient

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

MessageSenderClient
```
@Published(tag="architect")
public class HttpMessagingClient
extends Object
implements MessageSenderClient
```
HTTPを利用したメッセージング機能の実装。

作成者:

Masaya Seko

フィールドのサマリー

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

メソッドのサマリー

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

- フィールドの詳細
  - SYNCMESSAGE_STATUS_CODE
```
public static final String SYNCMESSAGE_STATUS_CODE
```
    SyncMessageのヘッダレコードからステータスコードを取り出すために使用するキー
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - sendSync
```
public SyncMessage sendSync(MessageSenderSettings settings,
                            SyncMessage requestMessage)
                     throws MessagingException
```
    HTTPを使用したリアルタイム通信通信を行う。
    
    定義:
    
    sendSync インタフェース内 MessageSenderClient
    
    パラメータ:
    
    settings - MessageSenderの設定情報
    
    requestMessage - 要求電文
    
    戻り値:
    
    応答電文
    
    例外:
    
    MessagingException - 通信に失敗した際に送出される。
  - addCommonValue
```
protected void addCommonValue(nablarch.fw.messaging.realtime.http.client.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,
                                      String mimeType)
```
    HTTPプロトコルを実装したクラスのインスタンスの初期化を行う。
    
    パラメータ:
    
    argHttpProtocolClient - 初期化対象のHttpProtocolClientのインスタンス
    
    settings - MessageSenderの設定情報
    
    mimeType - 送信するデータの種別
  - getAccept
```
protected String getAccept()
```
    レスポンスの本文として受信可能なタイプを取得します
    
    戻り値:
    
    レスポンスの本文として受信可能なタイプ
  - mapToUriString
```
protected String mapToUriString(String preUri,
                                nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                SyncMessage requestMessage)
```
    URIを生成する。
    このメソッドはURI生成ルールのカスタマイズのために存在している。本クラスの実装では、引数preUriを返却する。
    
    パラメータ:
    
    preUri - メッセージ送信定義に記述されているURI
    
    httpMethod - HTTPメソッド
    
    requestMessage - 要求電文
    
    戻り値:
    
    URI
  - mapToQueryMap
```
protected Map mapToQueryMap(String preUri,
                            nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                            SyncMessage requestMessage)
```
    クエリストリングを生成する。
    このメソッドはクエリストリング生成ルールのカスタマイズのために存在している。本クラスの実装では、空のMapを返す。
    
    パラメータ:
    
    preUri - メッセージ送信定義に記述されているURI
    
    httpMethod - HTTPメソッド
    
    requestMessage - 要求電文
    
    戻り値:
    
    URI
  - mapToHeaderMap
```
protected Map<List> mapToHeaderMap(SyncMessage requestMessage)
```
    HTTPヘッダに含める内容を生成する。
    
    パラメータ:
    
    requestMessage - 要求電文
    
    戻り値:
    
    HTTPヘッダに含める内容を格納したMap
  - mapToBodyString
```
protected nablarch.core.dataformat.SimpleDataConvertResult mapToBodyString(String uri,
                                                                           nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                                                           SyncMessage requestMessage)
                                                                    throws HttpMessagingInvalidDataFormatException
```
    HTTP通信のボディ部を生成する。
    
    パラメータ:
    
    uri - 接続先
    
    httpMethod - HTTPメソッド
    
    requestMessage - 要求電文
    
    戻り値:
    
    変換後の文字列
    
    例外:
    
    HttpMessagingInvalidDataFormatException - 電文フォーマット変換に失敗した場合に送出される。
  - getRequestContentsType
```
protected String getRequestContentsType(nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                        nablarch.core.dataformat.SimpleDataConvertResult requestBodyDataConvertResult)
```
    送信時に設定するコンテンツタイプを取得する。
    
    パラメータ:
    
    httpMethod - HTTPメソッド
    
    requestBodyDataConvertResult - 本文のデータ変換結果
    
    戻り値:
    
    コンテンツタイプ
  - execute
```
protected HttpResult execute(HttpProtocolClient httpProtocolClient,
                             nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                             String uri,
                             Map<List> headerInfo,
                             Map urlParams,
                             String charset,
                             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(String charset,
                                                             String bodyText)
```
    HTTPリクエストを発行時の送信内容を保持するオブジェクトを生成する。
    
    パラメータ:
    
    charset - 文字コード
    
    bodyText - 送信時の本文
    
    戻り値:
    
    送信内容を表すオブジェクト
  - headerToMap
```
protected Map headerToMap(SyncMessage requestMessage,
                          HttpResult httpResult)
```
    返信のヘッダ部分を解析し、応答電文に設定するデータを生成する。
    
    パラメータ:
    
    requestMessage - 要求電文
    
    httpResult - 送信結果
    
    戻り値:
    
    解析後のMap
  - bodyStringToMap
```
protected nablarch.core.dataformat.SimpleDataConvertResult bodyStringToMap(String uri,
                                                                           nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                                                                           SyncMessage requestMessage,
                                                                           HttpResult httpResult)
                                                                    throws HttpMessagingInvalidDataFormatException
```
    返信のボディ部分を解析し、応答電文に設定するデータを生成する。
    
    パラメータ:
    
    uri - 接続先
    
    httpMethod - HTTPメソッド
    
    requestMessage - 要求電文
    
    httpResult - 送信結果
    
    戻り値:
    
    解析後のMap
    
    例外:
    
    HttpMessagingInvalidDataFormatException - 電文フォーマット変換に失敗した場合に送出される。
  - getResponseMessageFormatFileNamePattern
```
protected String getResponseMessageFormatFileNamePattern()
```
    応答電文のデータフォーマット定義ファイル名パターンを取得する。
    
    戻り値:
    
    応答電文のデータフォーマット定義ファイル名パターン
  - getRequestMessageFormatFileNamePattern
```
protected String getRequestMessageFormatFileNamePattern()
```
    要求電文のフォーマット定義ファイル名のパターンを取得する。
    
    戻り値:
    
    要求電文のフォーマット定義ファイル名のパターン
  - getUserIdToFormatKey
```
public String getUserIdToFormatKey()
```
    ユーザIDとフォーマット定義ファイル上のキーとの対応を取得する。
    
    戻り値:
    
    フォーマット定義ファイル上のキー
  - setUserIdToFormatKey
```
public void setUserIdToFormatKey(String userIdToFormatKey)
```
    ユーザIDとフォーマット定義ファイル上のキーとの対応を設定する。
    
    パラメータ:
    
    userIdToFormatKey - フォーマット定義ファイル上のキー
  - getExistBodyHttpMethod
```
protected List getExistBodyHttpMethod()
```
    送信にbody部が存在するHTTPメソッドのリストを取得する。
    
    戻り値:
    
    送信にbody部が存在するHTTPメソッドのリスト
  - getQueryStringEncoding
```
public String getQueryStringEncoding()
```
    クエリストリングをエンコードする際に使用する文字コードを取得する。
    
    戻り値:
    
    文字コード
  - setQueryStringEncoding
```
public void setQueryStringEncoding(String queryStringEncoding)
```
    クエリストリングをエンコードする際に使用する文字コードを設定する。
    
    パラメータ:
    
    queryStringEncoding - 文字コード

クラス HttpMessagingClient

フィールドのサマリー

メソッドのサマリー

フィールドの詳細

SYNCMESSAGE_STATUS_CODE

メソッドの詳細

sendSync

addCommonValue

createHttpProtocolClient

initHttpProtocolClient

getAccept

mapToUriString

mapToQueryMap

mapToHeaderMap

mapToBodyString

getRequestContentsType

execute

createCharHttpStreamReader

createCharHttpStreamWritter

headerToMap

bodyStringToMap

getResponseMessageFormatFileNamePattern

getRequestMessageFormatFileNamePattern

getUserIdToFormatKey

setUserIdToFormatKey

getExistBodyHttpMethod

getQueryStringEncoding

setQueryStringEncoding