nablarch.fw.messaging

Class SendingMessage

java.lang.Object

nablarch.fw.messaging.InterSystemMessage<SendingMessage>

nablarch.fw.messaging.SendingMessage

Direct Known Subclasses:

ResponseMessage

public class SendingMessage
extends InterSystemMessage<SendingMessage>

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

Nested Class Summary

Nested classes/interfaces inherited from class nablarch.fw.messaging.InterSystemMessage

InterSystemMessage.HeaderName

Constructor Summary

Constructors

Constructor and Description
SendingMessage() SendingMessageを生成する。
SendingMessage(SendingMessage original) 元となるSendingMessageからインスタンスを生成する。

Method Summary

Modifier and Type	Method and Description
SendingMessage	addRecord(java.util.Map<java.lang.String,?> record) 電文のデータ部に、指定したレコードを追加する。 出力時に使用するデータレイアウト（レコードタイプ）は、recordの内容から自動的に判別される。
SendingMessage	addRecord(java.lang.Object recordObj) 電文のデータ部に指定したレコードを追加する。 出力時に使用するデータレイアウト（レコードタイプ）は、渡されたデータの内容から自動的に判別される。
SendingMessage	addRecord(java.lang.String recordType, java.util.Map<java.lang.String,?> record) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。 recordTypeにnullを渡した場合、addRecord(Map)と同様の処理を行う。
SendingMessage	addRecord(java.lang.String recordType, java.lang.Object recordObj) 電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。 recordTypeにnullを渡した場合、addRecord(Object)と同様の処理を行う。
byte[]	getBodyBytes() メッセーボディのバイナリ表現を返す。 送信(仕向)電文の場合はデータレコードをレコードフォーマッタで直列化したものを返す。 受信(被仕向)電文の場合はパース前の送信電文の内容をそのまま返す。
java.io.ByteArrayOutputStream	getBodyStream() 電文のボディ部の出力ストリームを返す。
long	getTimeToLive() 電文の有効期間をmsec単位で返す。
SendingMessage	setTimeToLive(long timeToLive) 電文の有効期間をmsec単位で設定する。 0以下の数値を指定した場合は無期限となる。 本メソッドで有効期間を指定しなかった場合は、プロバイダ側で定めたデフォルト値が設定される。

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SendingMessage

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

SendingMessageを生成する。

SendingMessage

public SendingMessage(SendingMessage original)

元となるSendingMessageからインスタンスを生成する。

Parameters:

original - 元電文オブジェクト

Method Detail

addRecord

@Published
public SendingMessage addRecord(java.util.Map<java.lang.String,?> record)
                                    throws InvalidDataFormatException

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

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

Parameters:

record - レコード内容

Returns:

このオブジェクト自体

Throws:

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

addRecord

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

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

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

Parameters:

recordType - レコードタイプ

record - レコード内容

Returns:

このオブジェクト自体

Throws:

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

addRecord

@Published
public SendingMessage addRecord(java.lang.Object recordObj)
                                    throws InvalidDataFormatException

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

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

Parameters:

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

Returns:

このオブジェクト自体

Throws:

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

addRecord

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

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

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

Parameters:

recordType - レコードタイプ

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

Returns:

このオブジェクト自体

Throws:

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

getBodyBytes

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

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

Specified by:

getBodyBytes in class InterSystemMessage<SendingMessage>

Returns:

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

getBodyStream

@Published(tag="architect")
public java.io.ByteArrayOutputStream getBodyStream()

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

Returns:

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

getTimeToLive

public long getTimeToLive()

電文の有効期間をmsec単位で返す。

Returns:

電文の有効期間(msec)

setTimeToLive

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

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

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

Parameters:

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

Returns:

このオブジェクト自体