Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rdebusscher/microstream-helidon-patterns
Patterns in using Helidon with MicroStream
https://github.com/rdebusscher/microstream-helidon-patterns
Last synced: 8 days ago
JSON representation
Patterns in using Helidon with MicroStream
- Host: GitHub
- URL: https://github.com/rdebusscher/microstream-helidon-patterns
- Owner: rdebusscher
- License: apache-2.0
- Created: 2022-10-06T07:30:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-15T13:45:44.000Z (about 2 years ago)
- Last Synced: 2024-11-16T16:14:57.226Z (2 months ago)
- Language: Java
- Size: 64.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MicroStream Helidon Usage Patterns
Patterns in using Helidon with MicroStream.
MicroStream can be used in 2 different ways with Helidon.
MicroStream is integrated into the Helidon codebase by the Oracle Team. You can find the examples in the `integrated` folder.
Since Helidon MP makes use of Jakarta EE CDI and MicroProfile Config, our generic integration for these frameworks can also be used with Helidon. These examples can be found in the `integration` folder.
## Integrated
As of Helidon 2.4, MicroStream is integrated within the framework. This means that you can make use of the Helidon artifacts to make use of the MicroStream functionality using the Helidon-provided code.
The following functionality is provided
- Use the Helidon Config functionality to define the configuration parameter that will be used when instantiating the `EmbeddedStorageManager`.
- Ability to define and inject multiple `EmbeddedStorageManager`'s.
- Ability to configure a MicroStream cache (based on JCache specification) and inject it into CDI beans when using Helidon MP.
- Optional Health check that reports if the _StorageManager_ is active.
- Optional metrics reporting some basic statistics on the _StorageManager_.
Native compilation is not fully supported.
### dataMP
Requires JDK 11+ and is using Jakarta EE 8 specification (javax namespace).
The folder `dataMP` contains a Maven project that makes use of Helidon MP 2.5.4 to implement a small application with REST endpoints storing the data using MicroStream. Highlights:
- Recommended usage of the Helidon MP integrated code
- Use a CDI producer to provide the Root object as a CDI bean.
- Check MicroStream startup and initial data set-up using a `HelidonTest`.
- Using a Docker image with volume mapping to store MicroStream storage outside of the container.
- Using Kubernetes deployment and Service concepts to run the Helidon MP with MicroStream application.
- Use JLink and the Class Data Sharing feature of the JVM to generate a small and fast starting fully contained Java application.
Also, have a look at the `readme.MD` file in that folder to learn about the details.
### dataSE
Requires JDK 11+.
The folder `dataSE` contains a Maven project that makes use of Helidon SE 2.5.4 to implement a small application with REST endpoints storing the data using MicroStream. Highlights:
- Recommended usage of the Helidon SE integrated code : Reading configuration parameters and create Storage and initialise the Root.
- Check MicroStream startup and initial data set-up using an integration test.
- Add MicroStream info to Health and Metrics endpoints of Helidon (through the integration code)
- Using a Docker image with volume mapping to store MicroStream storage outside of the container.
- Using Kubernetes deployment and Service concepts to run the Helidon MP with MicroStream application.
- Use JLink and the Class Data Sharing feature of the JVM to generate a small and fast starting fully contained Java application.
Also, have a look at the `readme.MD` file in that folder to learn about the details.
### dataMP3
Requires JDK 17+ and is using Jakarta EE 9.1 specification (jakarta namespace).
The folder `dataMP3` contains a Maven project that makes use of Helidon MP 3.0.2 to implement a small application with REST endpoints storing the data using MicroStream. Highlights:
- Recommended usage of the Helidon MP integrated code
- Use a CDI producer to provide the Root object as a CDI bean.
- Check MicroStream startup and initial data set-up using a `HelidonTest`.
- Using a Docker image with volume mapping to store MicroStream storage outside of the container.
- Use JLink and the Class Data Sharing feature of the JVM to generate a small and fast starting fully contained Java application.
Also, have a look at the `readme.MD` file in that folder to learn about the details.
### dataSE3
Requires JDK 17+.
The folder `dataSE3` contains a Maven project that makes use of Helidon SE 3.0.2 to implement a small application with REST endpoints storing the data using MicroStream. Highlights:
- Recommended usage of the Helidon SE integrated code : Reading configuration parameters and create Storage and initialise the Root.
- Check MicroStream startup and initial data set-up using an integration test.
- Add MicroStream info to Health and Metrics endpoints of Helidon (through the integration code)
- Using a Docker image with volume mapping to store MicroStream storage outside of the container.
Also, have a look at the `readme.MD` file in that folder to learn about the details.