io.spine.server.tenant

Class TenantRepository<T extends io.spine.base.EntityState,E extends TenantRepository.Entity<T>>

java.lang.Object

io.spine.server.entity.Repository<I,E>

io.spine.server.entity.RecordBasedRepository<I,E,S>

io.spine.server.entity.DefaultRecordBasedRepository<io.spine.core.TenantId,E,T>

io.spine.server.tenant.TenantRepository<T,E>

Type Parameters:

T - the type of data associated with the tenant ID

All Implemented Interfaces:

io.spine.logging.Logging, Closeable, TenantIndex, java.lang.AutoCloseable

public abstract class TenantRepository<T extends io.spine.base.EntityState,E extends TenantRepository.Entity<T>>
extends DefaultRecordBasedRepository<io.spine.core.TenantId,E,T>
implements TenantIndex

Abstract base for repositories storing information about tenants.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TenantRepository.Entity<T extends io.spine.base.EntityState> Stores data associated with a tenant ID.

Constructor Summary

Constructors

Constructor and Description
TenantRepository()

Method Summary

Modifier and Type	Method and Description
java.util.Set<io.spine.core.TenantId>	all() Obtains the set of all stored tenant IDs.
protected void	clearCache() Clears the cache of known tenant IDs.
protected RecordStorage<io.spine.core.TenantId>	createStorage() Creates the storage for this repository.
protected boolean	isTypeSupplier() Tells if this repository should be registered as a type supplier with a Stand of the BoundedContext to which this repository belongs.
void	keep(io.spine.core.TenantId id) Stores the passed tenant ID in the index.
void	registerWith(BoundedContext context) Initializes the repository by performing the validation of the entity class and creating the storage converter.
protected boolean	unCache(io.spine.core.TenantId id) Removes the passed value from the in-memory cache of known tenant IDs.

Methods inherited from class io.spine.server.entity.DefaultRecordBasedRepository

entityFactory, storageConverter

Methods inherited from class io.spine.server.entity.RecordBasedRepository

applyMigration, applyMigration, create, find, find, findActive, findOrCreate, iterator, loadAll, loadAll, recordStorage, store, store, toEntity

Methods inherited from class io.spine.server.entity.Repository

checkStorage, close, context, entityClass, entityStateType, eventFilter, hasContext, idClass, index, isOpen, isRegistered, onRegistered, open, storage, storageAssigned

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.tenant.TenantIndex

close, createDefault, singleTenant

Methods inherited from interface io.spine.server.Closeable

checkOpen

Methods inherited from interface io.spine.logging.Logging

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

Constructor Detail

TenantRepository

public TenantRepository()

Method Detail

createStorage

protected final RecordStorage<io.spine.core.TenantId> createStorage()

Description copied from class: Repository

Creates the storage for this repository.

Default implementations use Repository.defaultStorageFactory() invoking its method which creates a storage compatible with the repository.

Overwrite this method for creating a custom implementation of Storage.

Overrides:

createStorage in class RecordBasedRepository<io.spine.core.TenantId,E extends TenantRepository.Entity<T>,T extends io.spine.base.EntityState>

Returns:

the created storage instance

registerWith

public final void registerWith(BoundedContext context)

Description copied from class: DefaultRecordBasedRepository

Initializes the repository by performing the validation of the entity class and creating the storage converter.

Overrides:

registerWith in class DefaultRecordBasedRepository<io.spine.core.TenantId,E extends TenantRepository.Entity<T>,T extends io.spine.base.EntityState>

Parameters:

context - the Bounded Context of this repository

isTypeSupplier

protected final boolean isTypeSupplier()

Description copied from class: Repository

Tells if this repository should be registered as a type supplier with a Stand of the BoundedContext to which this repository belongs.

Normally repositories are type suppliers. Some types of internal repositories are not type suppliers because data of their entities should not be exposed. Those classes of repositories should overwrite this method returning false.

Overrides:

isTypeSupplier in class Repository<io.spine.core.TenantId,E extends TenantRepository.Entity<T>>

Returns:

true by default

keep

public final void keep(io.spine.core.TenantId id)

Stores the passed tenant ID in the index.

If there is an entity with the passed ID, the method quits. Otherwise, a new entity with the default state will be created and stored.

Specified by:

keep in interface TenantIndex

Parameters:

id - the tenant ID to store

unCache

protected final boolean unCache(io.spine.core.TenantId id)

Removes the passed value from the in-memory cache of known tenant IDs.

Implementations should call this method for removing the cached value for a tenant for which the record was removed from the repository.

Parameters:

id - the ID to remove from the cache

Returns:

true if the value was cached before and removed, false otherwise

clearCache

protected final void clearCache()

Clears the cache of known tenant IDs.

all

public final java.util.Set<io.spine.core.TenantId> all()

Description copied from interface: TenantIndex

Obtains the set of all stored tenant IDs.

Specified by:

all in interface TenantIndex