one.microstream.storage.types

Class StorageSystem.Default

java.lang.Object

one.microstream.storage.types.StorageSystem.Default

All Implemented Interfaces:

AutoCloseable, one.microstream.persistence.types.Unpersistable, StorageActivePart, StorageController, StorageKillable, StorageSystem

Enclosing interface:

StorageSystem

public static final class StorageSystem.Default
extends Object
implements StorageSystem, one.microstream.persistence.types.Unpersistable, StorageKillable

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.storage.types.StorageSystem

StorageSystem.Default

Constructor Summary

Constructors

Constructor and Description

Default(StorageConfiguration storageConfiguration, StorageOperationController.Creator ocCreator, StorageDataFileValidator.Creator backupDataFileValidatorCreator, StorageWriteController writeController, StorageHousekeepingBroker housekeepingBroker, StorageFileWriter.Provider writerProvider, StorageInitialDataFileNumberProvider initialDataFileNumberProvider, StorageRequestAcceptor.Creator requestAcceptorCreator, StorageTaskBroker.Creator taskBrokerCreator, StorageDataChunkValidator.Provider dataChunkValidatorProvider, StorageChannelsCreator channelCreator, StorageThreadProvider threadProvider, StorageRequestTaskCreator requestTaskCreator, StorageTypeDictionary typeDictionary, StorageRootTypeIdProvider rootTypeIdProvider, StorageTimestampProvider timestampProvider, StorageObjectIdRangeEvaluator objectIdRangeEvaluator, StorageGCZombieOidHandler zombieOidHandler, StorageRootOidSelector.Provider rootOidSelectorProvider, StorageObjectIdMarkQueue.Creator oidMarkQueueCreator, StorageEntityMarkMonitor.Creator entityMarkMonitorCreator, boolean switchByteOrder, StorageLockFileSetup lockFileSetup, StorageLockFileManager.Creator lockFileManagerCreator, StorageExceptionHandler exceptionHandler, StorageEventLogger eventLogger)

Method Summary

Modifier and Type	Method and Description
void	checkAcceptingTasks()
StorageConfiguration	configuration()
StorageRequestAcceptor	createRequestAcceptor()
StorageIdAnalysis	initializationIdAnalysis()
long	initializationTime()
boolean	isAcceptingTasks()
boolean	isActive() Queries whether the part is actually active right now.
boolean	isRunning()
boolean	isShuttingDown()
boolean	isStartingUp()
void	killStorage(Throwable cause) Stops all threads, releases all resources (e.g.
StorageObjectIdRangeEvaluator	objectIdRangeEvaluator()
StorageOperationController	operationController()
long	operationModeTime()
boolean	shutdown() Issues a command to shut down all active threads managing the storage.
StorageSystem.Default	start() "Starts" the storage controlled by this StorageController instance, with "starting" meaning: Reading, indexing and potentially caching all the persisted data in the storage. Starting storage managing threads to execute requests like storing, loading and issued utility functions.
StorageTypeDictionary	typeDictionary()

Methods inherited from class java.lang.Object

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

Methods inherited from interface one.microstream.storage.types.StorageSystem

channelCountProvider, fileSystem

Methods inherited from interface one.microstream.storage.types.StorageController

close, initializationDuration, isShutdown

Constructor Detail

Default

public Default(StorageConfiguration storageConfiguration,
               StorageOperationController.Creator ocCreator,
               StorageDataFileValidator.Creator backupDataFileValidatorCreator,
               StorageWriteController writeController,
               StorageHousekeepingBroker housekeepingBroker,
               StorageFileWriter.Provider writerProvider,
               StorageInitialDataFileNumberProvider initialDataFileNumberProvider,
               StorageRequestAcceptor.Creator requestAcceptorCreator,
               StorageTaskBroker.Creator taskBrokerCreator,
               StorageDataChunkValidator.Provider dataChunkValidatorProvider,
               StorageChannelsCreator channelCreator,
               StorageThreadProvider threadProvider,
               StorageRequestTaskCreator requestTaskCreator,
               StorageTypeDictionary typeDictionary,
               StorageRootTypeIdProvider rootTypeIdProvider,
               StorageTimestampProvider timestampProvider,
               StorageObjectIdRangeEvaluator objectIdRangeEvaluator,
               StorageGCZombieOidHandler zombieOidHandler,
               StorageRootOidSelector.Provider rootOidSelectorProvider,
               StorageObjectIdMarkQueue.Creator oidMarkQueueCreator,
               StorageEntityMarkMonitor.Creator entityMarkMonitorCreator,
               boolean switchByteOrder,
               StorageLockFileSetup lockFileSetup,
               StorageLockFileManager.Creator lockFileManagerCreator,
               StorageExceptionHandler exceptionHandler,
               StorageEventLogger eventLogger)

Method Detail

configuration

public final StorageConfiguration configuration()

Specified by:

configuration in interface StorageSystem

isRunning

public final boolean isRunning()

Specified by:

isRunning in interface StorageController

isActive

public final boolean isActive()

Description copied from interface: StorageActivePart

Queries whether the part is actually active right now. This might return true even despite some "running" flag being set to false because there might be one last loop cycle execution before checking the "running" flag again.

Specified by:

isActive in interface StorageActivePart

Returns:

if the part is actually active right now.

isAcceptingTasks

public final boolean isAcceptingTasks()

Specified by:

isAcceptingTasks in interface StorageController

isStartingUp

public final boolean isStartingUp()

Specified by:

isStartingUp in interface StorageController

isShuttingDown

public final boolean isShuttingDown()

Specified by:

isShuttingDown in interface StorageController

initializationTime

public final long initializationTime()

Specified by:

initializationTime in interface StorageController

operationModeTime

public final long operationModeTime()

Specified by:

operationModeTime in interface StorageController

checkAcceptingTasks

public final void checkAcceptingTasks()

Specified by:

checkAcceptingTasks in interface StorageController

start

public final StorageSystem.Default start()

Description copied from interface: StorageController

"Starts" the storage controlled by this StorageController instance, with "starting" meaning:

• Reading, indexing and potentially caching all the persisted data in the storage.
• Starting storage managing threads to execute requests like storing, loading and issued utility functions.

Specified by:

start in interface StorageController

Specified by:

start in interface StorageSystem

Returns:

this to allow writing of fluent code.

initializationIdAnalysis

public final StorageIdAnalysis initializationIdAnalysis()

Specified by:

initializationIdAnalysis in interface StorageSystem

shutdown

public final boolean shutdown()

Description copied from interface: StorageController

Issues a command to shut down all active threads managing the storage.

Specified by:

shutdown in interface StorageController

Specified by:

shutdown in interface StorageSystem

Returns:

true after a successful shutdown or false if an internal InterruptedException happened.

typeDictionary

public final StorageTypeDictionary typeDictionary()

Specified by:

typeDictionary in interface StorageSystem

operationController

public StorageOperationController operationController()

Specified by:

operationController in interface StorageSystem

objectIdRangeEvaluator

public StorageObjectIdRangeEvaluator objectIdRangeEvaluator()

Specified by:

objectIdRangeEvaluator in interface StorageSystem

createRequestAcceptor

public final StorageRequestAcceptor createRequestAcceptor()

Specified by:

createRequestAcceptor in interface StorageSystem

killStorage

public void killStorage(Throwable cause)

Description copied from interface: StorageKillable

Stops all threads, releases all resources (e.g. close files) without considering any internal state or waiting for any action to be completed.

Useful only in simple error cases, for example

Specified by:

killStorage in interface StorageKillable

Parameters:

cause - the reason for the kill