Package 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>
対外システムに対する仕向け要求電文を表すクラス。

  • Constructor Details

    • SendingMessage

      @Published(tag="architect") public SendingMessage()
      SendingMessageを生成する。

    • SendingMessage

      public SendingMessage(SendingMessage original)
      元となるSendingMessageからインスタンスを生成する。
      Parameters:
      original - 元電文オブジェクト

  • Method Details

    • addRecord

      @Published public SendingMessage addRecord(Map<String,?> record) throws InvalidDataFormatException
      電文のデータ部に、指定したレコードを追加する。

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

      Parameters:
      record - レコード内容
      Returns:
      このオブジェクト自体
      Throws:
      InvalidDataFormatException - レコードの内容がフォーマット定義に違反している場合

    • addRecord

      @Published public SendingMessage addRecord(String recordType, Map<String,?> record) throws InvalidDataFormatException
      電文のデータ部に、出力時に使用するデータレイアウト（レコードタイプ）を指定してレコードを追加する。

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

      Parameters:
      recordType - レコードタイプ
      record - レコード内容
      Returns:
      このオブジェクト自体
      Throws:
      InvalidDataFormatException - レコードの内容がフォーマット定義に違反している場合

    • addRecord

      @Published public SendingMessage addRecord(Object recordObj) throws InvalidDataFormatException
      電文のデータ部に指定したレコードを追加する。

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

      Parameters:
      recordObj - レコード内容を表現したオブジェクト
      Returns:
      このオブジェクト自体
      Throws:
      InvalidDataFormatException - レコードの内容がフォーマット定義に違反している場合

    • addRecord

      @Published public SendingMessage addRecord(String recordType, 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 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:
      このオブジェクト自体