Module dk.cloudcreate.essentials.components.foundation

Package dk.cloudcreate.essentials.components.foundation.messaging.eip.store_and_forward

package dk.cloudcreate.essentials.components.foundation.messaging.eip.store_and_forward
  • Class
    Description
    Inbox
    The Inbox supports the transactional Store and Forward pattern from Enterprise Integration Patterns supporting At-Least-Once delivery guarantee.
    The Inbox pattern is used to handle incoming messages from a message infrastructure (such as a Queue, Kafka, EventBus, etc).
    InboxConfig
     
    InboxConfigBuilder
     
    Inboxes
    The Inbox supports the transactional Store and Forward pattern from Enterprise Integration Patterns supporting At-Least-Once delivery guarantee.
    The Inbox pattern is used to handle incoming messages from a message infrastructure (such as a Queue, Kafka, EventBus, etc.).
    Inboxes.DurableQueueBasedInboxes
    Inboxes variant that uses DurableQueues as the underlying implementation.
    ONLY in cases where the underlying DurableQueues is associated with a UnitOfWorkFactory will the Inbox message consumption be performed within UnitOfWork, otherwise message consumption isn't performed with a UnitOfWork
    InboxName
    The name of an Inbox
    MessageConsumptionMode
    Defines how messages can be consumed by the provided message consumer
    MessageHandlerInterceptor
     
    Outbox
    The Outbox supports the transactional Store and Forward pattern from Enterprise Integration Patterns supporting At-Least-Once delivery guarantee.
    The Outbox pattern is used to handle outgoing messages, that are created as a side effect of adding/updating an entity in a database, but where the message infrastructure (such as a Queue, Kafka, EventBus, etc.) that doesn't share the same underlying transactional resource as the database.
    Instead, you need to use an Outbox that can join in the same UnitOfWork/transactional-resource that the database is using.
    The message is added to the Outbox in a transaction/UnitOfWork and afterwards the UnitOfWork is committed.
    If the transaction fails then both the entity and the message will be rolled back when then UnitOfWork rolls back.
    After the UnitOfWork has been committed, the messages will be asynchronously delivered to the message consumer in a new UnitOfWork.
    The Outbox itself supports Message Redelivery in case the Message consumer experiences failures.
    This means that the Message consumer, registered with the Outbox, can and will receive Messages more than once and therefore its message handling has to be idempotent.
    OutboxConfig
     
    OutboxConfigBuilder
     
    Outboxes
    The Outbox supports the transactional Store and Forward pattern from Enterprise Integration Patterns supporting At-Least-Once delivery guarantee.
    The Outbox pattern is used to handle outgoing messages, that are created as a side effect of adding/updating an entity in a database, but where the message infrastructure (such as a Queue, Kafka, EventBus, etc.) that doesn't share the same underlying transactional resource as the database.
    Instead, you need to use an Outbox that can join in the same UnitOfWork/transactional-resource that the database is using.
    IF the message is added to the Outbox in a transaction/UnitOfWork and the UnitOfWork is committed together (this is dependent on the underlying implementation - see Outboxes.DurableQueueBasedOutboxes).
    In case adding the message happens in a shared transaction/UnitOfWork, then if the transaction fails then both the entity and the message will be rolled back when then UnitOfWork rolls back.
    Outboxes.DurableQueueBasedOutboxes
    Outboxes variant that uses DurableQueues as the underlying implementation.
    ONLY in cases where the underlying DurableQueues is associated with a UnitOfWorkFactory will the Outbox message consumption be performed within UnitOfWork, otherwise message consumption isn't performed with a UnitOfWork
    OutboxName
    The name of an Outbox
    PatternMatchingMessageHandler
    Pattern matching Consumer<Message> for use with Inboxes/Inbox or Outboxes/Outbox
    The PatternMatchingMessageHandler will automatically call methods annotated with the @MessageHandler annotation and where the 1st argument matches the actual Message payload type (contained in the Message.getPayload() provided to the provided Consumer)