io.spine.server.storage.memory

Class InMemoryInboxStorage

java.lang.Object

io.spine.server.storage.AbstractStorage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage,InboxReadRequest>

io.spine.server.storage.memory.InMemoryInboxStorage

All Implemented Interfaces:

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

public final class InMemoryInboxStorage
extends AbstractStorage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage,InboxReadRequest>
implements InboxStorage, io.spine.logging.Logging

In-memory implementation of messages stored in Inbox.

Mutating operations are made synchronized to avoid simultaneous updates of the same records. That allows to operate in a concurrency-heavy environment notwithstanding the thread-safety of the underlying storage.

Constructor Summary

Constructors

Constructor and Description
InMemoryInboxStorage(boolean multitenant)

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<io.spine.server.delivery.InboxMessageId>	index() Returns an iterator over identifiers of records in the storage.
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.
java.util.Optional<io.spine.server.delivery.InboxMessage>	read(InboxReadRequest request) Reads a record from the storage by the specified request.
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	write(io.spine.server.delivery.InboxMessageId id, io.spine.server.delivery.InboxMessage record) Writes a record into the storage.
void	writeAll(java.lang.Iterable<io.spine.server.delivery.InboxMessage> messages) Writes several messages to the storage.

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

checkNotClosed, checkNotClosed, close, isClosed, isMultitenant, isOpen

Methods inherited from class java.lang.Object

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

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

close, isMultitenant, isOpen

Methods inherited from interface io.spine.logging.Logging

_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

Constructor Detail

InMemoryInboxStorage

public InMemoryInboxStorage(boolean multitenant)

Method Detail

readAll

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

Description copied from interface: InboxStorage

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

The older items go first.

Specified by:

readAll in interface InboxStorage

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

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

Description copied from interface: InboxStorage

Finds the newest message to deliver in the given shard.

Specified by:

newestMessageToDeliver in interface InboxStorage

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

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

Description copied from interface: InboxStorage

Writes a message to the storage.

Specified by:

write in interface InboxStorage

Parameters:

message - a message to write

writeAll

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

Description copied from interface: InboxStorage

Writes several messages to the storage.

Specified by:

writeAll in interface InboxStorage

Parameters:

messages - messages to write

index

public java.util.Iterator<io.spine.server.delivery.InboxMessageId> index()

Description copied from interface: Storage

Returns an iterator over identifiers of records in the storage.

Specified by:

index in interface Storage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage,InboxReadRequest>

read

public java.util.Optional<io.spine.server.delivery.InboxMessage> read(InboxReadRequest request)

Description copied from interface: Storage

Reads a record from the storage by the specified request.

Specified by:

read in interface Storage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage,InboxReadRequest>

Parameters:

request - the request to read the record

Returns:

a record instance or Optional.empty() if there is no record matching this request

write

public void write(io.spine.server.delivery.InboxMessageId id,
                  io.spine.server.delivery.InboxMessage record)

Description copied from interface: Storage

Writes a record into the storage.

Rewrites it if a record with this ID already exists in the storage.

Specified by:

write in interface Storage<io.spine.server.delivery.InboxMessageId,io.spine.server.delivery.InboxMessage,InboxReadRequest>

Parameters:

id - the ID for the record

record - the record to store

removeAll

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

Description copied from interface: InboxStorage

Removes the passed messages from the storage.

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

Specified by:

removeAll in interface InboxStorage

Parameters:

messages - the messages to remove