java.lang.Object
- dk.cloudcreate.essentials.components.foundation.messaging.eip.store_and_forward.Outboxes.DurableQueueBasedOutboxes.DurableQueueBasedOutbox

All Implemented Interfaces:: Outbox

Enclosing class:: Outboxes.DurableQueueBasedOutboxes

public class Outboxes.DurableQueueBasedOutboxes.DurableQueueBasedOutbox
extends Object
implements Outbox

Field Summary

Fields
Modifier and Type Field Description

OutboxConfig config

QueueName outboxQueueName

Constructor Summary

Constructors
Constructor	Description
`DurableQueueBasedOutbox(OutboxConfig config)`
`DurableQueueBasedOutbox(OutboxConfig config, Consumer<Message> messageConsumer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Outbox`	`consume(Consumer<Message> messageConsumer)`	Start consuming messages from the Outbox using the provided message consumer. This is the same as calling `Outbox.setMessageConsumer(Consumer)` followed by `Outbox.startConsuming()` Only needs to be called if the instance was created without a message consumer such as via `Outboxes.getOrCreateOutbox(OutboxConfig)`
`long`	`getNumberOfOutgoingMessages()`	Get the number of message in the outbox that haven't been sent yet
`boolean`	`hasAMessageConsumer()`	Has the instance been created with a Message consumer or has `Outbox.consume(Consumer)` been called
`boolean`	`isConsumingMessages()`	Is the provided Message consumer consuming messages from the `Outbox`
`OutboxName`	`name()`	The name of the outbox
`Outbox`	`sendMessage(Message payload)`	Send a message asynchronously. This message will be stored durably (without any duplication check) in connection with the currently active `UnitOfWork` (or a new `UnitOfWork` will be created in case no there isn't an active `UnitOfWork`). The message will be delivered asynchronously to the message consumer
`Outbox`	`setMessageConsumer(Consumer<Message> messageConsumer)`	Set the message consumer.
`Outbox`	`startConsuming()`	Start consuming messages from the `Outbox`.
`Outbox`	`stopConsuming()`	Stop consuming messages from the `Outbox`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface dk.cloudcreate.essentials.components.foundation.messaging.eip.store_and_forward.Outbox
sendMessage, sendMessage

- Field Detail
  - outboxQueueName
```
public final QueueName outboxQueueName
```
  - config
```
public final OutboxConfig config
```
- Constructor Detail
  - DurableQueueBasedOutbox
```
public DurableQueueBasedOutbox(OutboxConfig config,
                               Consumer<Message> messageConsumer)
```
  - DurableQueueBasedOutbox
```
public DurableQueueBasedOutbox(OutboxConfig config)
```
- Method Detail
  - setMessageConsumer
```
public Outbox setMessageConsumer(Consumer<Message> messageConsumer)
```
    Description copied from interface: Outbox
    
    Set the message consumer. To start consuming call Outbox.startConsuming()
    
    Specified by:
    
    setMessageConsumer in interface Outbox
    
    Parameters:
    
    messageConsumer - the message consumer. See PatternMatchingMessageHandler
    
    Returns:
    
    this outbox instance
  - consume
```
public Outbox consume(Consumer<Message> messageConsumer)
```
    Description copied from interface: Outbox
    
    Start consuming messages from the Outbox using the provided message consumer.
    This is the same as calling Outbox.setMessageConsumer(Consumer) followed by Outbox.startConsuming()
    Only needs to be called if the instance was created without a message consumer such as via Outboxes.getOrCreateOutbox(OutboxConfig)
    If an OrderedMessage is delivered via an Outbox using a FencedLock (such as the Outboxes.durableQueueBasedOutboxes(DurableQueues, FencedLockManager)) to coordinate message consumption, then you can find the FencedLock.getCurrentToken() of the consumer in the Message.getMetaData() under key MessageMetaData.FENCED_LOCK_TOKEN
    
    Specified by:
    
    consume in interface Outbox
    
    Parameters:
    
    messageConsumer - the message consumer. See PatternMatchingMessageHandler
    
    Returns:
    
    this outbox instance
  - hasAMessageConsumer
```
public boolean hasAMessageConsumer()
```
    Description copied from interface: Outbox
    
    Has the instance been created with a Message consumer or has Outbox.consume(Consumer) been called
    
    Specified by:
    
    hasAMessageConsumer in interface Outbox
    
    Returns:
    
    Has the instance been created with a Message consumer or has Outbox.consume(Consumer) been called
  - isConsumingMessages
```
public boolean isConsumingMessages()
```
    Description copied from interface: Outbox
    
    Is the provided Message consumer consuming messages from the Outbox
    
    Specified by:
    
    isConsumingMessages in interface Outbox
    
    Returns:
    
    Is the provided Message consumer consuming messages from the Outbox
  - startConsuming
```
public Outbox startConsuming()
```
    Description copied from interface: Outbox
    
    Start consuming messages from the Outbox. Requires calling Outbox.setMessageConsumer(Consumer) first
    If an OrderedMessage is delivered via an Outbox using a FencedLock (such as Outboxes.durableQueueBasedOutboxes(DurableQueues, FencedLockManager) to coordinate message consumption, then you can find the FencedLock.getCurrentToken() of the consumer in the Message.getMetaData() under key MessageMetaData.FENCED_LOCK_TOKEN
    
    Specified by:
    
    startConsuming in interface Outbox
    
    Returns:
    
    this outbox instance
  - stopConsuming
```
public Outbox stopConsuming()
```
    Description copied from interface: Outbox
    
    Stop consuming messages from the Outbox. Calling this method will remove the message consumer and to resume message consumption you need to call Outbox.consume(Consumer)
    
    Specified by:
    
    stopConsuming in interface Outbox
    
    Returns:
    
    this outbox instance
  - name
```
public OutboxName name()
```
    Description copied from interface: Outbox
    
    The name of the outbox
    
    Specified by:
    
    name in interface Outbox
    
    Returns:
    
    the name of the outbox
  - sendMessage
```
public Outbox sendMessage(Message payload)
```
    Description copied from interface: Outbox
    
    Send a message asynchronously.
    This message will be stored durably (without any duplication check) in connection with the currently active UnitOfWork (or a new UnitOfWork will be created in case no there isn't an active UnitOfWork).
    The message will be delivered asynchronously to the message consumer
    
    Specified by:
    
    sendMessage in interface Outbox
    
    Parameters:
    
    payload - the message
    
    Returns:
    
    this outbox instance
    
    See Also:
    
    OrderedMessage
  - getNumberOfOutgoingMessages
```
public long getNumberOfOutgoingMessages()
```
    Description copied from interface: Outbox
    
    Get the number of message in the outbox that haven't been sent yet
    
    Specified by:
    
    getNumberOfOutgoingMessages in interface Outbox
    
    Returns:
    
    Get the number of message in the outbox that haven't been sent yet
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Fields
Modifier and Type	Field	Description
`OutboxConfig`	`config`
`QueueName`	`outboxQueueName`

Class Outboxes.DurableQueueBasedOutboxes.DurableQueueBasedOutbox

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface dk.cloudcreate.essentials.components.foundation.messaging.eip.store_and_forward.Outbox

Field Detail

outboxQueueName

config

Constructor Detail

DurableQueueBasedOutbox

DurableQueueBasedOutbox

Method Detail

setMessageConsumer

consume

hasAMessageConsumer

isConsumingMessages

startConsuming

stopConsuming

name

sendMessage

getNumberOfOutgoingMessages

toString