MicroStream Reference Manual
MicroStream HomeAPI Docs
3.0
3.0
  • Preface
  • System Requirements
  • License
  • Changelog
  • Installation
  • Data-Store
    • Overview
    • Getting Started
    • Root Instances
    • Configuration
      • Properties
      • Storage Files and Directories
      • Using Channels
      • Housekeeping
      • Backup
      • Lock File
    • Storing Data
      • Convenience Methods and Explicit Storing (Transactions)
      • Lazy and Eager Storing
      • Transient Fields
      • Best Practice
    • Loading Data
      • Lazy Loading
        • Touched Timestamp, Null-Safe Variant
        • Clearing Lazy References
    • Deleting Data
    • Queries
    • Application Life-Cycle
    • Legacy Type Mapping
      • User Interaction
    • Backup Strategies
    • Import / Export
    • Housekeeping
    • Customizing
      • Custom Type Handler
      • Custom Legacy Type Handler
      • Custom Class Loader
      • Custom Storing Behavior
      • Optional Storage Manager Reference in Entities
    • REST Interface
      • Setup
      • REST API
      • Client GUI
    • FAQ
      • Data Model
      • Data Management
      • File Storage
      • Java Features
      • Miscellaneous
    • Addendum
      • Supported Java Features
      • Specialized Type Handlers
      • Examples and Demo Projects
  • Cache
    • Overview
    • Getting Started
    • Configuration
      • Properties
      • Storage
    • Use Cases
      • Hibernate Second Level Cache
      • Spring Cache
  • Basic Concepts
    • Layered Entities
      • Configuration
      • Defining Entities
      • Creating Entities
      • Updating Entities
      • Versioning
      • Logging
      • Multiple Layers
    • Wrapping
      • Configuration
      • Usage
Powered by GitBook
On this page
Export as PDF
  1. Data-Store
  2. Customizing

Custom Class Loader

PreviousCustom Legacy Type HandlerNextCustom Storing Behavior

Last updated 3 years ago

This is the manual for older MicroStream versions (Version < 5.0).

The new documentation (Version >= 5.0) is located at:

In certain environments or setups it is necessary to provide specific ClassLoader instances. This can be done by customizing the connection foundation.

If a single ClassLoader is sufficient, just create a new provider by handing over the instance:

EmbeddedStorageManager storage = EmbeddedStorage.Foundation(Paths.get("mydb"))
    .onConnectionFoundation(cf -> 
        cf.setClassLoaderProvider(ClassLoaderProvider.New(myClassLoader))    
    )
    .start();

Or return a ClassLoader depending on the requested type:

EmbeddedStorageManager storage = EmbeddedStorage.Foundation(Paths.get("mydb"))
    .onConnectionFoundation(cf -> 
        cf.setClassLoaderProvider(typeName -> {
            if(typeName.startsWith("com.company.module1."))
            {
                return module1ClassLoader;
            }
            if(typeName.startsWith("com.company.module2."))
            {
                return module2ClassLoader;
            }
            return ClassLoader.getSystemClassLoader();
        })    
    )
    .start();

Class Loader in Application Server

Most application servers load the session's classes with the context class loader. Just use the one of the current thread:

EmbeddedStorageManager storage = EmbeddedStorage.Foundation(Paths.get("mydb"))
    .onConnectionFoundation(cf -> 
        cf.setClassLoaderProvider(ClassLoaderProvider.New(
            Thread.currentThread().getContextClassLoader()
        ))    
    )
    .start();
https://docs.microstream.one/