Class EmbeddedStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>
- All Implemented Interfaces:
Unpersistable,EmbeddedStorageFoundation<F>,StorageFoundation<F>,InstanceDispatcher
- Enclosing interface:
- EmbeddedStorageFoundation<F extends EmbeddedStorageFoundation<?>>
public static class EmbeddedStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>> extends StorageFoundation.Default<F> implements EmbeddedStorageFoundation<F>
-
Nested Class Summary
Nested classes/interfaces inherited from interface one.microstream.storage.types.EmbeddedStorageFoundation
EmbeddedStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>Nested classes/interfaces inherited from interface one.microstream.util.InstanceDispatcher
InstanceDispatcher.DefaultNested classes/interfaces inherited from interface one.microstream.storage.types.StorageFoundation
StorageFoundation.Default<F extends StorageFoundation.Default<?>> -
Constructor Summary
Constructors Constructor Description Default() -
Method Summary
Methods inherited from class one.microstream.storage.types.StorageFoundation.Default
createStorageSystem, getBackupThreadProvider, getChannelCreator, getChannelThreadProvider, getConfiguration, getDataChunkValidatorProvider, getDataChunkValidatorProvider2, getDataFileValidatorCreator, getEntityDataIteratorProvider, getEntityDataValidatorCreator, getEntityMarkMonitorCreator, getEventLogger, getExceptionHandler, getGCZombieOidHandler, getHousekeepingBroker, getInitialDataFileNumberProvider, getLockFileManagerCreator, getLockFileManagerThreadProvider, getLockFileSetup, getLockFileSetupProvider, getObjectIdRangeEvaluator, getOidMarkQueueCreator, getOperationControllerCreator, getProcessIdentityProvider, getRequestAcceptorCreator, getRequestTaskCreator, getRootOidSelectorProvider, getRootTypeIdProvider, getTaskBrokerCreator, getThreadNameProvider, getThreadProvider, getTimestampProvider, getTypeDictionary, getWriteController, getWriterProvider, housekeepingBroker, isByteOrderMismatch, setBackupThreadProvider, setChannelThreadProvider, setDataChunkValidatorProvider2, setDataFileValidatorCreator, setEntityDataIteratorProvider, setEntityDataValidatorCreator, setEntityMarkMonitorCreator, setEventLogger, setExceptionHandler, setGCZombieOidHandler, setHousekeepingBroker, setInitialDataFileNumberProvider, setLockFileManagerCreator, setLockFileManagerThreadProvider, setLockFileSetup, setLockFileSetupProvider, setObjectIdRangeEvaluator, setOidMarkQueueCreator, setOperationControllerCreator, setProcessIdentityProvider, setRootOidSelectorProvider, setThreadNameProvider, setThreadProvider, setWriterProvider, writeControllerMethods inherited from class one.microstream.util.InstanceDispatcher.Default
getInstanceDispatcherLogic, setInstanceDispatcherLogicMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface one.microstream.storage.types.EmbeddedStorageFoundation
createEmbeddedStorageManager, start, startMethods inherited from interface one.microstream.storage.types.StorageFoundation
createStorageSystem, getBackupThreadProvider, getChannelCreator, getChannelThreadProvider, getConfiguration, getDataChunkValidatorProvider, getDataChunkValidatorProvider2, getDataFileValidatorCreator, getEntityDataIteratorProvider, getEntityDataValidatorCreator, getEntityMarkMonitorCreator, getEventLogger, getExceptionHandler, getGCZombieOidHandler, getHousekeepingBroker, getInitialDataFileNumberProvider, getLockFileManagerCreator, getLockFileManagerThreadProvider, getLockFileSetup, getLockFileSetupProvider, getObjectIdRangeEvaluator, getOidMarkQueueCreator, getOperationControllerCreator, getProcessIdentityProvider, getRequestAcceptorCreator, getRequestTaskCreator, getRootOidSelectorProvider, getRootTypeIdProvider, getTaskBrokerCreator, getThreadNameProvider, getThreadProvider, getTimestampProvider, getTypeDictionary, getWriteController, getWriterProvider, housekeepingBroker, setBackupThreadProvider, setChannelThreadProvider, setDataChunkValidatorProvider2, setDataFileValidatorCreator, setEntityDataIteratorProvider, setEntityDataValidatorCreator, setEntityMarkMonitorCreator, setEventLogger, setExceptionHandler, setGCZombieOidHandler, setHousekeepingBroker, setInitialDataFileNumberProvider, setLockFileManagerCreator, setLockFileManagerThreadProvider, setLockFileSetup, setLockFileSetupProvider, setObjectIdRangeEvaluator, setOidMarkQueueCreator, setOperationControllerCreator, setProcessIdentityProvider, setRootOidSelectorProvider, setThreadNameProvider, setThreadProvider, setWriterProvider, writeController
-
Constructor Details
-
Default
public Default()
-
-
Method Details
-
onConnectionFoundation
Description copied from interface:EmbeddedStorageFoundationExecutes the passed logic on theEmbeddedStorageConnectionFoundationinstance provided byEmbeddedStorageFoundation.getConnectionFoundation().This is a mere utility method to allow more concise syntax and multi-layered method chaining.
- Specified by:
onConnectionFoundationin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
logic- the logic to be executed.- Returns:
- this to allow method chaining.
-
onThis
Description copied from interface:EmbeddedStorageFoundationExecutes the passed logic on this.This is a mere utility method to allow more concise syntax and multi-layered method chaining.
- Specified by:
onThisin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
logic- the logic to be executed.- Returns:
- this to allow method chaining.
-
setRoot
Description copied from interface:EmbeddedStorageFoundationRegisters the passed root instance as the root instance at theEmbeddedStorageConnectionFoundationinstance provided byEmbeddedStorageFoundation.getConnectionFoundation().
UseEmbeddedStorageFoundation.setRootSupplier(Supplier)for a more dynamic approach, i.e. if the actual root instance must be created after setting up and creating theEmbeddedStorageManager.- Specified by:
setRootin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
root- the instance to be used as the persistent entity graph's root instance.- Returns:
- this to allow method chaining.
- See Also:
EmbeddedStorageFoundation.setRootSupplier(Supplier),EmbeddedStorageFoundation.setRootResolverProvider(PersistenceRootResolverProvider),PersistenceFoundation.setRootResolverProvider(PersistenceRootResolverProvider)
-
setRootSupplier
Description copied from interface:EmbeddedStorageFoundationRegisters the passed rootSupplierSupplieras the root instance supplier at thePersistenceRootResolverProviderinstance provided byPersistenceFoundation.getRootResolverProvider()of theEmbeddedStorageConnectionFoundationinstance provided byEmbeddedStorageFoundation.getConnectionFoundation().This means this method is merely an alias for
.onConnectionFoundation(f -> f.getRootResolverProvider().registerCustomRootSupplier(rootSupplier);) }Note that replacing the
PersistenceRootResolverProviderinstance, for example via #setRootResolverProvider, will nullify the changes made via this method.The actual root instance will be queried during startup, not before.
This technique allows a more dynamic approach thanEmbeddedStorageFoundation.setRoot(Object), i.e. if the actual root instance must be created after setting up and creating theEmbeddedStorageManager.- Specified by:
setRootSupplierin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
rootSupplier- the supplying logic to obtain the instance to be used during startup as the persistent entity graph's root instance.- Returns:
- this to allow method chaining.
- See Also:
EmbeddedStorageManager.start(),EmbeddedStorageFoundation.setRoot(Object),EmbeddedStorageFoundation.setRootResolverProvider(PersistenceRootResolverProvider),PersistenceFoundation.setRootResolverProvider(PersistenceRootResolverProvider)
-
setRootResolverProvider
Description copied from interface:EmbeddedStorageFoundationAlias for
Sets the.onConnectionFoundation(f -> f.setRootResolverProvider(rootResolverProvider);) }PersistenceRootResolverProviderinstance to be used in the internalEmbeddedStorageConnectionFoundation.- Specified by:
setRootResolverProviderin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
rootResolverProvider- thePersistenceRootResolverProviderto be set.- Returns:
- this to allow method chaining.
- See Also:
EmbeddedStorageFoundation.setRootSupplier(Supplier),PersistenceFoundation.setRootResolverProvider(PersistenceRootResolverProvider)
-
getConnectionFoundation
Description copied from interface:EmbeddedStorageFoundationReturns the currently setStorageConfigurationinstance.If no instance is set and the implementation deems an instance of this type mandatory for the successful executon of
EmbeddedStorageFoundation.createEmbeddedStorageManager(), 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, aMissingFoundationPartExceptionis thrown.- Specified by:
getConnectionFoundationin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Returns:
- the currently set instance, potentially created on-demand if required.
-
getDatabases
Description copied from interface:EmbeddedStorageFoundationThe register ofDatabases whereStorageManagerinstances created by this foundation instance will be registered. By default, this is the global singleton returned byDatabases.get(), but it can be set to any arbitraryDatabasesinstances by callingEmbeddedStorageFoundation.setDatabases(Databases).- Specified by:
getDatabasesin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Returns:
- the
Databasesinstance used to register newly createdStorageManagerinstances. - See Also:
EmbeddedStorageFoundation.setDatabases(Databases),EmbeddedStorageFoundation.setDataBaseName(String),EmbeddedStorageFoundation.getDataBaseName()
-
getDataBaseName
Description copied from interface:EmbeddedStorageFoundationA name uniquely identifying theDatabasewhereStorageManagerinstances created by this foundation will belong to. If no arbitrary name has been set by callingEmbeddedStorageFoundation.setDataBaseName(String), a generic name is derived using the storage location.- Specified by:
getDataBaseNamein interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Returns:
- a name uniquely identifying the
Databaseto be used. - See Also:
EmbeddedStorageFoundation.setDataBaseName(String),EmbeddedStorageFoundation.setDatabases(Databases),EmbeddedStorageFoundation.getDatabases()
-
getRootResolverProvider
Description copied from interface:EmbeddedStorageFoundationReturns the internalEmbeddedStorageConnectionFoundationinstance'sPersistenceRootResolverProviderinstance. If none is present so far, a new default one is created.- Specified by:
getRootResolverProviderin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Returns:
- the
PersistenceRootResolverProviderinstance to be used.
-
getTypeEvaluatorPersistable
- Specified by:
getTypeEvaluatorPersistablein interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>
-
setConfiguration
Description copied from interface:StorageFoundationSets theStorageConfigurationinstance to be used for the assembly.- Specified by:
setConfigurationin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setConfigurationin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
configuration- the instance to be used.- Returns:
- this to allow method chaining.
-
setRequestAcceptorCreator
Description copied from interface:StorageFoundationSets theStorageRequestAcceptor.Creatorinstance to be used for the assembly.- Specified by:
setRequestAcceptorCreatorin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setRequestAcceptorCreatorin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
requestAcceptorCreator- the instance to be used.- Returns:
- this to allow method chaining.
-
setTaskBrokerCreator
Description copied from interface:StorageFoundationSets theStorageTaskBroker.Creatorinstance to be used for the assembly.- Specified by:
setTaskBrokerCreatorin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setTaskBrokerCreatorin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
taskBrokerCreator- the instance to be used.- Returns:
- this to allow method chaining.
-
setDataChunkValidatorProvider
public F setDataChunkValidatorProvider(StorageDataChunkValidator.Provider dataChunkValidatorProvider)Description copied from interface:StorageFoundationSets theStorageDataChunkValidator.Providerinstance to be used for the assembly.- Specified by:
setDataChunkValidatorProviderin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setDataChunkValidatorProviderin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
dataChunkValidatorProvider- the instance to be used.- Returns:
- this to allow method chaining.
-
setChannelCreator
Description copied from interface:StorageFoundationSets theStorageChannelsCreatorinstance to be used for the assembly.- Specified by:
setChannelCreatorin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setChannelCreatorin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
channelCreator- the instance to be used.- Returns:
- this to allow method chaining.
-
setTaskCreator
Description copied from interface:StorageFoundationSets theStorageRequestTaskCreatorinstance to be used for the assembly.- Specified by:
setTaskCreatorin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setTaskCreatorin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
taskCreator- the instance to be used.- Returns:
- this to allow method chaining.
-
setTypeDictionary
Description copied from interface:StorageFoundationSets theStorageTypeDictionaryinstance to be used for the assembly.- Specified by:
setTypeDictionaryin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setTypeDictionaryin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
typeDictionary- the instance to be used.- Returns:
- this to allow method chaining.
-
setRootTypeIdProvider
Description copied from interface:StorageFoundationSets theStorageRootTypeIdProviderinstance to be used for the assembly.- Specified by:
setRootTypeIdProviderin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setRootTypeIdProviderin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
rootTypeIdProvider- the instance to be used.- Returns:
- this to allow method chaining.
-
setConnectionFoundation
Description copied from interface:EmbeddedStorageFoundationSets theEmbeddedStorageConnectionFoundationinstance to be used for the assembly.- Specified by:
setConnectionFoundationin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
connectionFoundation- the instance to be used.- Returns:
- this to allow method chaining.
-
setDatabases
Description copied from interface:EmbeddedStorageFoundationSets theDatabasesinstance to be used to register newly createdStorageManagerinstances.
Also see the description inEmbeddedStorageFoundation.getDatabases().- Specified by:
setDatabasesin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
databases- theDatabasesinstance used to register newly createdStorageManagerinstances.- Returns:
- this to allow method chaining.
- See Also:
EmbeddedStorageFoundation.getDatabases(),EmbeddedStorageFoundation.getDataBaseName(),EmbeddedStorageFoundation.setDataBaseName(String)
-
setDataBaseName
Description copied from interface:EmbeddedStorageFoundationSets the name uniquely identifying theDatabaseto be used.
Also see the description inEmbeddedStorageFoundation.getDataBaseName().- Specified by:
setDataBaseNamein interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
dataBaseName- the name of theDatabaseto be used- Returns:
- this to allow method chaining.
-
setRefactoringMappingProvider
public F setRefactoringMappingProvider(PersistenceRefactoringMappingProvider refactoringMappingProvider)Description copied from interface:EmbeddedStorageFoundationSets the passedPersistenceRefactoringMappingProviderinstance to theEmbeddedStorageConnectionFoundationinstance provided byEmbeddedStorageFoundation.getConnectionFoundation().- Specified by:
setRefactoringMappingProviderin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
refactoringMappingProvider- the instance to be used.- Returns:
- this to allow method chaining.
- See Also:
PersistenceFoundation.setRefactoringMappingProvider(PersistenceRefactoringMappingProvider)
-
setTimestampProvider
Description copied from interface:StorageFoundationSets theStorageTimestampProviderinstance to be used for the assembly.- Specified by:
setTimestampProviderin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setTimestampProviderin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
timestampProvider- the instance to be used.- Returns:
- this to allow method chaining.
-
setTypeEvaluatorPersistable
- Specified by:
setTypeEvaluatorPersistablein interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>
-
setWriteController
- Specified by:
setWriteControllerin interfaceStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Overrides:
setWriteControllerin classStorageFoundation.Default<F extends EmbeddedStorageFoundation.Default<?>>
-
executeTypeHandlerRegistration
public F executeTypeHandlerRegistration(PersistenceTypeHandlerRegistration<Binary> typeHandlerRegistration)Description copied from interface:EmbeddedStorageFoundationConvenience method forthis.getConnectionFoundation().executeTypeHandlerRegistration(typeHandlerRegistration).See
PersistenceFoundation.executeTypeHandlerRegistration(PersistenceTypeHandlerRegistration)for details.- Specified by:
executeTypeHandlerRegistrationin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
typeHandlerRegistration- thePersistenceTypeHandlerRegistrationto be executed.- Returns:
- this to allow method chaining.
-
registerTypeHandler
- Specified by:
registerTypeHandlerin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>
-
registerTypeHandlers
- Specified by:
registerTypeHandlersin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>
-
createEmbeddedStorageManager
Description copied from interface:EmbeddedStorageFoundationCreates and returns a newEmbeddedStorageManagerinstance by using the current state of all registered logic part instances and by on-demand creating missing ones via a default logic.If the passed explicitRoot is null, a default root instance will be created, see
StorageManager.defaultRoot().The returned
EmbeddedStorageManagerinstance will NOT yet be started.- Specified by:
createEmbeddedStorageManagerin interfaceEmbeddedStorageFoundation<F extends EmbeddedStorageFoundation.Default<?>>- Parameters:
root- the instance to be used as the persistent entity graph's root instance.- Returns:
- a new
EmbeddedStorageManagerinstance. - See Also:
EmbeddedStorageFoundation.createEmbeddedStorageManager(),EmbeddedStorageFoundation.start(),EmbeddedStorageFoundation.start(Object)
-