Package de.aeb.xnsg.messagepool.bf.adapter

Interface IMessageAdapterBF

@BusinessFacade public interface IMessageAdapterBF
Interface with which the Incoming or Outgoing Adapters communicate message transfer from client to server.
This interface transfers most parameters as generic parameter objects to keep it technically stable for a very long time, over many versions.

  • Method Details

    • putMessage

      MessageAcknowledgeDTO putMessage(MessageBF_DTO message) throws InvalidMessageArguments
      called when the sending system operates in "polling" mode and is actively sending a message to its target
      Parameters:
      message - the message to transfer
      Throws:
      InvalidMessageArguments

    • getMessage

      MessageBF_DTO getMessage(MessagePropertyDTO[] properties) throws InvalidMessageArguments
      called by the receiver when the sending system operates in "event" mode waiting for the receiver to fetch the next message
      Parameters:
      properties - describing the message queried, see MessageBF_DTO constants for valid values, important fields in this version are MSG_TARGET and MSG_CHANNEL_ID other versions/implementations might support further properties that specify which message should be retrieved, e.g. priority.
      Throws:
      InvalidMessageArguments - when arguments are missing or invalid, e.g. unknown target

    • acknowledgeMessage

      void acknowledgeMessage(MessageAcknowledgeDTO ack, MessagePropertyDTO[] properties) throws InvalidMessageArguments
      called by the receiver when the message was queried via getMessage(), to inform the sender on how the message was received
      Parameters:
      ack - - the acknowledge data see MessageBF_DTO constants for valid values, important fields in this version are MSG_TARGET and MSG_CHANNEL_ID, which must conform to the values of the message that is referenced by the field messageId in the ack argument. Other versions/implementations might require further fields to uniquely identify the channel that must acknowledge the message.
      Throws:
      InvalidMessageArguments - when arguments are missing or invalid, e.g. unknown target