io.spine.server.delivery

Interface InboxStorage

All Superinterfaces:

java.lang.AutoCloseable, Storage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage,InboxReadRequest>

All Known Implementing Classes:

InMemoryInboxStorage

@SPI
public interface InboxStorage
extends Storage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage,InboxReadRequest>

A contract for storages of Inbox messages.

The records a storage of this type are spreads across shards identified by a shard index.

Typically, the storage instance is specific to the server environment and is used across BoundedContexts to store the delivered messages.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<io.spine.server.delivery.InboxMessage>	newestMessageToDeliver(io.spine.server.delivery.ShardIndex index) Finds the newest message to deliver in the given shard.
Page<io.spine.server.delivery.InboxMessage>	readAll(io.spine.server.delivery.ShardIndex index, int pageSize) Reads the contents of the storage by the given shard index and returns the first page of the results.
void	removeAll(java.lang.Iterable<io.spine.server.delivery.InboxMessage> messages) Removes the passed messages from the storage.
void	write(io.spine.server.delivery.InboxMessage message) Writes a message to the storage.
void	writeAll(java.lang.Iterable<io.spine.server.delivery.InboxMessage> messages) Writes several messages to the storage.

Methods inherited from interface io.spine.server.storage.Storage

close, index, isMultitenant, isOpen, read, write

Method Detail

readAll

Page<io.spine.server.delivery.InboxMessage> readAll(io.spine.server.delivery.ShardIndex index,
                                                    int pageSize)

Reads the contents of the storage by the given shard index and returns the first page of the results.

The older items go first.

Parameters:

index - the shard index to return the results for

pageSize - the maximum number of the elements per page

Returns:

the first page of the results

newestMessageToDeliver

java.util.Optional<io.spine.server.delivery.InboxMessage> newestMessageToDeliver(io.spine.server.delivery.ShardIndex index)

Finds the newest message to deliver in the given shard.

Parameters:

index - the shard index to look in

Returns:

the message found or Optional.empty() if there are no messages to deliver in the specified shard

write

void write(io.spine.server.delivery.InboxMessage message)

Writes a message to the storage.

Parameters:

message - a message to write

writeAll

void writeAll(java.lang.Iterable<io.spine.server.delivery.InboxMessage> messages)

Writes several messages to the storage.

Parameters:

messages - messages to write

removeAll

void removeAll(java.lang.Iterable<io.spine.server.delivery.InboxMessage> messages)

Removes the passed messages from the storage.

Does nothing for messages that aren't in the storage already.

Parameters:

messages - the messages to remove