├── .gitignore
├── .mvn
└── wrapper
│ ├── maven-wrapper.jar
│ └── maven-wrapper.properties
├── README.md
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
├── main
├── java
│ └── com
│ │ └── ramsrib
│ │ └── springbootmultitenant2
│ │ ├── Application.java
│ │ ├── controller
│ │ └── UserController.java
│ │ ├── filter
│ │ └── TenantFilter.java
│ │ ├── model
│ │ ├── TenantSupport.java
│ │ └── User.java
│ │ ├── repository
│ │ └── UserRepository.java
│ │ ├── service
│ │ ├── UserService.java
│ │ └── aspect
│ │ │ └── UserServiceAspect.java
│ │ └── tenant
│ │ └── TenantContext.java
└── resources
│ └── application.properties
└── test
└── java
└── com
└── ramsrib
└── springbootmultitenant2
└── ApplicationTests.java
/.gitignore:
--------------------------------------------------------------------------------
1 | target/
2 | !.mvn/wrapper/maven-wrapper.jar
3 |
4 | ### STS ###
5 | .apt_generated
6 | .classpath
7 | .factorypath
8 | .project
9 | .settings
10 | .springBeans
11 |
12 | ### IntelliJ IDEA ###
13 | .idea
14 | *.iws
15 | *.iml
16 | *.ipr
17 |
18 | ### NetBeans ###
19 | nbproject/private/
20 | build/
21 | nbbuild/
22 | dist/
23 | nbdist/
24 | .nb-gradle/
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ramsrib/multi-tenant-app-demo/58e497069c542aab428300496d9f6d50dce76e35/.mvn/wrapper/maven-wrapper.jar
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.0/apache-maven-3.5.0-bin.zip
2 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | README
2 | ======
3 |
4 | *Sample Application to demonstrate Multi-tenancy based on discriminator field using Spring Boot & Hibernate.*
5 |
6 | Since hibernate (5.x) has some issues (refer the link below) in supporting the 'Discriminator' based multi-tenancy strategy. This following workaround will help to achieve the same.
7 |
8 | Approach:
9 |
10 | * Uses hibernate filter to limit the query results based on tenant.
11 | * Uses hibernate interceptors to enforce tenant details during creating/updating entities.
12 | * Uses Spring AOP (AspectJ) to set the filter parameters.
13 |
14 |
15 | Explanation:
16 |
17 | * Each request goes thru a custom servlet filter which checks for `X-TenantID` http header and set's it in the ThreadLocal variable using `TenantContext` class. If http header is not present in request, it'll be rejected.
18 | * Controller routes the request to Service class and the Spring AOP (`UserServiceAspect` class) intercepts the service call and set's the hibernate tenant filter.
19 | * All the service method has to be annotated with `@Transactional` for `UserServiceAspect` to work.
20 | * Above method works only for read queries, for write queries, we have to use hibernate interceptors.
21 | * Custom Entity interceptor (using `EmptyInterceptor`) class which sets the tenantId value during the save/delete/flush-dirty entity events.
22 | * Entity class should implement `TenantSupport` interface for the Entity interceptor to work.
23 |
24 |
25 |
26 | Refer:
27 | * https://hibernate.atlassian.net/browse/HHH-6054
28 | * https://docs.jboss.org/hibernate/orm/5.2/userguide/html_single/Hibernate_User_Guide.html#multitenacy
29 | * https://docs.jboss.org/hibernate/orm/5.2/userguide/html_single/Hibernate_User_Guide.html#mapping-column-filter
30 | * https://docs.jboss.org/hibernate/orm/5.2/userguide/html_single/Hibernate_User_Guide.html#events
31 |
--------------------------------------------------------------------------------
/mvnw:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ----------------------------------------------------------------------------
3 | # Licensed to the Apache Software Foundation (ASF) under one
4 | # or more contributor license agreements. See the NOTICE file
5 | # distributed with this work for additional information
6 | # regarding copyright ownership. The ASF licenses this file
7 | # to you under the Apache License, Version 2.0 (the
8 | # "License"); you may not use this file except in compliance
9 | # with the License. You may obtain a copy of the License at
10 | #
11 | # http://www.apache.org/licenses/LICENSE-2.0
12 | #
13 | # Unless required by applicable law or agreed to in writing,
14 | # software distributed under the License is distributed on an
15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | # KIND, either express or implied. See the License for the
17 | # specific language governing permissions and limitations
18 | # under the License.
19 | # ----------------------------------------------------------------------------
20 |
21 | # ----------------------------------------------------------------------------
22 | # Maven2 Start Up Batch script
23 | #
24 | # Required ENV vars:
25 | # ------------------
26 | # JAVA_HOME - location of a JDK home dir
27 | #
28 | # Optional ENV vars
29 | # -----------------
30 | # M2_HOME - location of maven2's installed home dir
31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven
32 | # e.g. to debug Maven itself, use
33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files
35 | # ----------------------------------------------------------------------------
36 |
37 | if [ -z "$MAVEN_SKIP_RC" ] ; then
38 |
39 | if [ -f /etc/mavenrc ] ; then
40 | . /etc/mavenrc
41 | fi
42 |
43 | if [ -f "$HOME/.mavenrc" ] ; then
44 | . "$HOME/.mavenrc"
45 | fi
46 |
47 | fi
48 |
49 | # OS specific support. $var _must_ be set to either true or false.
50 | cygwin=false;
51 | darwin=false;
52 | mingw=false
53 | case "`uname`" in
54 | CYGWIN*) cygwin=true ;;
55 | MINGW*) mingw=true;;
56 | Darwin*) darwin=true
57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
59 | if [ -z "$JAVA_HOME" ]; then
60 | if [ -x "/usr/libexec/java_home" ]; then
61 | export JAVA_HOME="`/usr/libexec/java_home`"
62 | else
63 | export JAVA_HOME="/Library/Java/Home"
64 | fi
65 | fi
66 | ;;
67 | esac
68 |
69 | if [ -z "$JAVA_HOME" ] ; then
70 | if [ -r /etc/gentoo-release ] ; then
71 | JAVA_HOME=`java-config --jre-home`
72 | fi
73 | fi
74 |
75 | if [ -z "$M2_HOME" ] ; then
76 | ## resolve links - $0 may be a link to maven's home
77 | PRG="$0"
78 |
79 | # need this for relative symlinks
80 | while [ -h "$PRG" ] ; do
81 | ls=`ls -ld "$PRG"`
82 | link=`expr "$ls" : '.*-> \(.*\)$'`
83 | if expr "$link" : '/.*' > /dev/null; then
84 | PRG="$link"
85 | else
86 | PRG="`dirname "$PRG"`/$link"
87 | fi
88 | done
89 |
90 | saveddir=`pwd`
91 |
92 | M2_HOME=`dirname "$PRG"`/..
93 |
94 | # make it fully qualified
95 | M2_HOME=`cd "$M2_HOME" && pwd`
96 |
97 | cd "$saveddir"
98 | # echo Using m2 at $M2_HOME
99 | fi
100 |
101 | # For Cygwin, ensure paths are in UNIX format before anything is touched
102 | if $cygwin ; then
103 | [ -n "$M2_HOME" ] &&
104 | M2_HOME=`cygpath --unix "$M2_HOME"`
105 | [ -n "$JAVA_HOME" ] &&
106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
107 | [ -n "$CLASSPATH" ] &&
108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
109 | fi
110 |
111 | # For Migwn, ensure paths are in UNIX format before anything is touched
112 | if $mingw ; then
113 | [ -n "$M2_HOME" ] &&
114 | M2_HOME="`(cd "$M2_HOME"; pwd)`"
115 | [ -n "$JAVA_HOME" ] &&
116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
117 | # TODO classpath?
118 | fi
119 |
120 | if [ -z "$JAVA_HOME" ]; then
121 | javaExecutable="`which javac`"
122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
123 | # readlink(1) is not available as standard on Solaris 10.
124 | readLink=`which readlink`
125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
126 | if $darwin ; then
127 | javaHome="`dirname \"$javaExecutable\"`"
128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
129 | else
130 | javaExecutable="`readlink -f \"$javaExecutable\"`"
131 | fi
132 | javaHome="`dirname \"$javaExecutable\"`"
133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'`
134 | JAVA_HOME="$javaHome"
135 | export JAVA_HOME
136 | fi
137 | fi
138 | fi
139 |
140 | if [ -z "$JAVACMD" ] ; then
141 | if [ -n "$JAVA_HOME" ] ; then
142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
143 | # IBM's JDK on AIX uses strange locations for the executables
144 | JAVACMD="$JAVA_HOME/jre/sh/java"
145 | else
146 | JAVACMD="$JAVA_HOME/bin/java"
147 | fi
148 | else
149 | JAVACMD="`which java`"
150 | fi
151 | fi
152 |
153 | if [ ! -x "$JAVACMD" ] ; then
154 | echo "Error: JAVA_HOME is not defined correctly." >&2
155 | echo " We cannot execute $JAVACMD" >&2
156 | exit 1
157 | fi
158 |
159 | if [ -z "$JAVA_HOME" ] ; then
160 | echo "Warning: JAVA_HOME environment variable is not set."
161 | fi
162 |
163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
164 |
165 | # traverses directory structure from process work directory to filesystem root
166 | # first directory with .mvn subdirectory is considered project base directory
167 | find_maven_basedir() {
168 |
169 | if [ -z "$1" ]
170 | then
171 | echo "Path not specified to find_maven_basedir"
172 | return 1
173 | fi
174 |
175 | basedir="$1"
176 | wdir="$1"
177 | while [ "$wdir" != '/' ] ; do
178 | if [ -d "$wdir"/.mvn ] ; then
179 | basedir=$wdir
180 | break
181 | fi
182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc)
183 | if [ -d "${wdir}" ]; then
184 | wdir=`cd "$wdir/.."; pwd`
185 | fi
186 | # end of workaround
187 | done
188 | echo "${basedir}"
189 | }
190 |
191 | # concatenates all lines of a file
192 | concat_lines() {
193 | if [ -f "$1" ]; then
194 | echo "$(tr -s '\n' ' ' < "$1")"
195 | fi
196 | }
197 |
198 | BASE_DIR=`find_maven_basedir "$(pwd)"`
199 | if [ -z "$BASE_DIR" ]; then
200 | exit 1;
201 | fi
202 |
203 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
204 | echo $MAVEN_PROJECTBASEDIR
205 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
206 |
207 | # For Cygwin, switch paths to Windows format before running java
208 | if $cygwin; then
209 | [ -n "$M2_HOME" ] &&
210 | M2_HOME=`cygpath --path --windows "$M2_HOME"`
211 | [ -n "$JAVA_HOME" ] &&
212 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
213 | [ -n "$CLASSPATH" ] &&
214 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
215 | [ -n "$MAVEN_PROJECTBASEDIR" ] &&
216 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
217 | fi
218 |
219 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
220 |
221 | exec "$JAVACMD" \
222 | $MAVEN_OPTS \
223 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
224 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
225 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
226 |
--------------------------------------------------------------------------------
/mvnw.cmd:
--------------------------------------------------------------------------------
1 | @REM ----------------------------------------------------------------------------
2 | @REM Licensed to the Apache Software Foundation (ASF) under one
3 | @REM or more contributor license agreements. See the NOTICE file
4 | @REM distributed with this work for additional information
5 | @REM regarding copyright ownership. The ASF licenses this file
6 | @REM to you under the Apache License, Version 2.0 (the
7 | @REM "License"); you may not use this file except in compliance
8 | @REM with the License. You may obtain a copy of the License at
9 | @REM
10 | @REM http://www.apache.org/licenses/LICENSE-2.0
11 | @REM
12 | @REM Unless required by applicable law or agreed to in writing,
13 | @REM software distributed under the License is distributed on an
14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | @REM KIND, either express or implied. See the License for the
16 | @REM specific language governing permissions and limitations
17 | @REM under the License.
18 | @REM ----------------------------------------------------------------------------
19 |
20 | @REM ----------------------------------------------------------------------------
21 | @REM Maven2 Start Up Batch script
22 | @REM
23 | @REM Required ENV vars:
24 | @REM JAVA_HOME - location of a JDK home dir
25 | @REM
26 | @REM Optional ENV vars
27 | @REM M2_HOME - location of maven2's installed home dir
28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending
30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
31 | @REM e.g. to debug Maven itself, use
32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
34 | @REM ----------------------------------------------------------------------------
35 |
36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
37 | @echo off
38 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on'
39 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
40 |
41 | @REM set %HOME% to equivalent of $HOME
42 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
43 |
44 | @REM Execute a user defined script before this one
45 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
46 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending
47 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
48 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
49 | :skipRcPre
50 |
51 | @setlocal
52 |
53 | set ERROR_CODE=0
54 |
55 | @REM To isolate internal variables from possible post scripts, we use another setlocal
56 | @setlocal
57 |
58 | @REM ==== START VALIDATION ====
59 | if not "%JAVA_HOME%" == "" goto OkJHome
60 |
61 | echo.
62 | echo Error: JAVA_HOME not found in your environment. >&2
63 | echo Please set the JAVA_HOME variable in your environment to match the >&2
64 | echo location of your Java installation. >&2
65 | echo.
66 | goto error
67 |
68 | :OkJHome
69 | if exist "%JAVA_HOME%\bin\java.exe" goto init
70 |
71 | echo.
72 | echo Error: JAVA_HOME is set to an invalid directory. >&2
73 | echo JAVA_HOME = "%JAVA_HOME%" >&2
74 | echo Please set the JAVA_HOME variable in your environment to match the >&2
75 | echo location of your Java installation. >&2
76 | echo.
77 | goto error
78 |
79 | @REM ==== END VALIDATION ====
80 |
81 | :init
82 |
83 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
84 | @REM Fallback to current working directory if not found.
85 |
86 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
87 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
88 |
89 | set EXEC_DIR=%CD%
90 | set WDIR=%EXEC_DIR%
91 | :findBaseDir
92 | IF EXIST "%WDIR%"\.mvn goto baseDirFound
93 | cd ..
94 | IF "%WDIR%"=="%CD%" goto baseDirNotFound
95 | set WDIR=%CD%
96 | goto findBaseDir
97 |
98 | :baseDirFound
99 | set MAVEN_PROJECTBASEDIR=%WDIR%
100 | cd "%EXEC_DIR%"
101 | goto endDetectBaseDir
102 |
103 | :baseDirNotFound
104 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
105 | cd "%EXEC_DIR%"
106 |
107 | :endDetectBaseDir
108 |
109 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
110 |
111 | @setlocal EnableExtensions EnableDelayedExpansion
112 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
113 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
114 |
115 | :endReadAdditionalConfig
116 |
117 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
118 |
119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
121 |
122 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
123 | if ERRORLEVEL 1 goto error
124 | goto end
125 |
126 | :error
127 | set ERROR_CODE=1
128 |
129 | :end
130 | @endlocal & set ERROR_CODE=%ERROR_CODE%
131 |
132 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
133 | @REM check for post script, once with legacy .bat ending and once with .cmd ending
134 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
135 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
136 | :skipRcPost
137 |
138 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
139 | if "%MAVEN_BATCH_PAUSE%" == "on" pause
140 |
141 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
142 |
143 | exit /B %ERROR_CODE%
144 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 | 4.0.0
5 |
6 | com.ramsrib
7 | spring-boot-multi-tenancy-workaround
8 | 0.0.1-SNAPSHOT
9 | jar
10 |
11 | spring-boot-multi-tenancy-workaround
12 | Multi-tenant application using discriminator field in Spring Boot 2 (using filters)
13 |
14 |
15 | org.springframework.boot
16 | spring-boot-starter-parent
17 | 2.0.0.M2
18 |
19 |
20 |
21 |
22 | UTF-8
23 | UTF-8
24 | 1.8
25 |
26 |
27 |
28 |
29 | org.springframework.boot
30 | spring-boot-starter-data-jpa
31 |
32 |
33 | org.springframework.boot
34 | spring-boot-starter-data-rest
35 |
36 |
37 | org.springframework.boot
38 | spring-boot-starter-aop
39 |
40 |
41 | com.h2database
42 | h2
43 | runtime
44 |
45 |
46 | org.postgresql
47 | postgresql
48 | runtime
49 |
50 |
51 | org.projectlombok
52 | lombok
53 | true
54 |
55 |
56 | org.springframework.boot
57 | spring-boot-starter-test
58 | test
59 |
60 |
61 |
62 |
63 |
64 |
65 | org.springframework.boot
66 | spring-boot-maven-plugin
67 |
68 |
69 |
70 |
71 |
72 |
73 | spring-snapshots
74 | Spring Snapshots
75 | https://repo.spring.io/snapshot
76 |
77 | true
78 |
79 |
80 |
81 | spring-milestones
82 | Spring Milestones
83 | https://repo.spring.io/milestone
84 |
85 | false
86 |
87 |
88 |
89 |
90 |
91 |
92 | spring-snapshots
93 | Spring Snapshots
94 | https://repo.spring.io/snapshot
95 |
96 | true
97 |
98 |
99 |
100 | spring-milestones
101 | Spring Milestones
102 | https://repo.spring.io/milestone
103 |
104 | false
105 |
106 |
107 |
108 |
109 |
110 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/Application.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2;
2 |
3 | import com.ramsrib.springbootmultitenant2.model.TenantSupport;
4 | import com.ramsrib.springbootmultitenant2.tenant.TenantContext;
5 | import org.hibernate.EmptyInterceptor;
6 | import org.hibernate.type.Type;
7 | import org.slf4j.Logger;
8 | import org.slf4j.LoggerFactory;
9 | import org.springframework.boot.SpringApplication;
10 | import org.springframework.boot.autoconfigure.SpringBootApplication;
11 | import org.springframework.boot.autoconfigure.orm.jpa.JpaProperties;
12 | import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder;
13 | import org.springframework.context.annotation.Bean;
14 | import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
15 |
16 | import javax.sql.DataSource;
17 | import java.io.Serializable;
18 | import java.util.HashMap;
19 | import java.util.Map;
20 |
21 | @SpringBootApplication
22 | public class Application {
23 |
24 | private final Logger log = LoggerFactory.getLogger(this.getClass());
25 |
26 | public static void main(String[] args) {
27 | SpringApplication.run(Application.class, args);
28 | }
29 |
30 | @Bean
31 | public LocalContainerEntityManagerFactoryBean entityManagerFactory(EntityManagerFactoryBuilder factory, DataSource dataSource, JpaProperties properties) {
32 | Map jpaProperties = new HashMap<>();
33 | jpaProperties.putAll(properties.getHibernateProperties(dataSource));
34 | jpaProperties.put("hibernate.ejb.interceptor", hibernateInterceptor());
35 | return factory.dataSource(dataSource).packages("com.ramsrib").properties(jpaProperties).build();
36 | }
37 |
38 | @Bean
39 | public EmptyInterceptor hibernateInterceptor() {
40 | return new EmptyInterceptor() {
41 |
42 | @Override
43 | public boolean onSave(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) {
44 | if (entity instanceof TenantSupport) {
45 | log.debug("[save] Updating the entity " + id + " with tenant information: " + TenantContext.getCurrentTenant());
46 | ((TenantSupport) entity).setTenantId(TenantContext.getCurrentTenant());
47 | }
48 | return false;
49 | }
50 |
51 | @Override
52 | public void onDelete(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) {
53 | if (entity instanceof TenantSupport) {
54 | log.debug("[delete] Updating the entity " + id + " with tenant information: " + TenantContext.getCurrentTenant());
55 | ((TenantSupport) entity).setTenantId(TenantContext.getCurrentTenant());
56 | }
57 | }
58 |
59 | @Override
60 | public boolean onFlushDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, Type[] types) {
61 | if (entity instanceof TenantSupport) {
62 | log.debug("[flush-dirty] Updating the entity " + id + " with tenant information: " + TenantContext.getCurrentTenant());
63 | ((TenantSupport) entity).setTenantId(TenantContext.getCurrentTenant());
64 | }
65 | return false;
66 | }
67 |
68 | };
69 | }
70 |
71 | }
72 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/controller/UserController.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2.controller;
2 |
3 | import com.ramsrib.springbootmultitenant2.model.User;
4 | import com.ramsrib.springbootmultitenant2.service.UserService;
5 | import org.springframework.beans.factory.annotation.Autowired;
6 | import org.springframework.web.bind.annotation.DeleteMapping;
7 | import org.springframework.web.bind.annotation.GetMapping;
8 | import org.springframework.web.bind.annotation.PathVariable;
9 | import org.springframework.web.bind.annotation.PostMapping;
10 | import org.springframework.web.bind.annotation.RequestBody;
11 | import org.springframework.web.bind.annotation.RestController;
12 |
13 | import java.util.List;
14 | import java.util.Optional;
15 |
16 | @RestController("/api/users")
17 | public class UserController {
18 |
19 | private final UserService userService;
20 |
21 | @Autowired
22 | public UserController(UserService userService) {
23 | this.userService = userService;
24 | }
25 |
26 | @GetMapping
27 | public List listUsers() {
28 | return userService.listUsers();
29 | }
30 |
31 | @PostMapping
32 | public User createUser(@RequestBody User user) {
33 | return userService.createUser(user);
34 | }
35 |
36 | @GetMapping("/{id}")
37 | public Optional getUser(@PathVariable("id") String userId) {
38 | return userService.getUser(userId);
39 | }
40 |
41 | @DeleteMapping("/{id}")
42 | public void deleteUser(@PathVariable("id") String userId) {
43 | userService.deleteUser(userId);
44 | }
45 |
46 | }
47 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/filter/TenantFilter.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2.filter;
2 |
3 | import com.ramsrib.springbootmultitenant2.tenant.TenantContext;
4 | import org.springframework.http.MediaType;
5 | import org.springframework.stereotype.Component;
6 |
7 | import javax.servlet.Filter;
8 | import javax.servlet.FilterChain;
9 | import javax.servlet.FilterConfig;
10 | import javax.servlet.ServletException;
11 | import javax.servlet.ServletRequest;
12 | import javax.servlet.ServletResponse;
13 | import javax.servlet.http.HttpServletRequest;
14 | import javax.servlet.http.HttpServletResponse;
15 | import java.io.IOException;
16 |
17 | @Component
18 | public class TenantFilter implements Filter {
19 |
20 | private static final String TENANT_HEADER = "X-TenantID";
21 |
22 | @Override
23 | public void init(FilterConfig filterConfig) throws ServletException {
24 | }
25 |
26 | @Override
27 | public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
28 | HttpServletResponse response = (HttpServletResponse) servletResponse;
29 | HttpServletRequest request = (HttpServletRequest) servletRequest;
30 | String tenantHeader = request.getHeader(TENANT_HEADER);
31 | if (tenantHeader != null && !tenantHeader.isEmpty()) {
32 | TenantContext.setCurrentTenant(tenantHeader);
33 | } else {
34 | response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
35 | response.setContentType(MediaType.APPLICATION_JSON_VALUE);
36 | response.getWriter().write("{\"error\": \"No tenant supplied\"}");
37 | response.getWriter().flush();
38 | return;
39 | }
40 | filterChain.doFilter(servletRequest, servletResponse);
41 | }
42 |
43 | @Override
44 | public void destroy() {
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/model/TenantSupport.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2.model;
2 |
3 | public interface TenantSupport {
4 | String getTenantId();
5 |
6 | void setTenantId(String tenantId);
7 | }
8 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/model/User.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2.model;
2 |
3 | import lombok.AllArgsConstructor;
4 | import lombok.Data;
5 | import lombok.NoArgsConstructor;
6 | import org.hibernate.annotations.Filter;
7 | import org.hibernate.annotations.FilterDef;
8 | import org.hibernate.annotations.ParamDef;
9 |
10 | import javax.persistence.Entity;
11 | import javax.persistence.GeneratedValue;
12 | import javax.persistence.Id;
13 | import javax.persistence.Table;
14 | import java.util.UUID;
15 |
16 | @Data
17 | @Entity
18 | @Table(name = "user_info")
19 | @NoArgsConstructor
20 | @AllArgsConstructor
21 | @FilterDef(name = "tenantFilter", parameters = {@ParamDef(name = "tenantId", type = "string")})
22 | @Filter(name = "tenantFilter", condition = "tenant_id = :tenantId")
23 | public class User implements TenantSupport {
24 |
25 | @Id
26 | @GeneratedValue
27 | private UUID userId;
28 |
29 | private String username;
30 |
31 | private String firstName;
32 |
33 | private String lastName;
34 |
35 | private String tenantId;
36 |
37 | }
38 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/repository/UserRepository.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2.repository;
2 |
3 | import com.ramsrib.springbootmultitenant2.model.User;
4 | import org.springframework.data.jpa.repository.JpaRepository;
5 |
6 | public interface UserRepository extends JpaRepository {
7 | }
8 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/service/UserService.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2.service;
2 |
3 | import com.ramsrib.springbootmultitenant2.model.User;
4 | import com.ramsrib.springbootmultitenant2.repository.UserRepository;
5 | import com.ramsrib.springbootmultitenant2.tenant.TenantContext;
6 | import org.springframework.beans.factory.annotation.Autowired;
7 | import org.springframework.boot.ApplicationArguments;
8 | import org.springframework.boot.ApplicationRunner;
9 | import org.springframework.stereotype.Service;
10 | import org.springframework.transaction.annotation.Transactional;
11 |
12 | import javax.persistence.EntityManager;
13 | import javax.persistence.PersistenceContext;
14 | import java.util.List;
15 | import java.util.Optional;
16 |
17 | @Service
18 | public class UserService implements ApplicationRunner {
19 |
20 | private final UserRepository userRepository;
21 | @PersistenceContext
22 | public EntityManager entityManager;
23 |
24 | @Autowired
25 | public UserService(UserRepository userRepository) {
26 | this.userRepository = userRepository;
27 | }
28 |
29 | @Transactional
30 | public User createUser(User user) {
31 | return userRepository.save(user);
32 | }
33 |
34 | @Transactional
35 | public List listUsers() {
36 | return userRepository.findAll();
37 | }
38 |
39 | @Transactional
40 | public Optional getUser(String userId) {
41 | return userRepository.findById(userId);
42 | }
43 |
44 | @Transactional
45 | public void deleteUser(String userId) {
46 | userRepository.deleteById(userId);
47 | }
48 |
49 | @Override
50 | public void run(ApplicationArguments applicationArguments) throws Exception {
51 | TenantContext.setCurrentTenant("tenant1");
52 | userRepository.save(new User(null, "user1", "Test1", "User", null));
53 | TenantContext.setCurrentTenant("tenant2");
54 | userRepository.save(new User(null, "user2", "Test2", "User", null));
55 | TenantContext.clear();
56 | }
57 |
58 | }
59 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/service/aspect/UserServiceAspect.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2.service.aspect;
2 |
3 | import com.ramsrib.springbootmultitenant2.service.UserService;
4 | import com.ramsrib.springbootmultitenant2.tenant.TenantContext;
5 | import org.aspectj.lang.JoinPoint;
6 | import org.aspectj.lang.annotation.Aspect;
7 | import org.aspectj.lang.annotation.Before;
8 | import org.hibernate.Session;
9 | import org.slf4j.Logger;
10 | import org.slf4j.LoggerFactory;
11 | import org.springframework.stereotype.Component;
12 |
13 | @Aspect
14 | @Component
15 | public class UserServiceAspect {
16 |
17 | private final Logger log = LoggerFactory.getLogger(this.getClass());
18 |
19 | // only applicable to user service
20 | @Before("execution(* com.ramsrib.springbootmultitenant2.service.UserService.*(..)) && !execution(* com.ramsrib.springbootmultitenant2.service.UserService.run(..)) && target(userService)")
21 | public void aroundExecution(JoinPoint pjp, UserService userService) throws Throwable {
22 | org.hibernate.Filter filter = userService.entityManager.unwrap(Session.class).enableFilter("tenantFilter");
23 | filter.setParameter("tenantId", TenantContext.getCurrentTenant());
24 | filter.validate();
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/com/ramsrib/springbootmultitenant2/tenant/TenantContext.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2.tenant;
2 |
3 | public class TenantContext {
4 |
5 | private static ThreadLocal currentTenant = new ThreadLocal<>();
6 |
7 | public static String getCurrentTenant() {
8 | return currentTenant.get();
9 | }
10 |
11 | public static void setCurrentTenant(String tenant) {
12 | currentTenant.set(tenant);
13 | }
14 |
15 | public static void clear() {
16 | currentTenant.set(null);
17 | }
18 |
19 | }
--------------------------------------------------------------------------------
/src/main/resources/application.properties:
--------------------------------------------------------------------------------
1 | spring.jpa.properties.hibernate.show_sql=true
2 | spring.jpa.properties.hibernate.format_sql=true
3 | spring.jpa.properties.hibernate.use_sql_comments=true
4 | spring.jpa.properties.hibernate.type=trace
5 | spring.data.jpa.repositories.enabled=true
6 | spring.data.rest.detection-strategy=annotated
--------------------------------------------------------------------------------
/src/test/java/com/ramsrib/springbootmultitenant2/ApplicationTests.java:
--------------------------------------------------------------------------------
1 | package com.ramsrib.springbootmultitenant2;
2 |
3 | import org.junit.Test;
4 | import org.junit.runner.RunWith;
5 | import org.springframework.boot.test.context.SpringBootTest;
6 | import org.springframework.test.context.junit4.SpringRunner;
7 |
8 | @RunWith(SpringRunner.class)
9 | @SpringBootTest
10 | public class ApplicationTests {
11 |
12 | @Test
13 | public void contextLoads() {
14 | }
15 |
16 | }
17 |
--------------------------------------------------------------------------------