nablarch.fw.messaging

クラス SendingMessage

java.lang.Object

nablarch.fw.messaging.InterSystemMessage<SendingMessage>

nablarch.fw.messaging.SendingMessage

直系の既知のサブクラス:

ResponseMessage

public class SendingMessage
extends InterSystemMessage<SendingMessage>

対外システムに対する仕向け要求電文を表すクラス。

作成者:

Iwauo Tajima

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

コンストラクタ

コンストラクタと説明
SendingMessage() SendingMessageを生成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
SendingMessage	addRecord(Map<?> record) 電文のデータ部に、指定したレコードを追加する。
SendingMessage	addRecord(Object recordObj) 電文のデータ部に指定したレコードを追加する。
SendingMessage	addRecord(String recordType, Map<?> record) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。
SendingMessage	addRecord(String recordType, Object recordObj) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。
byte[]	getBodyBytes() メッセーボディのバイナリ表現を返す。
ByteArrayOutputStream	getBodyStream() 電文のボディ部の出力ストリームを返す。
SendingMessage	setTimeToLive(long timeToLive) 電文の有効期間をmsec単位で設定する。

クラスから継承されたメソッド nablarch.fw.messaging.InterSystemMessage

getCorrelationId, getDestination, getHeaderMap, getMessageId, getParam, getParamMap, getRecordOf, getRecords, getRecordsOf, getReplyTo, setCorrelationId, setDestination, setFormatter, setMessageId, setReplyTo

コンストラクタの詳細

SendingMessage

@Published(tag="architect")
public SendingMessage()

SendingMessageを生成する。

メソッドの詳細

addRecord

@Published
public SendingMessage addRecord(Map<?> record)
                                    throws InvalidDataFormatException

電文のデータ部に、指定したレコードを追加する。

出力時に使用するデータレイアウト（レコードタイプ）は、recordの内容から自動的に判別される。

パラメータ:

record - レコード内容

戻り値:

このオブジェクト自体

例外:

InvalidDataFormatException - レコードの内容がフォーマット定義に違反している場合

addRecord

@Published
public SendingMessage addRecord(String recordType,
                                           Map<?> record)
                                    throws InvalidDataFormatException

電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。

recordTypeにnullを渡した場合、SendingMessage.addRecord(Map)と同様の処理を行う。

パラメータ:

recordType - レコードタイプ

record - レコード内容

戻り値:

このオブジェクト自体

例外:

InvalidDataFormatException - レコードの内容がフォーマット定義に違反している場合

addRecord

@Published
public SendingMessage addRecord(Object recordObj)
                                    throws InvalidDataFormatException

電文のデータ部に指定したレコードを追加する。

出力時に使用するデータレイアウト（レコードタイプ）は、渡されたデータの内容から自動的に判別される。

パラメータ:

recordObj - レコード内容を表現したオブジェクト

戻り値:

このオブジェクト自体

例外:

InvalidDataFormatException - レコードの内容がフォーマット定義に違反している場合

addRecord

@Published
public SendingMessage addRecord(String recordType,
                                           Object recordObj)
                                    throws InvalidDataFormatException

電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。

recordTypeにnullを渡した場合、SendingMessage.addRecord(Object)と同様の処理を行う。

パラメータ:

recordType - レコードタイプ

recordObj - レコード内容を表現したオブジェクト

戻り値:

このオブジェクト自体

例外:

InvalidDataFormatException - レコードの内容がフォーマット定義に違反している場合

getBodyBytes

@Published(tag="architect")
public byte[] getBodyBytes()

メッセーボディのバイナリ表現を返す。 送信(仕向)電文の場合はデータレコードをレコードフォーマッタで直列化したものを返す。 受信(被仕向)電文の場合はパース前の送信電文の内容をそのまま返す。

戻り値:

メッセーボディのバイナリ表現

getBodyStream

@Published(tag="architect")
public ByteArrayOutputStream getBodyStream()

電文のボディ部の出力ストリームを返す。

戻り値:

電文のボディ部の出力ストリーム

setTimeToLive

@Published(tag="architect")
public SendingMessage setTimeToLive(long timeToLive)

電文の有効期間をmsec単位で設定する。

0以下の数値を指定した場合は無期限となる。 本メソッドで有効期間を指定しなかった場合は、プロバイダ側で定めたデフォルト値が設定される。

パラメータ:

timeToLive - この電文の有効期間(msec)

戻り値:

このオブジェクト自体