user-manager Project
This project uses Quarkus, the Supersonic Subatomic Java Framework.
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
Configuring the application
This properties must be configured to run the application
| Key | Value | Default | Mandatory | Description |
|---|---|---|---|---|
| quarkus.mongodb.connection-string | mongodb://ozg-mongodb:27017 | none | yes | The connection string for the mongo db database |
| quarkus.mongodb.database | usermanager | usermanager | no | Name of the mongo db database |
| kop.keycloak.sync.cron | 0 15 2 * * ? | 0 15 2 * * ? | no | Cron statement when the sync is done |
| kop.keycloak.api.user | apiUser | none | yes | The name of the keycloak admin api user |
| kop.keycloak.api.password | **** | none | yes | The password of the keycloak admin api user |
| kop.keycloak.api.realm | realm-name | none | yes | The name of the realm |
| kop.keycloak.api.organisations-einheit-id-key | organisationseinheitId | organisationseinheitId | no | The key where the organisationsEinheitId of the group is saved |
| kop.keycloak.api.ldap-id-key | LDAP_ID | LDAP_ID | no | The key to get the keycloak user id from |
| kop.usermanager.url | http://localhost:8080 | none | yes | The external root url of the usermanager |
| keycloak.url | https://sso.service | none | yes | The root url of the keycloak service |
Running the application in dev mode
You can run your application in dev mode that enables live coding using:
./mvnw compile quarkus:devNOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
Packaging and running the application
The application can be packaged using:
./mvnw packageIt produces the quarkus-run.jar file in the target/quarkus-app/ directory.
Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.
The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.
If you want to build an über-jar, execute the following command:
./mvnw package -Dquarkus.package.type=uber-jarThe application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.
Creating a native executable
You can create a native executable using:
./mvnw package -PnativeOr, if you don't have GraalVM installed, you can run the native executable build in a container using:
./mvnw package -Pnative -Dquarkus.native.container-build=trueYou can then execute your native executable with: ./target/user-manager-1.0.0-SNAPSHOT-runner
If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.
Related Guides
- MongoDB with Panache (guide): Simplify your persistence code for MongoDB via the active record or the repository pattern
- SmallRye Health (guide): Monitor service health
Provided Code
RESTEasy Reactive
Easily start your Reactive RESTful Web Services
SmallRye Health
Monitor your application's health using SmallRye Health
Best parctice
User package-private fields for injected fields
This involves injection fields, constructors and initializers, observer methods, producer methods and fields, disposers and interceptor methods.