java.lang.Object
- dk.cloudcreate.essentials.components.foundation.messaging.eip.store_and_forward.Inboxes.DurableQueueBasedInboxes.DurableQueueBasedInbox

All Implemented Interfaces:: Inbox

Enclosing class:: Inboxes.DurableQueueBasedInboxes

public class Inboxes.DurableQueueBasedInboxes.DurableQueueBasedInbox
extends Object
implements Inbox

Field Summary

Fields
Modifier and Type Field Description

InboxConfig config

QueueName inboxQueueName

Constructor Summary

Constructors
Constructor	Description
`DurableQueueBasedInbox(InboxConfig config)`
`DurableQueueBasedInbox(InboxConfig config, Consumer<Message> messageConsumer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Inbox`	`addMessageReceived(Message message)`	Register or add a message that has been received 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
`Inbox`	`consume(Consumer<Message> messageConsumer)`	Start consuming messages from the Inbox using the provided message consumer. This is the same as calling `Inbox.setMessageConsumer(Consumer)` followed by `Inbox.startConsuming()` Only needs to be called if the instance was created without a message consumer such as via `Inboxes.getOrCreateInbox(InboxConfig)`
`long`	`getNumberOfUndeliveredMessages()`	Get the number of message received that haven't been processed yet (or successfully processed) by the message consumer
`boolean`	`hasAMessageConsumer()`	Has the instance been created with a Message consumer or has `Inbox.consume(Consumer)` been called
`boolean`	`isConsumingMessages()`	Is the provided Message consumer consuming messages from the `Inbox`
`InboxName`	`name()`	The name of the inbox
`Inbox`	`setMessageConsumer(Consumer<Message> messageConsumer)`	Set the message consumer.
`Inbox`	`startConsuming()`	Start consuming messages from the `Inbox`.
`Inbox`	`stopConsuming()`	Stop consuming messages from the `Inbox`.
`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.Inbox
addMessageReceived, addMessageReceived

- Field Detail
  - inboxQueueName
```
public final QueueName inboxQueueName
```
  - config
```
public final InboxConfig config
```
- Constructor Detail
  - DurableQueueBasedInbox
```
public DurableQueueBasedInbox(InboxConfig config,
                              Consumer<Message> messageConsumer)
```
  - DurableQueueBasedInbox
```
public DurableQueueBasedInbox(InboxConfig config)
```
- Method Detail
  - consume
```
public Inbox consume(Consumer<Message> messageConsumer)
```
    Description copied from interface: Inbox
    
    Start consuming messages from the Inbox using the provided message consumer.
    This is the same as calling Inbox.setMessageConsumer(Consumer) followed by Inbox.startConsuming()
    Only needs to be called if the instance was created without a message consumer such as via Inboxes.getOrCreateInbox(InboxConfig)
    If an OrderedMessage is delivered via an Inbox using a FencedLock (such as Inboxes.durableQueueBasedInboxes(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 Inbox
    
    Parameters:
    
    messageConsumer - the message consumer. See PatternMatchingMessageHandler
    
    Returns:
    
    this inbox instance
  - setMessageConsumer
```
public Inbox setMessageConsumer(Consumer<Message> messageConsumer)
```
    Description copied from interface: Inbox
    
    Set the message consumer. To start consuming call Inbox.startConsuming()
    
    Specified by:
    
    setMessageConsumer in interface Inbox
    
    Parameters:
    
    messageConsumer - the message consumer. See PatternMatchingMessageHandler
    
    Returns:
    
    this inbox instance
  - startConsuming
```
public Inbox startConsuming()
```
    Description copied from interface: Inbox
    
    Start consuming messages from the Inbox. Requires calling Inbox.setMessageConsumer(Consumer) first
    If an OrderedMessage is delivered via an Inbox using a FencedLock (such as Inboxes.durableQueueBasedInboxes(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 Inbox
    
    Returns:
    
    this inbox instance
  - hasAMessageConsumer
```
public boolean hasAMessageConsumer()
```
    Description copied from interface: Inbox
    
    Has the instance been created with a Message consumer or has Inbox.consume(Consumer) been called
    
    Specified by:
    
    hasAMessageConsumer in interface Inbox
    
    Returns:
    
    Has the instance been created with a Message consumer or has Inbox.consume(Consumer) been called
  - isConsumingMessages
```
public boolean isConsumingMessages()
```
    Description copied from interface: Inbox
    
    Is the provided Message consumer consuming messages from the Inbox
    
    Specified by:
    
    isConsumingMessages in interface Inbox
    
    Returns:
    
    Is the provided Message consumer consuming messages from the Inbox
  - stopConsuming
```
public Inbox stopConsuming()
```
    Description copied from interface: Inbox
    
    Stop consuming messages from the Inbox. Calling this method will remove the message consumer and to resume message consumption you need to call Inbox.consume(Consumer)
    
    Specified by:
    
    stopConsuming in interface Inbox
    
    Returns:
    
    this inbox instance
  - name
```
public InboxName name()
```
    Description copied from interface: Inbox
    
    The name of the inbox
    
    Specified by:
    
    name in interface Inbox
    
    Returns:
    
    the name of the inbox
  - addMessageReceived
```
public Inbox addMessageReceived(Message message)
```
    Description copied from interface: Inbox
    
    Register or add a message that has been received
    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:
    
    addMessageReceived in interface Inbox
    
    Parameters:
    
    message - the message
    
    Returns:
    
    this inbox instance
    
    See Also:
    
    OrderedMessage
  - getNumberOfUndeliveredMessages
```
public long getNumberOfUndeliveredMessages()
```
    Description copied from interface: Inbox
    
    Get the number of message received that haven't been processed yet (or successfully processed) by the message consumer
    
    Specified by:
    
    getNumberOfUndeliveredMessages in interface Inbox
    
    Returns:
    
    the number of message received that haven't been processed yet (or successfully processed) by the message consumer
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Fields
Modifier and Type	Field	Description
`InboxConfig`	`config`
`QueueName`	`inboxQueueName`

Class Inboxes.DurableQueueBasedInboxes.DurableQueueBasedInbox

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.Inbox

Field Detail

inboxQueueName

config

Constructor Detail

DurableQueueBasedInbox

DurableQueueBasedInbox

Method Detail

consume

setMessageConsumer

startConsuming

hasAMessageConsumer

isConsumingMessages

stopConsuming

name

addMessageReceived

getNumberOfUndeliveredMessages

toString