io.spine.server.delivery

Class InboxStorage

java.lang.Object

io.spine.server.storage.AbstractStorage<I,R>

io.spine.server.storage.RecordStorage<I,R>

io.spine.server.storage.RecordStorageDelegate<I,M>

io.spine.server.storage.MessageStorage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage>

io.spine.server.delivery.InboxStorage

All Implemented Interfaces:

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

@SPI
public class InboxStorage
extends MessageStorage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage>

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.

Constructor Summary

Constructors

Constructor and Description
InboxStorage(StorageFactory factory, boolean multitenant)

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.
com.google.common.collect.ImmutableList<io.spine.server.delivery.InboxMessage>	readAll(io.spine.server.delivery.ShardIndex index, @Nullable com.google.protobuf.Timestamp sinceWhen, int pageSize)
protected void	write(io.spine.server.delivery.InboxMessage message) Writes the message to the storage.
protected void	writeBatch(java.lang.Iterable<io.spine.server.delivery.InboxMessage> messages) Writes the batch of messages to the storage.

Methods inherited from class io.spine.server.storage.MessageStorage

write

Methods inherited from class io.spine.server.storage.RecordStorageDelegate

close, delete, deleteAll, deleteRecord, index, index, isMultitenant, isOpen, queryForAll, read, read, readAll, readAll, readAll, readAll, readAllRecords, toQuery, toQuery, toQuery, toQuery, write, writeAll, writeRecord

Methods inherited from class io.spine.server.storage.RecordStorage

queryBuilder

Methods inherited from class io.spine.server.storage.AbstractStorage

checkNotClosed, checkNotClosed, isClosed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InboxStorage

public InboxStorage(StorageFactory factory,
                    boolean multitenant)

Method Detail

write

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

Writes the message to the storage.

The identifier and the columns for the written record are extracted via the record specification.

Overrides to expose this method to this package.

Overrides:

write in class MessageStorage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage>

Parameters:

message - the message to write

writeBatch

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

Writes the batch of messages to the storage.

The identifier and the columns for the written records are extracted via the record specification.

Overrides to expose this method to this package.

Overrides:

writeBatch in class MessageStorage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage>

Parameters:

messages - the batch of the messages to write

readAll

public 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

readAll

public com.google.common.collect.ImmutableList<io.spine.server.delivery.InboxMessage> readAll(io.spine.server.delivery.ShardIndex index,
                                                                                              @Nullable com.google.protobuf.Timestamp sinceWhen,
                                                                                              int pageSize)

newestMessageToDeliver

public 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