Package nablarch.fw.messaging
Class SendingMessage
- Direct Known Subclasses:
ResponseMessage
対外システムに対する仕向け要求電文を表すクラス。
-
Nested Class Summary
Nested classes/interfaces inherited from class nablarch.fw.messaging.InterSystemMessage
InterSystemMessage.HeaderName
-
Constructor Summary
ConstructorDescriptionSendingMessage
を生成する。SendingMessage
(SendingMessage original) 元となるSendingMessage
からインスタンスを生成する。 -
Method Summary
Modifier and TypeMethodDescription電文のデータ部に指定したレコードを追加する。電文のデータ部に、出力時に使用するデータレイアウト(レコードタイプ)を指定してレコードを追加する。電文のデータ部に、出力時に使用するデータレイアウト(レコードタイプ)を指定してレコードを追加する。電文のデータ部に、指定したレコードを追加する。byte[]
メッセーボディのバイナリ表現を返す。 送信(仕向)電文の場合はデータレコードをレコードフォーマッタで直列化したものを返す。 受信(被仕向)電文の場合はパース前の送信電文の内容をそのまま返す。電文のボディ部の出力ストリームを返す。long
電文の有効期間をmsec単位で返す。setTimeToLive
(long timeToLive) 電文の有効期間をmsec単位で設定する。Methods inherited from class nablarch.fw.messaging.InterSystemMessage
getCorrelationId, getDestination, getFormatter, getHeader, getHeaderMap, getMessageId, getParam, getParamMap, getRecordOf, getRecords, getRecordsOf, getReplyTo, setCorrelationId, setDestination, setFormatter, setHeader, setHeaderMap, setMessageId, setReplyTo
-
Constructor Details
-
SendingMessage
SendingMessage
を生成する。 -
SendingMessage
元となるSendingMessage
からインスタンスを生成する。- Parameters:
original
- 元電文オブジェクト
-
-
Method Details
-
addRecord
電文のデータ部に、指定したレコードを追加する。 出力時に使用するデータレイアウト(レコードタイプ)は、record
の内容から自動的に判別される。- Parameters:
record
- レコード内容- Returns:
- このオブジェクト自体
- Throws:
InvalidDataFormatException
- レコードの内容がフォーマット定義に違反している場合
-
addRecord
@Published public SendingMessage addRecord(String recordType, Map<String, ?> record) throws InvalidDataFormatException- Parameters:
recordType
- レコードタイプrecord
- レコード内容- Returns:
- このオブジェクト自体
- Throws:
InvalidDataFormatException
- レコードの内容がフォーマット定義に違反している場合
-
addRecord
電文のデータ部に指定したレコードを追加する。 出力時に使用するデータレイアウト(レコードタイプ)は、渡されたデータの内容から自動的に判別される。- Parameters:
recordObj
- レコード内容を表現したオブジェクト- Returns:
- このオブジェクト自体
- Throws:
InvalidDataFormatException
- レコードの内容がフォーマット定義に違反している場合
-
addRecord
@Published public SendingMessage addRecord(String recordType, Object recordObj) throws InvalidDataFormatException - Parameters:
recordType
- レコードタイプrecordObj
- レコード内容を表現したオブジェクト- Returns:
- このオブジェクト自体
- Throws:
InvalidDataFormatException
- レコードの内容がフォーマット定義に違反している場合
-
getBodyBytes
メッセーボディのバイナリ表現を返す。 送信(仕向)電文の場合はデータレコードをレコードフォーマッタで直列化したものを返す。 受信(被仕向)電文の場合はパース前の送信電文の内容をそのまま返す。- Specified by:
getBodyBytes
in classInterSystemMessage<SendingMessage>
- Returns:
- メッセーボディのバイナリ表現
-
getBodyStream
電文のボディ部の出力ストリームを返す。- Returns:
- 電文のボディ部の出力ストリーム
-
getTimeToLive
public long getTimeToLive()電文の有効期間をmsec単位で返す。- Returns:
- 電文の有効期間(msec)
-
setTimeToLive
電文の有効期間をmsec単位で設定する。 0以下の数値を指定した場合は無期限となる。 本メソッドで有効期間を指定しなかった場合は、プロバイダ側で定めたデフォルト値が設定される。- Parameters:
timeToLive
- この電文の有効期間(msec)- Returns:
- このオブジェクト自体
-