├── HELP.md ├── LICENSE ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main ├── java │ └── com │ │ └── springboot │ │ ├── ApiProgrammingTipsApplication.java │ │ ├── config │ │ └── APIConfig.java │ │ ├── controller │ │ └── ApiController.java │ │ ├── handler │ │ ├── APIFilter.java │ │ └── MyServletRequestWrapper.java │ │ ├── model │ │ ├── Address.java │ │ ├── Leave.java │ │ ├── Major.java │ │ ├── SampleData.java │ │ └── Student.java │ │ └── service │ │ └── APIService.java └── resources │ └── application.yml └── test └── java └── com └── springboot └── ApiProgrammingTipsApplicationTests.java /HELP.md: -------------------------------------------------------------------------------- 1 | # Getting Started 2 | 3 | ### Reference Documentation 4 | For further reference, please consider the following sections: 5 | 6 | * [Official Apache Maven documentation](https://maven.apache.org/guides/index.html) 7 | 8 | ### Guides 9 | The following guides illustrate how to use some features concretely: 10 | 11 | * [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/) 12 | * [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/) 13 | * [Building REST services with Spring](https://spring.io/guides/tutorials/bookmarks/) 14 | 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Simple Programming 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring Boot - EhCache (Java Configuration) with CacheManager Configurations, Expiry, etc 2 | 3 | @Cacheable 4 | @CacheEvit 5 | @CachePut 6 | 7 | A simple example to use ehCache CacheManager with multiple caches with expiry time 8 | 9 | let us see how to use cache in an API project 10 | 11 | there are different cache mechanisms available in the market for you to make use of, like ehcache redis, HazelCast, CouchBase, Gemfire, etc 12 | 13 | In this example we will look into cache in two parts, in the first part we will look at the auto-configuration inbuilt cache functionality and in the next part we will see how to use cache manger to configure multiple caches and how to set expiry for them and for this i will use ehCache with java configurations, 14 | 15 | before we jump into hands on lets discuss a common topic that many developers are confused about 16 | What is the difference between Cache and a Cookie 17 | 18 | Cookie - used to store user details 19 | 20 | Cache - used to store information to render the page faster 21 | 22 | Cookies often track information like how frequently the user visits, what are the times of visits, what banners have been clicked on, what button clicked, user preferences, items in shopping cart, etc 23 | Example would be youtube, or facebook. They show ads based on the information available in your cookies. 24 | lets say you visited amazon.com and you were looking into some shoes, and after some time you open up a facebook page 25 | you would have noticed that facebook would show ads related to shoes in their page how is that done. 26 | well this is where cookie comes of use 27 | 28 | Whereas in case of Cache, 29 | 30 | For example, when you open websites with large pictures and video’s or a page with huge data that takes some time to render in front of you, it might take some time to load the website. 31 | Here we can use cache to stores the site contents like the images, videos, audio, huge data etc. on your computer. So the next time you load the same website you will find it loading faster 32 | 33 | Both cookie and cache can have an expiry time limit, depending upon ur business needs 34 | 35 | 36 | Cache Eviction Policy 37 | 38 | - A cache eviction algorithm is a way of deciding which element to evict when the cache is full. 39 | 40 | Cache Entries On Local Heap 41 | 42 | - The maximum number of cache entries or bytes a cache can use in local heap memory, or, when set at the CacheManager level (maxBytesLocalHeap only), a local pool available to all caches under that CacheManager. This setting is required for every cache or at the CacheManager level. 43 | 44 | 45 | Caching Replacement Algorithms - 46 | https://en.wikipedia.org/wiki/Cache_replacement_policies#Least-frequently_used_(LFU) 47 | 48 | Ehcache Documentation Cache Size - 49 | https://www.ehcache.org/documentation/2.7/configuration/cache-size.html 50 | 51 | EhCache Eviction Algorithms Documentation - 52 | https://www.ehcache.org/documentation/2.8/apis/cache-eviction-algorithms.html 53 | -------------------------------------------------------------------------------- /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 | # https://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 Mingw, 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 | ########################################################################################## 204 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 205 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 206 | ########################################################################################## 207 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 208 | if [ "$MVNW_VERBOSE" = true ]; then 209 | echo "Found .mvn/wrapper/maven-wrapper.jar" 210 | fi 211 | else 212 | if [ "$MVNW_VERBOSE" = true ]; then 213 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 214 | fi 215 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 216 | while IFS="=" read key value; do 217 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 218 | esac 219 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Downloading from: $jarUrl" 222 | fi 223 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 224 | 225 | if command -v wget > /dev/null; then 226 | if [ "$MVNW_VERBOSE" = true ]; then 227 | echo "Found wget ... using wget" 228 | fi 229 | wget "$jarUrl" -O "$wrapperJarPath" 230 | elif command -v curl > /dev/null; then 231 | if [ "$MVNW_VERBOSE" = true ]; then 232 | echo "Found curl ... using curl" 233 | fi 234 | curl -o "$wrapperJarPath" "$jarUrl" 235 | else 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Falling back to using Java to download" 238 | fi 239 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 240 | if [ -e "$javaClass" ]; then 241 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 242 | if [ "$MVNW_VERBOSE" = true ]; then 243 | echo " - Compiling MavenWrapperDownloader.java ..." 244 | fi 245 | # Compiling the Java class 246 | ("$JAVA_HOME/bin/javac" "$javaClass") 247 | fi 248 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 249 | # Running the downloader 250 | if [ "$MVNW_VERBOSE" = true ]; then 251 | echo " - Running MavenWrapperDownloader.java ..." 252 | fi 253 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 254 | fi 255 | fi 256 | fi 257 | fi 258 | ########################################################################################## 259 | # End of extension 260 | ########################################################################################## 261 | 262 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 263 | if [ "$MVNW_VERBOSE" = true ]; then 264 | echo $MAVEN_PROJECTBASEDIR 265 | fi 266 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 267 | 268 | # For Cygwin, switch paths to Windows format before running java 269 | if $cygwin; then 270 | [ -n "$M2_HOME" ] && 271 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 272 | [ -n "$JAVA_HOME" ] && 273 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 274 | [ -n "$CLASSPATH" ] && 275 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 276 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 277 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 278 | fi 279 | 280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 281 | 282 | exec "$JAVACMD" \ 283 | $MAVEN_OPTS \ 284 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 285 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 286 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 287 | -------------------------------------------------------------------------------- /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 https://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 set title of command window 39 | title %0 40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 124 | FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO ( 125 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | echo Found %WRAPPER_JAR% 132 | ) else ( 133 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 134 | echo Downloading from: %DOWNLOAD_URL% 135 | powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')" 136 | echo Finished downloading %WRAPPER_JAR% 137 | ) 138 | @REM End of extension 139 | 140 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 141 | if ERRORLEVEL 1 goto error 142 | goto end 143 | 144 | :error 145 | set ERROR_CODE=1 146 | 147 | :end 148 | @endlocal & set ERROR_CODE=%ERROR_CODE% 149 | 150 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 151 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 152 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 153 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 154 | :skipRcPost 155 | 156 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 157 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 158 | 159 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 160 | 161 | exit /B %ERROR_CODE% 162 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | org.springframework.boot 8 | spring-boot-starter-parent 9 | 2.1.4.RELEASE 10 | 11 | 12 | com.springboot 13 | api-programming-tips 14 | 0.0.1-SNAPSHOT 15 | api-programming-tips 16 | Spring Boot Application 17 | 18 | 19 | 1.8 20 | 21 | 22 | 23 | 24 | org.springframework.boot 25 | spring-boot-starter-web 26 | 27 | 28 | org.springframework.boot 29 | spring-boot-starter-cache 30 | 31 | 32 | net.sf.ehcache 33 | ehcache 34 | 35 | 36 | org.apache.commons 37 | commons-lang3 38 | 39 | 40 | org.springframework.boot 41 | spring-boot-starter-test 42 | test 43 | 44 | 45 | 46 | 47 | 48 | 49 | org.springframework.boot 50 | spring-boot-maven-plugin 51 | 52 | 53 | 54 | 55 | 56 | -------------------------------------------------------------------------------- /src/main/java/com/springboot/ApiProgrammingTipsApplication.java: -------------------------------------------------------------------------------- 1 | package com.springboot; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class ApiProgrammingTipsApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(ApiProgrammingTipsApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/springboot/config/APIConfig.java: -------------------------------------------------------------------------------- 1 | package com.springboot.config; 2 | 3 | import java.util.Collection; 4 | 5 | import org.springframework.cache.Cache; 6 | import org.springframework.cache.CacheManager; 7 | import org.springframework.cache.annotation.CachingConfigurerSupport; 8 | import org.springframework.cache.annotation.EnableCaching; 9 | import org.springframework.cache.ehcache.EhCacheCacheManager; 10 | import org.springframework.context.annotation.Bean; 11 | import org.springframework.context.annotation.Configuration; 12 | 13 | import com.springboot.handler.APIFilter; 14 | 15 | import net.sf.ehcache.config.CacheConfiguration; 16 | 17 | @Configuration 18 | @EnableCaching 19 | public class APIConfig extends CachingConfigurerSupport { 20 | 21 | @Bean 22 | public APIFilter aPIFilter() { 23 | return new APIFilter(); 24 | } 25 | 26 | @Bean 27 | public net.sf.ehcache.CacheManager ehCacheManager() { 28 | CacheConfiguration tenSecondCache = new CacheConfiguration(); 29 | tenSecondCache.setName("ten-second-cache"); 30 | tenSecondCache.setMemoryStoreEvictionPolicy("LRU"); 31 | tenSecondCache.setMaxEntriesLocalHeap(1000); 32 | tenSecondCache.setTimeToLiveSeconds(10); 33 | 34 | CacheConfiguration twentySecondCache = new CacheConfiguration(); 35 | twentySecondCache.setName("twenty-second-cache"); 36 | twentySecondCache.setMemoryStoreEvictionPolicy("LRU"); 37 | twentySecondCache.setMaxEntriesLocalHeap(1000); 38 | twentySecondCache.setTimeToLiveSeconds(20); 39 | 40 | net.sf.ehcache.config.Configuration config = new net.sf.ehcache.config.Configuration(); 41 | config.addCache(tenSecondCache); 42 | config.addCache(twentySecondCache); 43 | return net.sf.ehcache.CacheManager.newInstance(config); 44 | } 45 | 46 | @Bean 47 | @Override 48 | public CacheManager cacheManager() { 49 | return new EhCacheCacheManager(ehCacheManager()); 50 | } 51 | } -------------------------------------------------------------------------------- /src/main/java/com/springboot/controller/ApiController.java: -------------------------------------------------------------------------------- 1 | package com.springboot.controller; 2 | 3 | import org.springframework.beans.factory.annotation.Autowired; 4 | import org.springframework.http.HttpStatus; 5 | import org.springframework.http.ResponseEntity; 6 | import org.springframework.web.bind.annotation.GetMapping; 7 | import org.springframework.web.bind.annotation.RequestMapping; 8 | import org.springframework.web.bind.annotation.RequestParam; 9 | import org.springframework.web.bind.annotation.RestController; 10 | 11 | import com.springboot.model.Student; 12 | import com.springboot.service.APIService; 13 | 14 | @RestController 15 | @RequestMapping("/student") 16 | public class ApiController { 17 | 18 | @Autowired 19 | private APIService aPIService; 20 | 21 | @GetMapping 22 | public ResponseEntity fetchStudent(@RequestParam(name = "studentId") String studentId, 23 | @RequestParam(name = "isCacheable") boolean isCacheable) throws InterruptedException { 24 | return new ResponseEntity<>(aPIService.fetchStudent(studentId, isCacheable).get(), HttpStatus.OK); 25 | } 26 | } -------------------------------------------------------------------------------- /src/main/java/com/springboot/handler/APIFilter.java: -------------------------------------------------------------------------------- 1 | package com.springboot.handler; 2 | 3 | import java.io.IOException; 4 | 5 | import javax.servlet.FilterChain; 6 | import javax.servlet.ServletException; 7 | import javax.servlet.ServletRequest; 8 | import javax.servlet.ServletResponse; 9 | import javax.servlet.http.HttpServletRequest; 10 | import javax.servlet.http.HttpServletResponse; 11 | 12 | import org.springframework.web.filter.GenericFilterBean; 13 | 14 | public class APIFilter extends GenericFilterBean { 15 | 16 | @Override 17 | public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 18 | throws IOException, ServletException { 19 | // TODO Auto-generated method stub 20 | HttpServletRequest httpReq = (HttpServletRequest) request; 21 | HttpServletResponse httpRes = (HttpServletResponse) response; 22 | httpReq = new MyServletRequestWrapper(httpReq); 23 | chain.doFilter(httpReq, httpRes); 24 | } 25 | } -------------------------------------------------------------------------------- /src/main/java/com/springboot/handler/MyServletRequestWrapper.java: -------------------------------------------------------------------------------- 1 | package com.springboot.handler; 2 | 3 | import java.util.Arrays; 4 | import java.util.Collections; 5 | import java.util.Enumeration; 6 | import java.util.List; 7 | import java.util.Map; 8 | import java.util.function.Function; 9 | import java.util.stream.Collectors; 10 | 11 | import javax.servlet.http.HttpServletRequest; 12 | import javax.servlet.http.HttpServletRequestWrapper; 13 | 14 | public class MyServletRequestWrapper extends HttpServletRequestWrapper { 15 | 16 | private final List ALLOWED_HEADERS = Arrays.asList("test-header", "api-header"); 17 | private final Map> headerMap; 18 | protected Map parameters; 19 | 20 | public MyServletRequestWrapper(HttpServletRequest request) { 21 | super(request); 22 | // TODO Auto-generated constructor stub 23 | parameters = request.getParameterMap(); 24 | headerMap = getHeaderMap(request); 25 | } 26 | 27 | private Map> getHeaderMap(HttpServletRequest request) { 28 | return ALLOWED_HEADERS.stream() 29 | .collect(Collectors.toMap(Function.identity(), s -> Arrays.asList(request.getHeader(s)))); 30 | } 31 | 32 | @Override 33 | public String getHeader(String name) { 34 | List values = headerMap.get(name); 35 | if (values != null) 36 | return values.get(0); 37 | return null; 38 | } 39 | 40 | @Override 41 | public Enumeration getHeaders(String name) { 42 | List values = headerMap.get(name); 43 | if (values == null) 44 | return Collections.emptyEnumeration(); 45 | return Collections.enumeration(values); 46 | } 47 | 48 | @Override 49 | public Enumeration getHeaderNames() { 50 | return Collections.enumeration(this.headerMap.keySet()); 51 | } 52 | 53 | @Override 54 | public String getParameter(String name) { 55 | String[] values = getParameterValues(name); 56 | return values == null ? null : values[0]; 57 | } 58 | 59 | @Override 60 | public Map getParameterMap() { 61 | return Collections.unmodifiableMap(parameters); 62 | } 63 | 64 | @Override 65 | public String[] getParameterValues(String name) { 66 | return parameters.get(name); 67 | } 68 | } -------------------------------------------------------------------------------- /src/main/java/com/springboot/model/Address.java: -------------------------------------------------------------------------------- 1 | package com.springboot.model; 2 | 3 | import java.io.Serializable; 4 | 5 | public class Address implements Serializable { 6 | 7 | private static final long serialVersionUID = 1L; 8 | 9 | private String doorNo; 10 | 11 | private String street; 12 | 13 | private String city; 14 | 15 | private String state; 16 | 17 | private String zipCode; 18 | 19 | public Address() { 20 | 21 | } 22 | 23 | @Override 24 | public String toString() { 25 | return "Address [doorNo=" + doorNo + ", street=" + street + ", city=" + city + ", state=" + state + ", zipCode=" 26 | + zipCode + "]"; 27 | } 28 | 29 | public Address(String doorNo, String street, String city, String state, String zipCode) { 30 | super(); 31 | this.doorNo = doorNo; 32 | this.street = street; 33 | this.city = city; 34 | this.state = state; 35 | this.zipCode = zipCode; 36 | } 37 | 38 | public String getCity() { 39 | return city; 40 | } 41 | 42 | public String getDoorNo() { 43 | return doorNo; 44 | } 45 | 46 | public String getState() { 47 | return state; 48 | } 49 | 50 | public String getStreet() { 51 | return street; 52 | } 53 | 54 | public String getZipCode() { 55 | return zipCode; 56 | } 57 | 58 | public void setCity(String city) { 59 | this.city = city; 60 | } 61 | 62 | public void setDoorNo(String doorNo) { 63 | this.doorNo = doorNo; 64 | } 65 | 66 | public void setState(String state) { 67 | this.state = state; 68 | } 69 | 70 | public void setStreet(String street) { 71 | this.street = street; 72 | } 73 | 74 | public void setZipCode(String zipCode) { 75 | this.zipCode = zipCode; 76 | } 77 | } -------------------------------------------------------------------------------- /src/main/java/com/springboot/model/Leave.java: -------------------------------------------------------------------------------- 1 | package com.springboot.model; 2 | 3 | import java.io.Serializable; 4 | 5 | public class Leave implements Serializable { 6 | 7 | private static final long serialVersionUID = 1L; 8 | 9 | private String name; 10 | private String date; 11 | private int days; 12 | 13 | public Leave(String name, String date, int days) { 14 | super(); 15 | this.name = name; 16 | this.date = date; 17 | this.days = days; 18 | } 19 | 20 | public String getName() { 21 | return name; 22 | } 23 | 24 | public void setName(String name) { 25 | this.name = name; 26 | } 27 | 28 | public String getDate() { 29 | return date; 30 | } 31 | 32 | public void setDate(String date) { 33 | this.date = date; 34 | } 35 | 36 | public int getDays() { 37 | return days; 38 | } 39 | 40 | public void setDays(int days) { 41 | this.days = days; 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/main/java/com/springboot/model/Major.java: -------------------------------------------------------------------------------- 1 | package com.springboot.model; 2 | 3 | import java.util.Arrays; 4 | import java.util.Collections; 5 | import java.util.Map; 6 | import java.util.function.Function; 7 | import java.util.stream.Collectors; 8 | 9 | import com.fasterxml.jackson.annotation.JsonEnumDefaultValue; 10 | import com.fasterxml.jackson.annotation.JsonValue; 11 | 12 | public enum Major { 13 | 14 | PHYSICS("physics"), CHEMISTRY("chemistry"), MATHS("maths"), BIOLOGY("biology"), @JsonEnumDefaultValue 15 | UNKNOWN_ENUM("unknownEnum"); 16 | 17 | private String value; 18 | private static final Map mapOfMajors; 19 | 20 | static { 21 | mapOfMajors = Collections.unmodifiableMap( 22 | Arrays.asList(Major.values()).stream().collect(Collectors.toMap(Major::value, Function.identity()))); 23 | } 24 | 25 | Major(String value) { 26 | this.value = value; 27 | } 28 | 29 | @JsonValue 30 | public String value() { 31 | return value; 32 | } 33 | 34 | public static Major lookupValue(String value) { 35 | return mapOfMajors.get(value); 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /src/main/java/com/springboot/model/SampleData.java: -------------------------------------------------------------------------------- 1 | package com.springboot.model; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | 6 | public class SampleData { 7 | 8 | public List buildStudents() { 9 | List students = new ArrayList<>(); 10 | students.add(new Student("12345", "john", "wayne", "12", buildAddress(), Major.BIOLOGY)); 11 | students.add(new Student("12346", "jack", "ryan", "13", buildAddress(), Major.CHEMISTRY)); 12 | students.add(new Student("12347", "sam", "wilson", "14", buildAddress(), Major.PHYSICS)); 13 | students.add(new Student("12348", "peter", "parker", "15", buildAddress(), Major.MATHS)); 14 | students.add(new Student("12349", "steve", "rogers", "17", buildAddress(), Major.PHYSICS)); 15 | students.add(new Student("12350", "mark", "meyers", "12", buildAddress(), Major.BIOLOGY)); 16 | students.add(new Student("12351", "mary", "jane", "16", buildAddress(), Major.CHEMISTRY)); 17 | return students; 18 | } 19 | 20 | public Address buildAddress() { 21 | return new Address("100", "bay street", "Los Angeles", "California", "90123"); 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/com/springboot/model/Student.java: -------------------------------------------------------------------------------- 1 | package com.springboot.model; 2 | 3 | import java.io.Serializable; 4 | 5 | public class Student implements Serializable { 6 | 7 | private static final long serialVersionUID = 1L; 8 | 9 | private String id; 10 | 11 | private String firstName; 12 | 13 | private String lastName; 14 | 15 | private String age; 16 | 17 | private Address address; 18 | 19 | private Major major; 20 | 21 | public Student(String id, String firstName, String lastName, String age, Address address, Major major) { 22 | super(); 23 | this.id = id; 24 | this.firstName = firstName; 25 | this.lastName = lastName; 26 | this.age = age; 27 | this.address = address; 28 | this.major = major; 29 | } 30 | 31 | public String getId() { 32 | return id; 33 | } 34 | 35 | public void setId(String id) { 36 | this.id = id; 37 | } 38 | 39 | public String getFirstName() { 40 | return firstName; 41 | } 42 | 43 | public void setFirstName(String firstName) { 44 | this.firstName = firstName; 45 | } 46 | 47 | public String getLastName() { 48 | return lastName; 49 | } 50 | 51 | public void setLastName(String lastName) { 52 | this.lastName = lastName; 53 | } 54 | 55 | public String getAge() { 56 | return age; 57 | } 58 | 59 | public void setAge(String age) { 60 | this.age = age; 61 | } 62 | 63 | public Address getAddress() { 64 | return address; 65 | } 66 | 67 | public void setAddress(Address address) { 68 | this.address = address; 69 | } 70 | 71 | public Major getMajor() { 72 | return major; 73 | } 74 | 75 | public void setMajor(Major major) { 76 | this.major = major; 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /src/main/java/com/springboot/service/APIService.java: -------------------------------------------------------------------------------- 1 | package com.springboot.service; 2 | 3 | import java.util.Arrays; 4 | import java.util.Optional; 5 | 6 | import org.springframework.cache.annotation.CacheEvict; 7 | import org.springframework.cache.annotation.Cacheable; 8 | import org.springframework.stereotype.Service; 9 | 10 | import com.springboot.model.Address; 11 | import com.springboot.model.Major; 12 | import com.springboot.model.Student; 13 | 14 | @Service 15 | public class APIService { 16 | 17 | @CacheEvict(value="twenty-second-cache", key = "'StudentInCache'+#studentId", 18 | condition = "#isCacheable == null || !#isCacheable", beforeInvocation = true) 19 | @Cacheable(value="twenty-second-cache", key = "'StudentInCache'+#studentId", 20 | condition = "#isCacheable != null && #isCacheable") 21 | public Optional fetchStudent(String studentId, boolean isCacheable) throws InterruptedException { 22 | Thread.sleep(4000); 23 | return Arrays 24 | .asList(new Student("19VC21", "John", "Wayne", "11", 25 | new Address("12A", "Bay Avenue", "SanFrancisco", "CA", "91234"), Major.MATHS), 26 | new Student("19VC22", "Mary", "Jane", "11", 27 | new Address("10A", "Cross Avenue", "SanFrancisco", "CA", "91238"), Major.CHEMISTRY), 28 | new Student("19VC23", "Peter", "Parker", "11", 29 | new Address("1A", "First Avenue", "SanFrancisco", "CA", "91934"), Major.PHYSICS)) 30 | .stream().filter(t -> t.getId().equalsIgnoreCase(studentId)).findFirst(); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/resources/application.yml: -------------------------------------------------------------------------------- 1 | server: 2 | port: 9001 3 | -------------------------------------------------------------------------------- /src/test/java/com/springboot/ApiProgrammingTipsApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.springboot; 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 ApiProgrammingTipsApplicationTests { 11 | 12 | @Test 13 | public void contextLoads() { 14 | } 15 | 16 | } 17 | --------------------------------------------------------------------------------