JarCastingPlume Framework
Plume Framework is a lightweight modular Java framework. It aims to remain as simple as possible while it can be customized enough to fit exactly your application need. Plume is mainly aggregating (great) JVM libraries. This way, the Plume code base is limited to the minimum so that the aggregated libraries can function together.
Plume Framework require at least Java 8. Its modules contains connectors for Guice and Dagger.
Plume Framework is maintained by Coreoz and licensed under Apache License 2.0.
Upgrade from 1.x to 2.x
See upgrade instructions in the release details.
Philosophy
The goal of Plume Framework is to maximize the reusability of its modules. For example Plume Framework components can be easily used with Play Framework or with Spark Java. In these cases the Plume Jersey module will be replaced with the corresponding Play and Spark engines.
To make modules reusable in other contexts, we tried to limit to the minimum the dependencies between each module.
Though Plume Framework only offers dependency injection connectors to Guice and Dragger, it is possible to adapt these connectors to work with Spring or CDI.
Demo
Sample projects can be found here: https://github.com/Coreoz/Plume-demo.
Getting started
The best way to get started is to use a Maven archetype for Plume Framework.
Dependency injection
If you are not familiar with the dependency injection concept, read the Guice Motivation Guice.
Dependency injection takes a central place in Plume Framework. Indeed, all modules provided by Plume Framework contain injectable objects. To use these injectables objects, the default choice is Guice: it is really easy to use.
If you are already familiar with Guice, you may want to have a look at Dagger which enables to detect dependency injection problems at compile time. To use Dagger the annotation processor should be enabled in your IDE: https://immutables.github.io/apt.html. However note that Dagger may be more difficult to use than Guice.
In Plume Framework documentation, examples use Guice modules. Most of the time there is a corresponding Dagger module to each Guice module. For example, the corresponding Dagger module for GuiceConfModule is DaggerConfModule.
Plume core modules
General modules
Plume Framework Dependencies
Reference all libraries versions used by Plume Framework. It will help you avoid dependency conflicts in your pom.xml file.
Plume Conf
This module is based on the Config library and handles the application configuration.
Plume Jersey
Enables to build REST web-services with Jersey and expose the documentation with Swagger.
Plume Services
Common services that are often needed in projects or libraries.
Plume Mail
Expose a Mailer object from Simple Java Mail through a Config configuration.
Plume Scheduler
Enables to easily execute recurring tasks/jobs through Wisp Scheduler.
Database modules
Plume Database
Basic utilities to pool SQL connections with HikariCP and manage transactions.
Plume Querydsl
Integration with Querydsl for SQL only (no JPA :).
Plume Querydsl Codegen
Code generation for Querydsl for SQL only.
Plume Database test
Use Flyway to help you make integration tests with a database.
Other Libraries to use with Plume Framework
If you need an HTTP client in a Plume application, a good choice is to use:
