diff --git a/README.md b/README.md index 03c16388f8..860f4c8f9e 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,8 @@ See [CONTRIBUTING](CONTRIBUTING.md) for how to build these examples. * [Hibernate ORM with Panache and RESTEasy](./hibernate-orm-panache-quickstart): Exposing a CRUD service over REST using Panache to connect to a PostgreSQL database * [Hibernate ORM with Panache and RESTEasy in Kotlin](./hibernate-orm-panache-kotlin-quickstart): Exposing a CRUD service over REST using Panache and kotlin to connect to a PostgreSQL database * [Hibernate ORM REST Data with Panache](./hibernate-orm-rest-data-panache-quickstart): Automatically generate the CRUD endpoints for your entities and repositories using Hibernate ORM with Panache. -* [Hibernate ORM Multitenancy](./hibernate-orm-multi-tenancy-quickstart): Multitenant CRUD service over REST using Hibernate ORM to connect to a PostgreSQL database (schema or database approach) +* [Hibernate ORM Multitenancy Database](./hibernate-orm-multi-tenancy-database-quickstart): Multitenant CRUD service over REST using Hibernate ORM to connect to multiple PostgreSQL databases (database approach) +* [Hibernate ORM Multitenancy Schema](./hibernate-orm-multi-tenancy-schema-quickstart): Multitenant CRUD service over REST using Hibernate ORM to connect to a PostgreSQL database (schema approach) * [Hibernate Search + Elasticsearch](./hibernate-search-orm-elasticsearch-quickstart): Index your Hibernate entities in Elasticsearch to get full text search * [Infinispan Client](./infinispan-client-quickstart): How to use Infinispan Client. Covers creating caches and simple get/put * [Artemis JMS](./jms-quickstart): How to use the Artemis JMS extension diff --git a/hibernate-orm-multi-tenancy-quickstart/.dockerignore b/hibernate-orm-multi-tenancy-database-quickstart/.dockerignore similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/.dockerignore rename to hibernate-orm-multi-tenancy-database-quickstart/.dockerignore diff --git a/hibernate-orm-multi-tenancy-quickstart/.gitignore b/hibernate-orm-multi-tenancy-database-quickstart/.gitignore similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/.gitignore rename to hibernate-orm-multi-tenancy-database-quickstart/.gitignore diff --git a/hibernate-orm-multi-tenancy-quickstart/.mvn/wrapper/maven-wrapper.jar b/hibernate-orm-multi-tenancy-database-quickstart/.mvn/wrapper/maven-wrapper.jar similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/.mvn/wrapper/maven-wrapper.jar rename to hibernate-orm-multi-tenancy-database-quickstart/.mvn/wrapper/maven-wrapper.jar diff --git a/hibernate-orm-multi-tenancy-quickstart/.mvn/wrapper/maven-wrapper.properties b/hibernate-orm-multi-tenancy-database-quickstart/.mvn/wrapper/maven-wrapper.properties similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/.mvn/wrapper/maven-wrapper.properties rename to hibernate-orm-multi-tenancy-database-quickstart/.mvn/wrapper/maven-wrapper.properties diff --git a/hibernate-orm-multi-tenancy-database-quickstart/README.md b/hibernate-orm-multi-tenancy-database-quickstart/README.md new file mode 100644 index 0000000000..98a9666a1b --- /dev/null +++ b/hibernate-orm-multi-tenancy-database-quickstart/README.md @@ -0,0 +1,64 @@ +# Supporting Multi-Tenancy in Hibernate ORM (database approach) + +This guide demonstrates how your Hibernate ORM application can support multitenancy so that you can serve multiple tenants from a single application. + +When serving multiple customers from a same application (e.g.: SaaS), each customer is a tenant with a separate database. + +For the schema per tenant approach see [Schema Quickstart](../hibernate-orm-multi-tenancy-schema-quickstart/README.md). + +## Requirements + +To compile and run this demo you will need: + +- JDK 17+ +- GraalVM + +In addition, you will need either a PostgreSQL database, or Docker to run one. + +### Configuring GraalVM and JDK 17+ + +Make sure that both the `GRAALVM_HOME` and `JAVA_HOME` environment variables have +been set, and that a JDK 17+ `java` command is on the path. + +See the [Building a Native Executable guide](https://quarkus.io/guides/building-native-image) +for help setting up your environment. + +## Building the demo + +Launch the Maven build on the checked out sources of this demo: + +> ./mvnw package + +## Running the demo + +### Start Quarkus in development mode + +The Maven Quarkus plugin provides a development mode that supports live coding. To try this out: + +> ./mvnw quarkus:dev + +In this mode you can make changes to the code and have the changes immediately applied, by just refreshing your browser. + +### Run Quarkus as native executable + +You can also create a native executable from this application without making any source code changes. A native executable removes the dependency on the JVM: +everything needed to run the application on the target platform is included in the executable, allowing the application to run with minimal resource overhead. + +Compiling a native executable takes a bit longer, as GraalVM performs additional steps to remove unnecessary codepaths. Use the `native` profile to compile a native executable: + +> ./mvnw package -Pnative + +After getting a cup of coffee, you'll be able to run this executable directly: + +> ./target/hibernate-orm-schema-multi-tenancy-quickstart-1.0.0-SNAPSHOT-runner + + +## See the demo in your browser + +Navigate to: + + + +You can easily select the tenant in the dropdown and in the background the appropriate database will be selected. + +Have fun, and join the team of contributors! \ No newline at end of file diff --git a/hibernate-orm-multi-tenancy-quickstart/mvnw b/hibernate-orm-multi-tenancy-database-quickstart/mvnw similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/mvnw rename to hibernate-orm-multi-tenancy-database-quickstart/mvnw diff --git a/hibernate-orm-multi-tenancy-quickstart/mvnw.cmd b/hibernate-orm-multi-tenancy-database-quickstart/mvnw.cmd similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/mvnw.cmd rename to hibernate-orm-multi-tenancy-database-quickstart/mvnw.cmd diff --git a/hibernate-orm-multi-tenancy-database-quickstart/pom.xml b/hibernate-orm-multi-tenancy-database-quickstart/pom.xml new file mode 100644 index 0000000000..3c3b7c6346 --- /dev/null +++ b/hibernate-orm-multi-tenancy-database-quickstart/pom.xml @@ -0,0 +1,157 @@ + + + 4.0.0 + org.acme + hibernate-orm-multi-tenancy-database-quickstart + 1.0.0-SNAPSHOT + + + quarkus-bom + io.quarkus + 999-SNAPSHOT + 3.1.2 + 3.11.0 + UTF-8 + UTF-8 + + + + + + ${quarkus.platform.group-id} + ${quarkus.platform.artifact-id} + ${quarkus.platform.version} + import + pom + + + + + + + io.quarkus + quarkus-hibernate-orm + + + io.quarkus + quarkus-agroal + + + io.quarkus + quarkus-rest + + + io.quarkus + quarkus-rest-jackson + + + io.quarkus + quarkus-flyway + + + org.flywaydb + flyway-database-postgresql + + + io.quarkus + quarkus-jdbc-postgresql + + + + + io.quarkus + quarkus-junit5 + test + + + io.rest-assured + rest-assured + test + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + ${compiler-plugin.version} + + 11 + 11 + + true + + + + + maven-surefire-plugin + ${surefire-plugin.version} + + + org.jboss.logmanager.LogManager + ${maven.home} + + + + + + ${quarkus.platform.group-id} + quarkus-maven-plugin + ${quarkus.platform.version} + + + + build + + + + + + + + + + + native + + + native + + + + true + false + + + + + org.apache.maven.plugins + maven-failsafe-plugin + ${surefire-plugin.version} + + + + integration-test + verify + + + + + ${project.build.directory}/${project.build.finalName}-runner + + org.jboss.logmanager.LogManager + + ${maven.home} + + + + + + + + + + diff --git a/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.jvm b/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.jvm new file mode 100644 index 0000000000..0be83f9d7b --- /dev/null +++ b/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.jvm @@ -0,0 +1,97 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode +# +# Before building the container image run: +# +# ./mvnw package +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/hibernate-orm-multi-tenancy-database-quickstart-jvm . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-database-quickstart-jvm +# +# If you want to include the debug port into your docker image +# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. +# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 +# when running the container +# +# Then run the container using : +# +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-database-quickstart-jvm +# +# This image uses the `run-java.sh` script to run the application. +# This scripts computes the command line to execute your Java application, and +# includes memory/GC tuning. +# You can configure the behavior using the following environment properties: +# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") +# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options +# in JAVA_OPTS (example: "-Dsome.property=foo") +# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is +# used to calculate a default maximal heap memory based on a containers restriction. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio +# of the container available memory as set here. The default is `50` which means 50% +# of the available memory is used as an upper boundary. You can skip this mechanism by +# setting this value to `0` in which case no `-Xmx` option is added. +# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This +# is used to calculate a default initial heap memory based on the maximum heap memory. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio +# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` +# is used as the initial heap size. You can skip this mechanism by setting this value +# to `0` in which case no `-Xms` option is added (example: "25") +# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. +# This is used to calculate the maximum value of the initial heap memory. If used in +# a container without any memory constraints for the container then this option has +# no effect. If there is a memory constraint then `-Xms` is limited to the value set +# here. The default is 4096MB which means the calculated value of `-Xms` never will +# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") +# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output +# when things are happening. This option, if set to true, will set +# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). +# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: +# true"). +# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). +# - CONTAINER_CORE_LIMIT: A calculated core limit as described in +# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") +# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). +# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. +# (example: "20") +# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. +# (example: "40") +# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. +# (example: "4") +# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus +# previous GC times. (example: "90") +# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") +# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") +# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should +# contain the necessary JRE command-line options to specify the required GC, which +# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). +# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") +# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") +# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be +# accessed directly. (example: "foo.example.com,bar.example.com") +# +### +FROM registry.access.redhat.com/ubi8/openjdk-17:1.19 + +ENV LANGUAGE='en_US:en' + + +# We make four distinct layers so if there are application changes the library layers can be re-used +COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/ +COPY --chown=185 target/quarkus-app/*.jar /deployments/ +COPY --chown=185 target/quarkus-app/app/ /deployments/app/ +COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/ + +EXPOSE 8080 +USER 185 +ENV JAVA_OPTS_APPEND="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" +ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" + +ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] + diff --git a/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.legacy-jar b/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.legacy-jar new file mode 100644 index 0000000000..5850119247 --- /dev/null +++ b/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.legacy-jar @@ -0,0 +1,93 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode +# +# Before building the container image run: +# +# ./mvnw package -Dquarkus.package.jar.type=legacy-jar +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/hibernate-orm-multi-tenancy-database-quickstart-legacy-jar . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-database-quickstart-legacy-jar +# +# If you want to include the debug port into your docker image +# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. +# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 +# when running the container +# +# Then run the container using : +# +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-database-quickstart-legacy-jar +# +# This image uses the `run-java.sh` script to run the application. +# This scripts computes the command line to execute your Java application, and +# includes memory/GC tuning. +# You can configure the behavior using the following environment properties: +# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") +# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options +# in JAVA_OPTS (example: "-Dsome.property=foo") +# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is +# used to calculate a default maximal heap memory based on a containers restriction. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio +# of the container available memory as set here. The default is `50` which means 50% +# of the available memory is used as an upper boundary. You can skip this mechanism by +# setting this value to `0` in which case no `-Xmx` option is added. +# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This +# is used to calculate a default initial heap memory based on the maximum heap memory. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio +# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` +# is used as the initial heap size. You can skip this mechanism by setting this value +# to `0` in which case no `-Xms` option is added (example: "25") +# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. +# This is used to calculate the maximum value of the initial heap memory. If used in +# a container without any memory constraints for the container then this option has +# no effect. If there is a memory constraint then `-Xms` is limited to the value set +# here. The default is 4096MB which means the calculated value of `-Xms` never will +# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") +# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output +# when things are happening. This option, if set to true, will set +# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). +# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: +# true"). +# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). +# - CONTAINER_CORE_LIMIT: A calculated core limit as described in +# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") +# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). +# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. +# (example: "20") +# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. +# (example: "40") +# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. +# (example: "4") +# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus +# previous GC times. (example: "90") +# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") +# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") +# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should +# contain the necessary JRE command-line options to specify the required GC, which +# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). +# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") +# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") +# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be +# accessed directly. (example: "foo.example.com,bar.example.com") +# +### +FROM registry.access.redhat.com/ubi8/openjdk-17:1.19 + +ENV LANGUAGE='en_US:en' + + +COPY target/lib/* /deployments/lib/ +COPY target/*-runner.jar /deployments/quarkus-run.jar + +EXPOSE 8080 +USER 185 +ENV JAVA_OPTS_APPEND="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" +ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" + +ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] diff --git a/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.native b/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.native new file mode 100644 index 0000000000..43cfbcd762 --- /dev/null +++ b/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.native @@ -0,0 +1,27 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. +# +# Before building the container image run: +# +# ./mvnw package -Dnative +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.native -t quarkus/hibernate-orm-multi-tenancy-database-quickstart . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-database-quickstart +# +### +FROM registry.access.redhat.com/ubi8/ubi-minimal:8.9 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.native-micro b/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.native-micro new file mode 100644 index 0000000000..3c641cedc5 --- /dev/null +++ b/hibernate-orm-multi-tenancy-database-quickstart/src/main/docker/Dockerfile.native-micro @@ -0,0 +1,30 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. +# It uses a micro base image, tuned for Quarkus native executables. +# It reduces the size of the resulting container image. +# Check https://quarkus.io/guides/quarkus-runtime-base-image for further information about this image. +# +# Before building the container image run: +# +# ./mvnw package -Dnative +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/hibernate-orm-multi-tenancy-database-quickstart . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-database-quickstart +# +### +FROM quay.io/quarkus/quarkus-micro-image:2.0 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java b/hibernate-orm-multi-tenancy-database-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java similarity index 91% rename from hibernate-orm-multi-tenancy-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java rename to hibernate-orm-multi-tenancy-database-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java index c788f827d3..a4129b3fb9 100644 --- a/hibernate-orm-multi-tenancy-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java +++ b/hibernate-orm-multi-tenancy-database-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java @@ -1,16 +1,17 @@ package org.acme.hibernate.orm; -import jakarta.enterprise.context.RequestScoped; -import jakarta.inject.Inject; - import org.jboss.logging.Logger; import io.quarkus.arc.Unremovable; +import io.quarkus.hibernate.orm.PersistenceUnitExtension; import io.quarkus.hibernate.orm.runtime.tenant.TenantResolver; import io.vertx.ext.web.RoutingContext; +import jakarta.enterprise.context.RequestScoped; +import jakarta.inject.Inject; @RequestScoped @Unremovable +@PersistenceUnitExtension public class CustomTenantResolver implements TenantResolver { private static final Logger LOG = Logger.getLogger(CustomTenantResolver.class); diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/java/org/acme/hibernate/orm/Fruit.java b/hibernate-orm-multi-tenancy-database-quickstart/src/main/java/org/acme/hibernate/orm/Fruit.java similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/main/java/org/acme/hibernate/orm/Fruit.java rename to hibernate-orm-multi-tenancy-database-quickstart/src/main/java/org/acme/hibernate/orm/Fruit.java diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/java/org/acme/hibernate/orm/FruitResource.java b/hibernate-orm-multi-tenancy-database-quickstart/src/main/java/org/acme/hibernate/orm/FruitResource.java similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/main/java/org/acme/hibernate/orm/FruitResource.java rename to hibernate-orm-multi-tenancy-database-quickstart/src/main/java/org/acme/hibernate/orm/FruitResource.java diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/resources/META-INF/resources/favicon.ico b/hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/META-INF/resources/favicon.ico similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/main/resources/META-INF/resources/favicon.ico rename to hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/META-INF/resources/favicon.ico diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/resources/META-INF/resources/index.html b/hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/META-INF/resources/index.html similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/main/resources/META-INF/resources/index.html rename to hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/META-INF/resources/index.html diff --git a/hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/application.properties b/hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/application.properties new file mode 100644 index 0000000000..24de8bdf06 --- /dev/null +++ b/hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/application.properties @@ -0,0 +1,20 @@ +quarkus.hibernate-orm.database.generation=none + +quarkus.hibernate-orm.multitenant=DATABASE +quarkus.hibernate-orm.datasource=base + +# Default tenant 'base' +quarkus.datasource.base.db-kind=postgresql +quarkus.datasource.base.username=quarkus_test +quarkus.datasource.base.password=quarkus_test +%prod.quarkus.datasource.base.jdbc.url=jdbc:postgresql://localhost:5432/quarkus_test +quarkus.flyway.base.locations=classpath:database/base +quarkus.flyway.base.migrate-at-start=true + +# Tenant 'mycompany' +quarkus.datasource.mycompany.db-kind=postgresql +quarkus.datasource.mycompany.username=mycompany +quarkus.datasource.mycompany.password=mycompany +%prod.quarkus.datasource.mycompany.jdbc.url=jdbc:postgresql://localhost:5433/mycompany +quarkus.flyway.mycompany.locations=classpath:database/mycompany +quarkus.flyway.mycompany.migrate-at-start=true \ No newline at end of file diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/resources/database/base/V1.0.0__create_fruits.sql b/hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/database/base/V1.0.0__create_fruits.sql similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/main/resources/database/base/V1.0.0__create_fruits.sql rename to hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/database/base/V1.0.0__create_fruits.sql diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/resources/database/mycompany/V1.0.0__create_fruits.sql b/hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/database/mycompany/V1.0.0__create_fruits.sql similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/main/resources/database/mycompany/V1.0.0__create_fruits.sql rename to hibernate-orm-multi-tenancy-database-quickstart/src/main/resources/database/mycompany/V1.0.0__create_fruits.sql diff --git a/hibernate-orm-multi-tenancy-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointIT.java b/hibernate-orm-multi-tenancy-database-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointIT.java similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointIT.java rename to hibernate-orm-multi-tenancy-database-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointIT.java diff --git a/hibernate-orm-multi-tenancy-database-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointTest.java b/hibernate-orm-multi-tenancy-database-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointTest.java new file mode 100644 index 0000000000..a90399da59 --- /dev/null +++ b/hibernate-orm-multi-tenancy-database-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointTest.java @@ -0,0 +1,165 @@ +package org.acme.hibernate.orm; + +import static io.restassured.RestAssured.given; +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.core.IsNot.not; + +import org.junit.jupiter.api.Test; + +import io.quarkus.test.junit.QuarkusTest; +import io.restassured.response.Response; + +@QuarkusTest +public class FruitsEndpointTest { + + @Test + public void testListAllFruitsBaseDatabase() { + + // Ensure initial state for multiple runs + Fruit cherry = findOrCreate("", "Cherry"); + deleteIfExist("", "Pear"); + + //List all, should have all 3 fruits the database has initially: + given() + .when().get("/fruits") + .then() + .statusCode(200) + .body( + containsString("Cherry"), + containsString("Apple"), + containsString("Banana")); + + //Delete the Cherry: + given() + .when().delete("/fruits/" + cherry.getId()) + .then() + .statusCode(204); + + //List all, cherry should be missing now: + given() + .when().get("/fruits") + .then() + .statusCode(200) + .body( + not(containsString("Cherry")), + containsString("Apple"), + containsString("Banana")); + + //Create the Pear: + given() + .when() + .body("{\"name\" : \"Pear\"}") + .contentType("application/json") + .post("/fruits") + .then() + .statusCode(201); + + //List all, cherry should be missing now: + given() + .when().get("/fruits") + .then() + .statusCode(200) + .body( + not(containsString("Cherry")), + containsString("Apple"), + containsString("Banana"), + containsString("Pear")); + } + + @Test + public void testListAllFruitsMyCompanyDatabase() { + + // Ensure initial state for multiple runs + Fruit avocado = findOrCreate("/mycompany", "Avocado"); + deleteIfExist("/mycompany", "Clementine"); + + //List all, should have all 3 fruits the database has initially: + given() + .when().get("/mycompany/fruits") + .then() + .statusCode(200) + .body( + containsString("Avocado"), + containsString("Apricots"), + containsString("Blackberries")); + + //Delete the Avocado: + given() + .when().delete("/mycompany/fruits/" + avocado.getId()) + .then() + .statusCode(204); + + //List all, Avocado should be missing now: + given() + .when().get("/mycompany/fruits") + .then() + .statusCode(200) + .body( + not(containsString("Avocado")), + containsString("Apricots"), + containsString("Blackberries")); + + //Create the Clementine: + given() + .when() + .body("{\"name\" : \"Clementine\"}") + .contentType("application/json") + .post("/mycompany/fruits") + .then() + .statusCode(201); + + //List all, Avocado should be missing and Clementine added now: + given() + .when().get("/mycompany/fruits") + .then() + .statusCode(200) + .body( + not(containsString("Avocado")), + containsString("Apricots"), + containsString("Blackberries"), + containsString("Clementine")); + } + + private void create(String tenantPrefix, String fruitName) { + given() + .when() + .body("{\"name\" : \"" + fruitName + "\"}") + .contentType("application/json") + .post(tenantPrefix + "/fruits") + .then() + .statusCode(201); + } + + private void deleteIfExist(String tenantPrefix, String fruitName) { + Response response = given().param("type", "name").param("value", fruitName).when().get(tenantPrefix + "/fruitsFindBy"); + if (response.statusCode() == 200) { + Fruit fruit = response.as(Fruit.class); + given() + .when().delete(tenantPrefix + "/fruits/" + fruit.getId()) + .then() + .statusCode(204); + } + } + + private Fruit find(String tenantPrefix, String fruitName) { + Response response = given().param("type", "name").param("value", fruitName).when().get(tenantPrefix + "/fruitsFindBy"); + if (response.statusCode() == 404) { + return null; + } + if (response.statusCode() == 200) { + Fruit fruit = response.as(Fruit.class); + return fruit; + } + throw new IllegalStateException("Unknown status finding '" + fruitName + ": " + response); + } + + private Fruit findOrCreate(String tenantPrefix, String name) { + Fruit fruit = find(tenantPrefix, name); + if (fruit == null) { + create(tenantPrefix, name); + return find(tenantPrefix, name); + } + return fruit; + } + +} diff --git a/hibernate-orm-multi-tenancy-quickstart/README.md b/hibernate-orm-multi-tenancy-quickstart/README.md deleted file mode 100644 index 699d5345d2..0000000000 --- a/hibernate-orm-multi-tenancy-quickstart/README.md +++ /dev/null @@ -1,121 +0,0 @@ -# Supporting Multi-Tenancy in Hibernate ORM - -This guide demonstrates how your Hibernate ORM application can support multitenancy so that you can serve multiple tenants from a single application. - -When serving multiple customers from a same application (e.g.: SaaS), each customer is a tenant with a separate database or a separate schema in the same database. - -## Requirements - -To compile and run this demo you will need: - -- JDK 17+ -- GraalVM - -In addition, you will need either a PostgreSQL database, or Docker to run one. - -### Configuring GraalVM and JDK 17+ - -Make sure that both the `GRAALVM_HOME` and `JAVA_HOME` environment variables have -been set, and that a JDK 17+ `java` command is on the path. - -See the [Building a Native Executable guide](https://quarkus.io/guides/building-native-image) -for help setting up your environment. - -## Building the demo - -Launch the Maven build on the checked out sources of this demo: - -> ./mvnw package - -## Running the demo - -### SCHEMA Multitenancy - -Approach that uses a single database (default datasource) with two schemas ('base' and 'mycompany') for storing the tenant's data. - -#### Prepare a single PostgreSQL instance - -Make sure you have a PostgreSQL instance running. To set up a PostgreSQL database with Docker: - -> docker run -it --rm=true --name quarkus_test -e POSTGRES_USER=quarkus_test -e POSTGRES_PASSWORD=quarkus_test -e POSTGRES_DB=quarkus_test -p 5432:5432 postgres:13.3 - -Connection properties for the Agroal datasource are defined in the standard Quarkus configuration file, [src/main/resources/application.properties](src/main/resources/application.properties). The database schemas are created using [Flyway](https://quarkus.io/guides/flyway) and the configuration can be found in -[src/main/resources/schema/V1.0.0__create_fruits.sql](src/main/resources/schema/V1.0.0__create_fruits.sql). - -#### Start Quarkus in development mode (Profile 'development') - -The Maven Quarkus plugin provides a development mode that supports live coding. To try this out: - -> ./mvnw quarkus:dev - -In this mode you can make changes to the code and have the changes immediately applied, by just refreshing your browser. - -#### Run Quarkus as native executable - -You can also create a native executable from this application without making any source code changes. A native executable removes the dependency on the JVM: -everything needed to run the application on the target platform is included in the executable, allowing the application to run with minimal resource overhead. - -Compiling a native executable takes a bit longer, as GraalVM performs additional steps to remove unnecessary codepaths. Use the `native` profile to compile a -native executable: - -> ./mvnw package -Pnative - -After getting a cup of coffee, you'll be able to run this executable directly: - -> ./target/hibernate-orm-quickstart-multi-tenancy-1.0.0-SNAPSHOT-runner - -### DATABASE Multitenancy - -Approach that uses a separate database (datasource 'base' and 'mycompany') for storing the tenant's data. - -#### Prepare two PostgreSQL instances - -Make sure you have two PostgreSQL instances running. To set up two PostgreSQL databases with Docker: - -> docker run -it --rm=true --name quarkus_test -p 127.0.0.1:5432:5432 -e POSTGRES_USER=quarkus_test -e POSTGRES_PASSWORD=quarkus_test -e POSTGRES_DB=quarkus_test postgres:13.3 - -> docker run -it --rm=true --name mycompany -p 127.0.0.1:5433:5432 -e POSTGRES_USER=mycompany -e POSTGRES_PASSWORD=mycompany -e POSTGRES_DB=mycompany postgres:13.3 - -The 'quarkus_test' database should be listening on port 5432 and the 'mycompany' on port 5433. - -Connection properties for the Agroal datasource are defined in the standard Quarkus configuration file, [src/main/resources/application.properties](src/main/resources/application.properties). -The database schemas are created using [Flyway](https://quarkus.io/guides/flyway) and the configuration can be found in -[src/main/resources/database/base/V1.0.0__create_fruits.sql](src/main/resources/database/base/V1.0.0__create_fruits.sql) and -[src/main/resources/database/mycompany/V1.0.0__create_fruits.sql](src/main/resources/database/mycompany/V1.0.0__create_fruits.sql). - -#### Start Quarkus in development mode (Profile 'database') - -The Maven Quarkus plugin provides a development mode that supports live coding. To try this out: - -> ./mvnw quarkus:dev -Dquarkus.profile=database - -In this mode you can make changes to the code and have the changes immediately applied, by just refreshing your browser. - -#### Run Quarkus as native executable - -You can also create a native executable from this application without making any source code changes. A native executable removes the dependency on the JVM: -everything needed to run the application on the target platform is included in the executable, allowing the application to run with minimal resource overhead. - -Compiling a native executable takes a bit longer, as GraalVM performs additional steps to remove unnecessary codepaths. Use the `native` profile to compile a native executable: - -> ./mvnw package -Pnative -Dquarkus.profile=database - -The `-Dquarkus.profile=database` parameter will create an executable that has the 'database' profile enabled. -This means all values in [application.properties](src/main/resources/application.properties) that are prefixed with `%database.` will be active. This enables the Hibernate multi-tenancy DATABASE approach for the example. - -After getting a cup of coffee, you'll be able to run this executable directly: - -> ./target/hibernate-orm-quickstart-multi-tenancy-1.0.0-SNAPSHOT-runner - - - -## See the demo in your browser - -Navigate to: - - - -You can easily select the tenant in the dropdown and in the backround the appropriate schema or database will be selected. - -Have fun, and join the team of contributors! - diff --git a/hibernate-orm-multi-tenancy-quickstart/docker-compose.yml b/hibernate-orm-multi-tenancy-quickstart/docker-compose.yml deleted file mode 100644 index 443f72fd77..0000000000 --- a/hibernate-orm-multi-tenancy-quickstart/docker-compose.yml +++ /dev/null @@ -1,32 +0,0 @@ -version: '3' - -services: - - database1: - image: postgres:13.3 - environment: - POSTGRES_USER: "quarkus_test" - POSTGRES_PASSWORD: "quarkus_test" - ports: - - 5432:5432 - - database2: - image: postgres:13.3 - environment: - POSTGRES_USER: "mycompany" - POSTGRES_PASSWORD: "mycompany" - ports: - - 5433:5432 - - quarkus: - image: quarkus/hibernate-orm-multi-tenancy - environment: - DB_HOST_TENANT_BASE: "database1" - DB_HOST_TENANT_MYCOMPANY: "database2" - DB_PORT_TENANT_BASE: "5432" - DB_PORT_TENANT_MYCOMPANY: "5432" - depends_on: - - database1 - - database2 - ports: - - 8080:8080 diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/resources/application.properties b/hibernate-orm-multi-tenancy-quickstart/src/main/resources/application.properties deleted file mode 100644 index 54ed92eaf6..0000000000 --- a/hibernate-orm-multi-tenancy-quickstart/src/main/resources/application.properties +++ /dev/null @@ -1,44 +0,0 @@ -# General settings -quarkus.log.level=INFO -%test.quarkus.log.level=INFO -%dev.quarkus.log.level=INFO -quarkus.native.native-image-xmx=5G - -# Hibernate ORM settings -quarkus.hibernate-orm.database.generation=none -quarkus.hibernate-orm.multitenant=SCHEMA -%database.quarkus.hibernate-orm.multitenant=DATABASE - -# SCHEMA Tenant Configuration (environment variable expansion is used to facilitate docker-compose setup) -quarkus.datasource.db-kind=postgresql -quarkus.datasource.username=quarkus_test -quarkus.datasource.password=quarkus_test -quarkus.datasource.jdbc.url=jdbc:postgresql://${DB_HOST_TENANT_BASE:localhost}:${DB_PORT_TENANT_BASE:5432}/quarkus_test -quarkus.datasource.jdbc.max-size=8 -quarkus.datasource.jdbc.min-size=2 -quarkus.flyway.schemas=base,mycompany -quarkus.flyway.locations=schema -quarkus.flyway.migrate-at-start=true -%database.quarkus.flyway.schemas= -%database.quarkus.flyway.locations=classpath:db/migration -%database.quarkus.flyway.migrate-at-start=false - -# DATABASE Tenant 'base' Configuration -%database.quarkus.datasource.base.db-kind=postgresql -%database.quarkus.datasource.base.username=quarkus_test -%database.quarkus.datasource.base.password=quarkus_test -%database.quarkus.datasource.base.jdbc.url=jdbc:postgresql://${DB_HOST_TENANT_BASE:localhost}:${DB_PORT_TENANT_BASE:5432}/quarkus_test -%database.quarkus.datasource.base.jdbc.max-size=8 -%database.quarkus.datasource.base.jdbc.min-size=2 -%database.quarkus.flyway.base.locations=classpath:database/base -%database.quarkus.flyway.base.migrate-at-start=true - -# DATABASE Tenant 'mycompany' Configuration -%database.quarkus.datasource.mycompany.db-kind=postgresql -%database.quarkus.datasource.mycompany.username=mycompany -%database.quarkus.datasource.mycompany.password=mycompany -%database.quarkus.datasource.mycompany.jdbc.url=jdbc:postgresql://${DB_HOST_TENANT_MYCOMPANY:localhost}:${DB_PORT_TENANT_MYCOMPANY:5433}/mycompany -%database.quarkus.datasource.mycompany.jdbc.max-size=8 -%database.quarkus.datasource.mycompany.jdbc.min-size=2 -%database.quarkus.flyway.mycompany.locations=classpath:database/mycompany -%database.quarkus.flyway.mycompany.migrate-at-start=true diff --git a/hibernate-orm-multi-tenancy-quickstart/src/test/java/org/acme/hibernate/orm/IdeTestApp.java b/hibernate-orm-multi-tenancy-quickstart/src/test/java/org/acme/hibernate/orm/IdeTestApp.java deleted file mode 100644 index 12f0d8570f..0000000000 --- a/hibernate-orm-multi-tenancy-quickstart/src/test/java/org/acme/hibernate/orm/IdeTestApp.java +++ /dev/null @@ -1,26 +0,0 @@ -package org.acme.hibernate.orm; - -import java.util.concurrent.TimeUnit; - -import org.junit.jupiter.api.Disabled; -import org.junit.jupiter.api.Test; - -import io.quarkus.test.junit.QuarkusTest; - -/** - * Workaround to allow launching the Quarkus application inside the IDE. - * - * @see https://github.com/quarkusio/quarkus/issues/2143 - */ -@Disabled("You can enable this pseudo test to run the app in your IDE") -@QuarkusTest -public class IdeTestApp { - - @Test - public void startApp() throws Exception { - while (true) { - TimeUnit.SECONDS.sleep(1); - } - } - -} diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/.dockerignore b/hibernate-orm-multi-tenancy-schema-quickstart/.dockerignore new file mode 100644 index 0000000000..ab14769c34 --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/.dockerignore @@ -0,0 +1,5 @@ +* +!target/*-runner +!target/*-runner.jar +!target/lib/* +!target/quarkus-app/ diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/.gitignore b/hibernate-orm-multi-tenancy-schema-quickstart/.gitignore new file mode 100644 index 0000000000..087a18358f --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/.gitignore @@ -0,0 +1,35 @@ +# Eclipse +.project +.classpath +.settings/ +bin/ + +# IntelliJ +.idea +*.ipr +*.iml +*.iws + +# NetBeans +nb-configuration.xml + +# Visual Studio Code +.vscode + +# OSX +.DS_Store + +# Vim +*.swp +*.swo + +# patch +*.orig +*.rej + +# Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +release.properties \ No newline at end of file diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/.mvn/wrapper/maven-wrapper.jar b/hibernate-orm-multi-tenancy-schema-quickstart/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000000..7967f30dd1 Binary files /dev/null and b/hibernate-orm-multi-tenancy-schema-quickstart/.mvn/wrapper/maven-wrapper.jar differ diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/.mvn/wrapper/maven-wrapper.properties b/hibernate-orm-multi-tenancy-schema-quickstart/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000000..9548abd8e8 --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +wrapperVersion=3.3.2 +distributionType=bin +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/README.md b/hibernate-orm-multi-tenancy-schema-quickstart/README.md new file mode 100644 index 0000000000..235314acae --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/README.md @@ -0,0 +1,62 @@ +# Supporting Multi-Tenancy in Hibernate ORM (schema approach) + +This guide demonstrates how your Hibernate ORM application can support multitenancy so that you can serve multiple tenants from a single application. + +When serving multiple customers from a same application (e.g.: SaaS), each customer is a tenant with a separate schema in the same database. + +For the database per tenant approach see [Database Quickstart](../hibernate-orm-multi-tenancy-database-quickstart/README.md). + +## Requirements + +To compile and run this demo you will need: + +- JDK 17+ +- GraalVM + +In addition, you will need either a PostgreSQL database, or Docker to run one. + +### Configuring GraalVM and JDK 17+ + +Make sure that both the `GRAALVM_HOME` and `JAVA_HOME` environment variables have +been set, and that a JDK 17+ `java` command is on the path. + +See the [Building a Native Executable guide](https://quarkus.io/guides/building-native-image) +for help setting up your environment. + +## Building the demo + +Launch the Maven build on the checked out sources of this demo: + +> ./mvnw package +## Running the demo + +### Start Quarkus in development mode (Profile 'development') + +The Maven Quarkus plugin provides a development mode that supports live coding. To try this out: + +> ./mvnw quarkus:dev +In this mode you can make changes to the code and have the changes immediately applied, by just refreshing your browser. + +### Run Quarkus as native executable + +You can also create a native executable from this application without making any source code changes. A native executable removes the dependency on the JVM: +everything needed to run the application on the target platform is included in the executable, allowing the application to run with minimal resource overhead. + +Compiling a native executable takes a bit longer, as GraalVM performs additional steps to remove unnecessary codepaths. Use the `native` profile to compile a +native executable: + +> ./mvnw package -Pnative + +After getting a cup of coffee, you'll be able to run this executable directly: + +> ./target/hibernate-orm-schema-multi-tenancy-quickstart-1.0.0-SNAPSHOT-runner + +## See the demo in your browser + +Navigate to: + + + +You can easily select the tenant in the dropdown and in the background the appropriate schema will be selected. + +Have fun, and join the team of contributors! \ No newline at end of file diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/mvnw b/hibernate-orm-multi-tenancy-schema-quickstart/mvnw new file mode 100755 index 0000000000..5e9618cac2 --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/mvnw @@ -0,0 +1,332 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.2 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ]; then + + if [ -f /usr/local/etc/mavenrc ]; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ]; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ]; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false +darwin=false +mingw=false +case "$(uname)" in +CYGWIN*) cygwin=true ;; +MINGW*) mingw=true ;; +Darwin*) + darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)" + export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home" + export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ]; then + if [ -r /etc/gentoo-release ]; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin; then + [ -n "$JAVA_HOME" ] \ + && JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] \ + && CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] \ + && JAVA_HOME="$( + cd "$JAVA_HOME" || ( + echo "cannot cd into $JAVA_HOME." >&2 + exit 1 + ) + pwd + )" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "$javaExecutable" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin; then + javaHome="$(dirname "$javaExecutable")" + javaExecutable="$(cd "$javaHome" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "$javaExecutable")" + fi + javaHome="$(dirname "$javaExecutable")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ]; then + if [ -n "$JAVA_HOME" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$( + \unset -f command 2>/dev/null + \command -v java + )" + fi +fi + +if [ ! -x "$JAVACMD" ]; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ]; then + echo "Warning: JAVA_HOME environment variable is not set." >&2 +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ]; then + echo "Path not specified to find_maven_basedir" >&2 + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ]; do + if [ -d "$wdir"/.mvn ]; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$( + cd "$wdir/.." || exit 1 + pwd + ) + fi + # end of workaround + done + printf '%s' "$( + cd "$basedir" || exit 1 + pwd + )" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' <"$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1 +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} +export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in wrapperUrl) + wrapperUrl="$safeValue" + break + ;; + esac + done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget >/dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl >/dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in wrapperSha256Sum) + wrapperSha256Sum=$value + break + ;; + esac +done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum >/dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c >/dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c >/dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] \ + && JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] \ + && CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] \ + && MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/mvnw.cmd b/hibernate-orm-multi-tenancy-schema-quickstart/mvnw.cmd new file mode 100644 index 0000000000..4136715f08 --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/mvnw.cmd @@ -0,0 +1,206 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.2 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. >&2 +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. >&2 +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. >&2 +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. >&2 +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash;"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Error 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Error 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Error 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/hibernate-orm-multi-tenancy-quickstart/pom.xml b/hibernate-orm-multi-tenancy-schema-quickstart/pom.xml similarity index 55% rename from hibernate-orm-multi-tenancy-quickstart/pom.xml rename to hibernate-orm-multi-tenancy-schema-quickstart/pom.xml index d01fb12b56..56131f5fa1 100644 --- a/hibernate-orm-multi-tenancy-quickstart/pom.xml +++ b/hibernate-orm-multi-tenancy-schema-quickstart/pom.xml @@ -4,7 +4,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 org.acme - hibernate-orm-multi-tenancy-quickstart + hibernate-orm-multi-tenancy-schema-quickstart 1.0.0-SNAPSHOT @@ -13,7 +13,6 @@ 999-SNAPSHOT 3.1.2 3.11.0 - 0.28.0 UTF-8 UTF-8 @@ -110,62 +109,6 @@ - - - io.fabric8 - docker-maven-plugin - ${docker-plugin.version} - - ${skipTests} - - - postgres:13.3 - quarkus_test - - - quarkus_test - quarkus_test - quarkus_test - - - 5432:5432 - - - quarkus_test: - default - cyan - - - - mapped - - 5432 - - - - - - - - - - - docker-start - test-compile - - stop - start - - - - docker-stop - post-integration-test - - stop - - - - @@ -207,50 +150,5 @@ - - eclipse - - - - m2e.version - - - - - - - - org.eclipse.m2e - lifecycle-mapping - 1.0.0 - - - - - - io.fabric8 - - docker-maven-plugin - - - [0.28.0,) - - - start - stop - - - - - - - - - - - - - - diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.jvm b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.jvm similarity index 98% rename from hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.jvm rename to hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.jvm index 5daf9132f8..a0436ebbe4 100644 --- a/hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.jvm +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.jvm @@ -7,11 +7,11 @@ # # Then, build the image with: # -# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/hibernate-orm-multi-tenancy-quickstart-jvm . +# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/hibernate-orm-multi-tenancy-schema-quickstart-jvm . # # Then run the container using: # -# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-quickstart-jvm +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-schema-quickstart-jvm # # If you want to include the debug port into your docker image # you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. @@ -20,7 +20,7 @@ # # Then run the container using : # -# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-quickstart-jvm +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-schema-quickstart-jvm # # This image uses the `run-java.sh` script to run the application. # This scripts computes the command line to execute your Java application, and diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.legacy-jar b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.legacy-jar similarity index 97% rename from hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.legacy-jar rename to hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.legacy-jar index 1f356f5af7..eb81c90f34 100644 --- a/hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.legacy-jar +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.legacy-jar @@ -7,11 +7,11 @@ # # Then, build the image with: # -# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/hibernate-orm-multi-tenancy-quickstart-legacy-jar . +# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/hibernate-orm-multi-tenancy-schema-quickstart-legacy-jar . # # Then run the container using: # -# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-quickstart-legacy-jar +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-schema-quickstart-legacy-jar # # If you want to include the debug port into your docker image # you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. @@ -20,7 +20,7 @@ # # Then run the container using : # -# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-quickstart-legacy-jar +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-schema-quickstart-legacy-jar # # This image uses the `run-java.sh` script to run the application. # This scripts computes the command line to execute your Java application, and diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.native b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.native similarity index 90% rename from hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.native rename to hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.native index b36f104a0f..a49258c19f 100644 --- a/hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.native +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.native @@ -7,11 +7,11 @@ # # Then, build the image with: # -# docker build -f src/main/docker/Dockerfile.native -t quarkus/hibernate-orm-multi-tenancy-quickstart . +# docker build -f src/main/docker/Dockerfile.native -t quarkus/hibernate-orm-multi-tenancy-schema-quickstart . # # Then run the container using: # -# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-quickstart +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-schema-quickstart # ### FROM registry.access.redhat.com/ubi8/ubi-minimal:8.9 diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.native-micro b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.native-micro similarity index 92% rename from hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.native-micro rename to hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.native-micro index 989e30aa6f..9efc00e52c 100644 --- a/hibernate-orm-multi-tenancy-quickstart/src/main/docker/Dockerfile.native-micro +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/docker/Dockerfile.native-micro @@ -10,11 +10,11 @@ # # Then, build the image with: # -# docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/hibernate-orm-multi-tenancy-quickstart . +# docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/hibernate-orm-multi-tenancy-schema-quickstart . # # Then run the container using: # -# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-quickstart +# docker run -i --rm -p 8080:8080 quarkus/hibernate-orm-multi-tenancy-schema-quickstart # ### FROM quay.io/quarkus/quarkus-micro-image:2.0 diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java new file mode 100644 index 0000000000..a4129b3fb9 --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/CustomTenantResolver.java @@ -0,0 +1,40 @@ +package org.acme.hibernate.orm; + +import org.jboss.logging.Logger; + +import io.quarkus.arc.Unremovable; +import io.quarkus.hibernate.orm.PersistenceUnitExtension; +import io.quarkus.hibernate.orm.runtime.tenant.TenantResolver; +import io.vertx.ext.web.RoutingContext; +import jakarta.enterprise.context.RequestScoped; +import jakarta.inject.Inject; + +@RequestScoped +@Unremovable +@PersistenceUnitExtension +public class CustomTenantResolver implements TenantResolver { + + private static final Logger LOG = Logger.getLogger(CustomTenantResolver.class); + + @Inject + RoutingContext context; + + @Override + public String getDefaultTenantId() { + return "base"; + } + + @Override + public String resolveTenantId() { + String path = context.request().path(); + final String tenantId; + if (path.startsWith("/mycompany")) { + tenantId = "mycompany"; + } else { + tenantId = getDefaultTenantId(); + } + LOG.debugv("TenantId = {0}", tenantId); + return tenantId; + } + +} diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/Fruit.java b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/Fruit.java new file mode 100644 index 0000000000..02192753db --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/Fruit.java @@ -0,0 +1,48 @@ +package org.acme.hibernate.orm; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.Id; +import jakarta.persistence.NamedQuery; +import jakarta.persistence.SequenceGenerator; +import jakarta.persistence.Table; + +@Entity +@Table(name = "known_fruits") +@NamedQuery(name = "Fruits.findAll", query = "SELECT f FROM Fruit f ORDER BY f.name") +@NamedQuery(name = "Fruits.findByName", query = "SELECT f FROM Fruit f WHERE f.name=:name") +public class Fruit { + + @Id + @SequenceGenerator(name = "fruitsSequence", sequenceName = "known_fruits_id_seq", allocationSize = 1, initialValue = 10) + @GeneratedValue(generator = "fruitsSequence") + private Integer id; + + @Column(length = 40, unique = true) + private String name; + + public Fruit() { + } + + public Fruit(String name) { + this.name = name; + } + + public Integer getId() { + return id; + } + + public void setId(Integer id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + +} diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/FruitResource.java b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/FruitResource.java new file mode 100644 index 0000000000..dfc659e3e6 --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/java/org/acme/hibernate/orm/FruitResource.java @@ -0,0 +1,205 @@ +package org.acme.hibernate.orm; + +import java.util.List; + +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.inject.Inject; +import jakarta.persistence.EntityManager; +import jakarta.transaction.Transactional; +import jakarta.ws.rs.Consumes; +import jakarta.ws.rs.DELETE; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.POST; +import jakarta.ws.rs.PUT; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; +import jakarta.ws.rs.WebApplicationException; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.ext.ExceptionMapper; +import jakarta.ws.rs.ext.Provider; + +import org.jboss.logging.Logger; +import org.jboss.resteasy.reactive.RestQuery; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ObjectNode; + +@ApplicationScoped +@Produces("application/json") +@Consumes("application/json") +@Path("/") +public class FruitResource { + + private static final Logger LOGGER = Logger.getLogger(FruitResource.class.getName()); + + @Inject + EntityManager entityManager; + + @GET + @Path("fruits") + public Fruit[] getDefault() { + return get(); + } + + @GET + @Path("{tenant}/fruits") + public Fruit[] getTenant() { + return get(); + } + + private Fruit[] get() { + return entityManager.createNamedQuery("Fruits.findAll", Fruit.class) + .getResultList().toArray(new Fruit[0]); + } + + @GET + @Path("fruits/{id}") + public Fruit getSingleDefault(Integer id) { + return findById(id); + } + + @GET + @Path("{tenant}/fruits/{id}") + public Fruit getSingleTenant(Integer id) { + return findById(id); + } + + private Fruit findById(Integer id) { + Fruit entity = entityManager.find(Fruit.class, id); + if (entity == null) { + throw new WebApplicationException("Fruit with id of " + id + " does not exist.", 404); + } + return entity; + } + + @POST + @Transactional + @Path("fruits") + public Response createDefault(Fruit fruit) { + return create(fruit); + } + + @POST + @Transactional + @Path("{tenant}/fruits") + public Response createTenant(Fruit fruit) { + return create(fruit); + } + + private Response create(Fruit fruit) { + if (fruit.getId() != null) { + throw new WebApplicationException("Id was invalidly set on request.", 422); + } + LOGGER.debugv("Create {0}", fruit.getName()); + entityManager.persist(fruit); + return Response.ok(fruit).status(201).build(); + } + + @PUT + @Path("fruits/{id}") + @Transactional + public Fruit updateDefault(Integer id, Fruit fruit) { + return update(id, fruit); + } + + @PUT + @Path("{tenant}/fruits/{id}") + @Transactional + public Fruit updateTenant(Integer id, Fruit fruit) { + return update(id, fruit); + } + + public Fruit update(Integer id, Fruit fruit) { + if (fruit.getName() == null) { + throw new WebApplicationException("Fruit Name was not set on request.", 422); + } + + Fruit entity = entityManager.find(Fruit.class, id); + if (entity == null) { + throw new WebApplicationException("Fruit with id of " + id + " does not exist.", 404); + } + entity.setName(fruit.getName()); + + LOGGER.debugv("Update #{0} {1}", fruit.getId(), fruit.getName()); + + return entity; + } + + @DELETE + @Path("fruits/{id}") + @Transactional + public Response deleteDefault(Integer id) { + return delete(id); + } + + @DELETE + @Path("{tenant}/fruits/{id}") + @Transactional + public Response deleteTenant(Integer id) { + return delete(id); + } + + public Response delete(Integer id) { + Fruit fruit = entityManager.getReference(Fruit.class, id); + if (fruit == null) { + throw new WebApplicationException("Fruit with id of " + id + " does not exist.", 404); + } + LOGGER.debugv("Delete #{0} {1}", fruit.getId(), fruit.getName()); + entityManager.remove(fruit); + return Response.status(204).build(); + } + + @GET + @Path("fruitsFindBy") + public Response findByDefault(@RestQuery String type, @RestQuery String value) { + return findBy(type, value); + } + + @GET + @Path("{tenant}/fruitsFindBy") + public Response findByTenant(@RestQuery String type, @RestQuery String value) { + return findBy(type, value); + } + + private Response findBy(String type, String value) { + if (!"name".equalsIgnoreCase(type)) { + throw new IllegalArgumentException("Currently only 'fruitsFindBy?type=name' is supported"); + } + List list = entityManager.createNamedQuery("Fruits.findByName", Fruit.class).setParameter("name", value).getResultList(); + if (list.size() == 0) { + return Response.status(404).build(); + } + Fruit fruit = list.get(0); + return Response.status(200).entity(fruit).build(); + } + + @Provider + public static class ErrorMapper implements ExceptionMapper { + + @Inject + ObjectMapper objectMapper; + + @Override + public Response toResponse(Exception exception) { + LOGGER.error("Failed to handle request", exception); + + int code = 500; + if (exception instanceof WebApplicationException) { + code = ((WebApplicationException) exception).getResponse().getStatus(); + } + + ObjectNode exceptionJson = objectMapper.createObjectNode(); + exceptionJson.put("exceptionType", exception.getClass().getName()); + exceptionJson.put("code", code); + + if (exception.getMessage() != null) { + exceptionJson.put("error", exception.getMessage()); + } + + return Response.status(code) + .entity(exceptionJson) + .build(); + } + + } +} diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/META-INF/resources/favicon.ico b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/META-INF/resources/favicon.ico new file mode 100644 index 0000000000..b4ef4208a6 Binary files /dev/null and b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/META-INF/resources/favicon.ico differ diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/META-INF/resources/index.html b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/META-INF/resources/index.html new file mode 100644 index 0000000000..199fefb775 --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/META-INF/resources/index.html @@ -0,0 +1,176 @@ + + + + + Multitenancy Hibernate ORM - Quarkus + + + + + + + + +
+

Multitenancy Hibernate ORM - Quarkus

+

This application demonstrates how a Quarkus application implements a multi tenant CRUD endpoint to manage fruits. + This management interface invokes the CRUD service endpoint, which interacts with a database using JPA and several other well known libraries. + The tenant you select below using the dropdown will be passed to the application as first part of the URL path. +

+

Behind the scenes, we have: +

    +
  • Hibernate ORM taking care of all CRUD operations
    • +
  • A custom tenant resolver that reads the tenant key from the URL path
    • +
  • RESTEasy powering the REST API
    • +
  • ArC, a CDI based dependency injection framework
    • +
  • the Narayana Transaction Manager coordinating all transactions
    • +
  • Agroal, the high performance Datasource implementation
    • +
  • Infinispan used as Hibernate 2nd level caching: enabled on both entities and queries
    • +
  • The Undertow webserver
    • +
  • Some magic bytecode generation plugged in the compiler...
    • +
+

+ +

Select a tenant

+ + +

Add/Edit a fruit

+
+
+
+
+ +
+ +

Fruit List

+
+
Name
+
+
+
{{ fruit.name }}
+
Edit Remove +
+
+
+ + + diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/application.properties b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/application.properties new file mode 100644 index 0000000000..9f40056fef --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/application.properties @@ -0,0 +1,12 @@ +quarkus.hibernate-orm.database.generation=none + +quarkus.hibernate-orm.multitenant=SCHEMA + +quarkus.datasource.db-kind=postgresql +quarkus.datasource.username=quarkus_test +quarkus.datasource.password=quarkus_test +%prod.quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/quarkus_test + +quarkus.flyway.schemas=base,mycompany +quarkus.flyway.locations=classpath:schema +quarkus.flyway.migrate-at-start=true \ No newline at end of file diff --git a/hibernate-orm-multi-tenancy-quickstart/src/main/resources/schema/V1.0.0__create_fruits.sql b/hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/schema/V1.0.0__create_fruits.sql similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/main/resources/schema/V1.0.0__create_fruits.sql rename to hibernate-orm-multi-tenancy-schema-quickstart/src/main/resources/schema/V1.0.0__create_fruits.sql diff --git a/hibernate-orm-multi-tenancy-schema-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointIT.java b/hibernate-orm-multi-tenancy-schema-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointIT.java new file mode 100644 index 0000000000..539aa0f061 --- /dev/null +++ b/hibernate-orm-multi-tenancy-schema-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointIT.java @@ -0,0 +1,10 @@ +package org.acme.hibernate.orm; + +import io.quarkus.test.junit.QuarkusIntegrationTest; + +@QuarkusIntegrationTest +public class FruitsEndpointIT extends FruitsEndpointTest { + + // Runs the same tests as the parent class + +} diff --git a/hibernate-orm-multi-tenancy-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointTest.java b/hibernate-orm-multi-tenancy-schema-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointTest.java similarity index 100% rename from hibernate-orm-multi-tenancy-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointTest.java rename to hibernate-orm-multi-tenancy-schema-quickstart/src/test/java/org/acme/hibernate/orm/FruitsEndpointTest.java diff --git a/pom.xml b/pom.xml index 8aaf678631..4d43cf5e1b 100644 --- a/pom.xml +++ b/pom.xml @@ -43,7 +43,8 @@ hibernate-orm-panache-quickstart hibernate-orm-panache-kotlin-quickstart hibernate-reactive-panache-quickstart - hibernate-orm-multi-tenancy-quickstart + hibernate-orm-multi-tenancy-database-quickstart + hibernate-orm-multi-tenancy-schema-quickstart hibernate-search-orm-elasticsearch-quickstart hibernate-search-standalone-elasticsearch-quickstart hibernate-orm-rest-data-panache-quickstart