io.spine.server.storage

Class AbstractStorage<I,M extends com.google.protobuf.Message,R extends ReadRequest<I>>

java.lang.Object

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

Type Parameters:

I - the type of IDs of storage records

M - the type of records kept in the storage

R - the type of read requests for the storage

All Implemented Interfaces:

Storage<I,M,R>, java.lang.AutoCloseable

Direct Known Subclasses:

AggregateStorage, InMemoryCatchUpStorage, InMemoryInboxStorage, RecordStorage

public abstract class AbstractStorage<I,M extends com.google.protobuf.Message,R extends ReadRequest<I>>
extends java.lang.Object
implements Storage<I,M,R>

Abstract base for storages.

A storage can read and write messages of the given type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStorage(boolean multitenant)

Method Summary

Modifier and Type	Method and Description
protected void	checkNotClosed() Ensures the storage is not closed.
protected void	checkNotClosed(java.lang.String message) Ensures the storage is not closed.
void	close() Closes the storage.
boolean	isClosed() Tests whether the storage is closed.
boolean	isMultitenant() Verifies whether the storage is multitenant.
boolean	isOpen() Tests whether the storage is open.

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

index, read, write

Constructor Detail

AbstractStorage

protected AbstractStorage(boolean multitenant)

Method Detail

isMultitenant

public boolean isMultitenant()

Description copied from interface: Storage

Verifies whether the storage is multitenant.

Specified by:

isMultitenant in interface Storage<I,M extends com.google.protobuf.Message,R extends ReadRequest<I>>

Returns:

true if the storage was created with multitenancy support, false otherwise

checkNotClosed

protected void checkNotClosed(java.lang.String message)
                       throws java.lang.IllegalStateException

Ensures the storage is not closed.

If the storage is closed, throws IllegalStateException with the passed message.

Parameters:

message - exception message

Throws:

java.lang.IllegalStateException - if the storage is closed

checkNotClosed

protected void checkNotClosed()
                       throws java.lang.IllegalStateException

Ensures the storage is not closed.

If the storage is closed, throws IllegalStateException.

Throws:

java.lang.IllegalStateException - if the storage is closed

isOpen

public boolean isOpen()

Tests whether the storage is open.

Specified by:

isOpen in interface Storage<I,M extends com.google.protobuf.Message,R extends ReadRequest<I>>

Returns:

true if the storage is open for writing (wasn't closed until now), false otherwise

See Also:

AbstractStorage.close()

isClosed

public boolean isClosed()

Tests whether the storage is closed.

Returns:

true if the storage is closed, false otherwise

See Also:

AbstractStorage.close()

close

public void close()

Closes the storage.

Specified by:

close in interface Storage<I,M extends com.google.protobuf.Message,R extends ReadRequest<I>>

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.IllegalStateException - if the storage was already closed