F - the "self-type" of the StorageFoundation implementation.public interface StorageFoundation<F extends StorageFoundation<?>>
extends one.microstream.util.InstanceDispatcher
StorageSystem instance,
i.e. a functional database handling logic.
Additionally to the services of a mere factory type, a foundation type also keeps references to all parts
after a StorageSystem instance has been created. This is useful if some internal logic parts shall be
accessed while the StorageSystem logic is already running. Therefore, this type can best be thought of
as a foundation on which the running database handling logic stands.
All set~ methods are simple setter methods without any additional logic worth mentioning.
All set~ methods return this to allow for easy method chaining to improve readability.
All get~ methods return a logic part instance, if present or otherwise creates and sets one beforehand
via a default creation logic.
| Modifier and Type | Interface and Description |
|---|---|
static class |
StorageFoundation.Default<F extends StorageFoundation.Default<?>> |
StorageConfiguration getConfiguration()
StorageConfiguration instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageOperationController.Creator getOperationControllerCreator()
StorageOperationController.Creator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageInitialDataFileNumberProvider getInitialDataFileNumberProvider()
StorageInitialDataFileNumberProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageRequestAcceptor.Creator getRequestAcceptorCreator()
StorageRequestAcceptor.Creator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageTaskBroker.Creator getTaskBrokerCreator()
StorageTaskBroker.Creator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageDataChunkValidator.Provider getDataChunkValidatorProvider()
StorageDataChunkValidator.Provider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageDataChunkValidator.Provider2 getDataChunkValidatorProvider2()
StorageDataChunkValidator.Provider2 instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageChannelsCreator getChannelCreator()
StorageChannelsCreator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageThreadNameProvider getThreadNameProvider()
StorageThreadNameProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageChannelThreadProvider getChannelThreadProvider()
StorageChannelThreadProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageBackupThreadProvider getBackupThreadProvider()
StorageBackupThreadProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageLockFileManagerThreadProvider getLockFileManagerThreadProvider()
StorageLockFileManagerThreadProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageThreadProvider getThreadProvider()
StorageThreadProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageRequestTaskCreator getRequestTaskCreator()
StorageRequestTaskCreator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageTypeDictionary getTypeDictionary()
StorageTypeDictionary instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageRootTypeIdProvider getRootTypeIdProvider()
StorageRootTypeIdProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageTimestampProvider getTimestampProvider()
StorageTimestampProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageObjectIdRangeEvaluator getObjectIdRangeEvaluator()
StorageObjectIdRangeEvaluator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageFileWriter.Provider getWriterProvider()
StorageFileWriter.Provider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageGCZombieOidHandler getGCZombieOidHandler()
StorageGCZombieOidHandler instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageRootOidSelector.Provider getRootOidSelectorProvider()
StorageRootOidSelector.Provider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageObjectIdMarkQueue.Creator getOidMarkQueueCreator()
StorageObjectIdMarkQueue.Creator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageEntityMarkMonitor.Creator getEntityMarkMonitorCreator()
StorageEntityMarkMonitor.Creator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageDataFileValidator.Creator getDataFileValidatorCreator()
StorageDataFileValidator.Creator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.BinaryEntityRawDataIterator.Provider getEntityDataIteratorProvider()
BinaryEntityRawDataIterator.Provider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageEntityDataValidator.Creator getEntityDataValidatorCreator()
StorageEntityDataValidator.Creator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.one.microstream.util.ProcessIdentityProvider getProcessIdentityProvider()
ProcessIdentityProvider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageLockFileSetup getLockFileSetup()
StorageLockFileSetup instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageLockFileSetup.Provider getLockFileSetupProvider()
StorageLockFileSetup.Provider instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageLockFileManager.Creator getLockFileManagerCreator()
StorageLockFileManager.Creator instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageExceptionHandler getExceptionHandler()
StorageExceptionHandler instance.
If no instance is set and the implementation deems an instance of this type mandatory for the successful
executon of createStorageSystem(), a suitable instance is created via an internal default
creation logic and then set as the current. If the implementation has not sufficient logic and/or data
to create a default instance, a MissingFoundationPartException is thrown.
one.microstream.exceptions.MissingFoundationPartException - if a returnable instance is required but cannot be created by default.StorageEventLogger getEventLogger()
StorageWriteController writeController()
StorageWriteController getWriteController()
StorageHousekeepingBroker housekeepingBroker()
StorageHousekeepingBroker getHousekeepingBroker()
F setConfiguration(StorageConfiguration configuration)
StorageConfiguration instance to be used for the assembly.configuration - the instance to be used.F setOperationControllerCreator(StorageOperationController.Creator operationControllerCreator)
StorageOperationController.Creator instance to be used for the assembly.operationControllerCreator - the instance to be used.F setInitialDataFileNumberProvider(StorageInitialDataFileNumberProvider initDataFileNumberProvider)
StorageInitialDataFileNumberProvider instance to be used for the assembly.initDataFileNumberProvider - the instance to be used.F setRequestAcceptorCreator(StorageRequestAcceptor.Creator requestAcceptorCreator)
StorageRequestAcceptor.Creator instance to be used for the assembly.requestAcceptorCreator - the instance to be used.F setTaskBrokerCreator(StorageTaskBroker.Creator taskBrokerCreator)
StorageTaskBroker.Creator instance to be used for the assembly.taskBrokerCreator - the instance to be used.F setDataChunkValidatorProvider(StorageDataChunkValidator.Provider dataChunkValidatorProvider)
StorageDataChunkValidator.Provider instance to be used for the assembly.dataChunkValidatorProvider - the instance to be used.F setDataChunkValidatorProvider2(StorageDataChunkValidator.Provider2 dataChunkValidatorProvider2)
StorageDataChunkValidator.Provider2 instance to be used for the assembly.dataChunkValidatorProvider2 - the instance to be used.F setChannelCreator(StorageChannelsCreator channelCreator)
StorageChannelsCreator instance to be used for the assembly.channelCreator - the instance to be used.F setThreadNameProvider(StorageThreadNameProvider threadNameProvider)
StorageThreadNameProvider instance to be used for the assembly.threadNameProvider - the instance to be used.F setChannelThreadProvider(StorageChannelThreadProvider channelThreadProvider)
StorageChannelThreadProvider instance to be used for the assembly.channelThreadProvider - the instance to be used.F setBackupThreadProvider(StorageBackupThreadProvider backupThreadProvider)
StorageBackupThreadProvider instance to be used for the assembly.backupThreadProvider - the instance to be used.F setLockFileManagerThreadProvider(StorageLockFileManagerThreadProvider lockFileManagerThreadProvider)
StorageLockFileManagerThreadProvider instance to be used for the assembly.lockFileManagerThreadProvider - the instance to be used.F setThreadProvider(StorageThreadProvider threadProvider)
StorageThreadProvider instance to be used for the assembly.threadProvider - the instance to be used.F setTaskCreator(StorageRequestTaskCreator taskCreator)
StorageRequestTaskCreator instance to be used for the assembly.taskCreator - the instance to be used.F setTypeDictionary(StorageTypeDictionary typeDictionary)
StorageTypeDictionary instance to be used for the assembly.typeDictionary - the instance to be used.F setRootTypeIdProvider(StorageRootTypeIdProvider rootTypeIdProvider)
StorageRootTypeIdProvider instance to be used for the assembly.rootTypeIdProvider - the instance to be used.F setTimestampProvider(StorageTimestampProvider timestampProvider)
StorageTimestampProvider instance to be used for the assembly.timestampProvider - the instance to be used.F setObjectIdRangeEvaluator(StorageObjectIdRangeEvaluator objectIdRangeEvaluator)
StorageObjectIdRangeEvaluator instance to be used for the assembly.objectIdRangeEvaluator - the instance to be used.F setWriterProvider(StorageFileWriter.Provider writerProvider)
StorageFileWriter.Provider instance to be used for the assembly.writerProvider - the instance to be used.F setGCZombieOidHandler(StorageGCZombieOidHandler gCZombieOidHandler)
StorageGCZombieOidHandler instance to be used for the assembly.gCZombieOidHandler - the instance to be used.F setRootOidSelectorProvider(StorageRootOidSelector.Provider rootOidSelectorProvider)
StorageRootOidSelector.Provider instance to be used for the assembly.rootOidSelectorProvider - the instance to be used.F setOidMarkQueueCreator(StorageObjectIdMarkQueue.Creator oidMarkQueueCreator)
StorageObjectIdMarkQueue.Creator instance to be used for the assembly.oidMarkQueueCreator - the instance to be used.F setEntityMarkMonitorCreator(StorageEntityMarkMonitor.Creator entityMarkMonitorCreator)
StorageEntityMarkMonitor.Creator instance to be used for the assembly.entityMarkMonitorCreator - the instance to be used.F setDataFileValidatorCreator(StorageDataFileValidator.Creator dataFileValidatorCreator)
StorageDataFileValidator.Creator instance to be used for the assembly.dataFileValidatorCreator - the instance to be used.F setEntityDataIteratorProvider(BinaryEntityRawDataIterator.Provider entityRawDataIteratorProvider)
BinaryEntityRawDataIterator.Provider instance to be used for the assembly.entityRawDataIteratorProvider - the instance to be used.F setEntityDataValidatorCreator(StorageEntityDataValidator.Creator entityDataValidatorCreator)
StorageEntityDataValidator.Creator instance to be used for the assembly.entityDataValidatorCreator - the instance to be used.F setProcessIdentityProvider(one.microstream.util.ProcessIdentityProvider processIdentityProvider)
ProcessIdentityProvider instance to be used for the assembly.processIdentityProvider - the instance to be used.F setLockFileSetup(StorageLockFileSetup lockFileSetup)
StorageLockFileSetup instance to be used for the assembly.lockFileSetup - the instance to be used.F setLockFileSetupProvider(StorageLockFileSetup.Provider lockFileSetupProvider)
StorageLockFileSetup.Provider instance to be used for the assembly.lockFileSetupProvider - the instance to be used.F setLockFileManagerCreator(StorageLockFileManager.Creator lockFileManagerCreator)
StorageLockFileManager.Creator instance to be used for the assembly.lockFileManagerCreator - the instance to be used.F setExceptionHandler(StorageExceptionHandler exceptionHandler)
StorageExceptionHandler instance to be used for the assembly.exceptionHandler - the instance to be used.F setEventLogger(StorageEventLogger eventLogger)
F setWriteController(StorageWriteController writeController)
F setHousekeepingBroker(StorageHousekeepingBroker housekeepingBroker)
StorageSystem createStorageSystem()
StorageSystem instance by using the current state of all registered
logic part instances and by on-demand creating missing ones via a default logic.
The returned StorageSystem instance will NOT yet be started.
StorageSystem instance.Copyright © 2022 MicroStream Software. All rights reserved.