diff --git a/09-spring-boot-ehcache-xml/.gitignore b/09-spring-boot-ehcache-xml/.gitignore new file mode 100644 index 0000000..a383036 --- /dev/null +++ b/09-spring-boot-ehcache-xml/.gitignore @@ -0,0 +1,24 @@ +/target +/frontend + +### STS ### +/.apt_generated +/.classpath +/.factorypath +/.project +/.settings +/.springBeans + +### IntelliJ IDEA ### +/.idea +/*.iws +/*.iml +/*.ipr + +### NetBeans ### +/nbproject/private/ +/build/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ diff --git a/09-spring-boot-ehcache-xml/.mvn/wrapper/maven-wrapper.jar b/09-spring-boot-ehcache-xml/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..cb28b0e Binary files /dev/null and b/09-spring-boot-ehcache-xml/.mvn/wrapper/maven-wrapper.jar differ diff --git a/09-spring-boot-ehcache-xml/.mvn/wrapper/maven-wrapper.properties b/09-spring-boot-ehcache-xml/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..462686e --- /dev/null +++ b/09-spring-boot-ehcache-xml/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,2 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.3/apache-maven-3.9.3-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/09-spring-boot-ehcache-xml/README.md b/09-spring-boot-ehcache-xml/README.md new file mode 100644 index 0000000..5a9167d --- /dev/null +++ b/09-spring-boot-ehcache-xml/README.md @@ -0,0 +1,27 @@ +## Overview + +This sample integrates together: + +* Spring Boot 3 +* Ehcache 3 +* AOP +* Metrics +* Prometheus +* Actuator +* Vaadin + +It accesses an online service for currency conversion and simulate some additional latencies. + +It also creates 2 caches (heap only), with listeners and TTL of 60 seconds. + +## How to run this sample: + +1. Requires: **Java 17** +2. You must first get an API key at https://freecurrencyapi.com/ +2. Build: `./mvnw package` +3. Run: `./target/spring-boot-ehcache-0.0.1-SNAPSHOT.jar --app.freecurrencyapi.key=` +4. Open your browser at http://localhost:8080/ +5. Execute some currency conversion +6. Look at the logs below +7. Look at Spring Boot actuator endpoints at http://localhost:8080/actuator to see the metrics and caches and verify + that the caching works. diff --git a/09-spring-boot-ehcache-xml/mvnw b/09-spring-boot-ehcache-xml/mvnw new file mode 100755 index 0000000..66df285 --- /dev/null +++ b/09-spring-boot-ehcache-xml/mvnw @@ -0,0 +1,308 @@ +#!/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 +# +# https://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.2.0 +# +# 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."; 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." +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" + 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.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.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." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + 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/09-spring-boot-ehcache-xml/mvnw.cmd b/09-spring-boot-ehcache-xml/mvnw.cmd new file mode 100644 index 0000000..95ba6f5 --- /dev/null +++ b/09-spring-boot-ehcache-xml/mvnw.cmd @@ -0,0 +1,205 @@ +@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 https://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.2.0 +@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. +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. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +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. +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.2.0/maven-wrapper-3.2.0.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.2.0/maven-wrapper-3.2.0.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 "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output '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/09-spring-boot-ehcache-xml/pom.xml b/09-spring-boot-ehcache-xml/pom.xml new file mode 100644 index 0000000..4cc3c37 --- /dev/null +++ b/09-spring-boot-ehcache-xml/pom.xml @@ -0,0 +1,102 @@ + + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 3.1.1 + + + + com.example + spring-boot-ehcache + 0.0.1-SNAPSHOT + + spring-boot-ehcache + Spring-Boot with Ehcache 3 Sample + + + UTF-8 + UTF-8 + 17 + 24.1.2 + + + + + org.springframework.boot + spring-boot-starter-actuator + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-cache + + + + org.ehcache + ehcache + jakarta + 3.10-SNAPSHOT + + + com.vaadin + vaadin-spring-boot-starter + + + io.micrometer + micrometer-registry-prometheus + + + org.springframework.boot + spring-boot-starter-aop + + + + + + + com.vaadin + vaadin-bom + ${vaadin.version} + pom + import + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + true + + + + com.vaadin + vaadin-maven-plugin + ${vaadin.version} + + ${project.build.directory}/frontend + + + + + prepare-frontend + build-frontend + + + + + + + + diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/Application.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/Application.java new file mode 100644 index 0000000..56a159c --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/Application.java @@ -0,0 +1,15 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/MainView.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/MainView.java new file mode 100644 index 0000000..5422d61 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/MainView.java @@ -0,0 +1,99 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache; + +import com.example.springbootehcache.events.CachingEvent; +import com.example.springbootehcache.events.MethodCallEvent; +import com.example.springbootehcache.service.ExchangeService; +import com.vaadin.flow.component.HasValue; +import com.vaadin.flow.component.combobox.ComboBox; +import com.vaadin.flow.component.html.NativeLabel; +import com.vaadin.flow.component.orderedlayout.HorizontalLayout; +import com.vaadin.flow.component.orderedlayout.VerticalLayout; +import com.vaadin.flow.component.textfield.TextField; +import com.vaadin.flow.router.PreserveOnRefresh; +import com.vaadin.flow.router.Route; +import com.vaadin.flow.spring.annotation.SpringComponent; +import jakarta.annotation.PostConstruct; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.event.EventListener; +import org.springframework.scheduling.annotation.Async; + +import java.io.Serial; +import java.math.BigDecimal; +import java.math.MathContext; +import java.math.RoundingMode; +import java.util.Collection; +import java.util.Date; +import java.util.stream.Stream; + +@Route +@PreserveOnRefresh +@SpringComponent +public class MainView extends VerticalLayout { + @Serial + private static final long serialVersionUID = 6004653986145050428L; + + @Autowired + public ExchangeService exchangeService; + + private final VerticalLayout logs = new VerticalLayout(); + private final ComboBox fromCurrency = new ComboBox<>(); + private final ComboBox toCurrency = new ComboBox<>(); + private final TextField fromAmount = new TextField(); + private final TextField toAmount = new TextField(); + + @PostConstruct + public void init() { + final Collection codes = exchangeService.getCodes(); + + toAmount.setReadOnly(true); + + Stream.of(fromAmount, toAmount).forEach(textField -> { + textField.setRequired(true); + textField.setPlaceholder("Amount"); + }); + + Stream.of(fromCurrency, toCurrency) + .forEach(comboBox -> comboBox.setItems(codes)); + + add(new HorizontalLayout(fromAmount, fromCurrency, new NativeLabel(" <=> "), toAmount, toCurrency)); + add(logs); + + fromAmount.setValue("1"); + fromCurrency.setValue("USD"); + toCurrency.setValue("EUR"); + convert(null); + + Stream.of(fromAmount, fromCurrency, toCurrency) + .forEach(component -> component.addValueChangeListener(this::convert)); + } + + private void convert(HasValue.ValueChangeEvent event) { + final double fromAmount; + try { + fromAmount = Double.parseDouble(this.fromAmount.getValue()); + } catch (NumberFormatException e) { + return; + } + + final var fromCurrency = this.fromCurrency.getValue(); + final var toCurrency = this.toCurrency.getValue(); + + toAmount.setValue(BigDecimal.valueOf(exchangeService.convert(fromAmount, fromCurrency, toCurrency)).round(new MathContext(4, RoundingMode.HALF_UP)).toPlainString()); + } + + @EventListener + @Async + public void onEvent(MethodCallEvent event) { + getUI().ifPresent(ui -> ui.access(() -> logs.add(new NativeLabel(new Date() + " : " + event)))); + } + + @EventListener + @Async + public void onEvent(CachingEvent event) { + getUI().ifPresent(ui -> ui.access(() -> logs.add(new NativeLabel(new Date() + " : " + event)))); + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/caching/CacheEventRedirect.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/caching/CacheEventRedirect.java new file mode 100644 index 0000000..230f134 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/caching/CacheEventRedirect.java @@ -0,0 +1,20 @@ +package com.example.springbootehcache.caching; + +import com.example.springbootehcache.events.CachingEvent; +import org.ehcache.event.CacheEvent; +import org.ehcache.event.CacheEventListener; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.ApplicationEventPublisher; +import org.springframework.stereotype.Component; + +@Component +public class CacheEventRedirect implements CacheEventListener { + + @Autowired + public ApplicationEventPublisher applicationEventPublisher; + + @Override + public void onEvent(CacheEvent event) { + applicationEventPublisher.publishEvent(new CachingEvent(event.getType(), event.getKey())); + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/caching/CurrenciesSerializer.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/caching/CurrenciesSerializer.java new file mode 100644 index 0000000..2aee5ef --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/caching/CurrenciesSerializer.java @@ -0,0 +1,58 @@ +package com.example.springbootehcache.caching; + +import com.example.springbootehcache.model.Currency; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.ehcache.spi.serialization.Serializer; +import org.ehcache.spi.serialization.SerializerException; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.stereotype.Component; + +import java.nio.ByteBuffer; +import java.util.List; + +/** + * This is a dumb serializer showing we can inject spring beans into Ehcache implementations + */ +@Component +public class CurrenciesSerializer implements Serializer> { + + @Autowired + public ObjectMapper mapper; + + @Autowired + @Qualifier("StringSerializer") + public Serializer stringSerializer; + + @Override + public ByteBuffer serialize(List object) throws SerializerException { + try { + String json = mapper.writeValueAsString(object); + return stringSerializer.serialize(json); + } catch (JsonProcessingException e) { + throw new SerializerException(e); + } + } + + @Override + public List read(ByteBuffer binary) throws ClassNotFoundException, SerializerException { + try { + final String json = stringSerializer.read(binary); + return mapper.readValue(json, new TypeReference<>() {}); + } catch (JsonProcessingException e) { + throw new SerializerException(e); + } + } + + @Override + public boolean equals(List object, ByteBuffer binary) throws ClassNotFoundException, SerializerException { + try { + String json = mapper.writeValueAsString(object); + return stringSerializer.equals(json, binary); + } catch (JsonProcessingException e) { + throw new SerializerException(e); + } + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/AopConfig.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/AopConfig.java new file mode 100644 index 0000000..5f0104a --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/AopConfig.java @@ -0,0 +1,18 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.config; + +import io.micrometer.observation.ObservationRegistry; +import io.micrometer.observation.aop.ObservedAspect; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class AopConfig { + @Bean + public ObservedAspect observedAspect(ObservationRegistry observationRegistry) { + return new ObservedAspect(observationRegistry); + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/CacheConfig.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/CacheConfig.java new file mode 100644 index 0000000..565d003 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/CacheConfig.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.config; + +import org.ehcache.impl.serialization.StringSerializer; +import org.ehcache.spi.serialization.Serializer; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.autoconfigure.cache.JCacheManagerCustomizer; +import org.springframework.cache.annotation.EnableCaching; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import javax.cache.CacheManager; + +@Configuration +@EnableCaching +public class CacheConfig implements JCacheManagerCustomizer { + + @Override + public void customize(CacheManager cacheManager) { + final var ehcache = cacheManager.unwrap(org.ehcache.CacheManager.class); + // customize if you need.... + } + + @Bean + @Qualifier("StringSerializer") + public Serializer stringSerializer() { + return new StringSerializer(); + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/VaadinConfig.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/VaadinConfig.java new file mode 100644 index 0000000..bd221a0 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/config/VaadinConfig.java @@ -0,0 +1,12 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.config; + +import com.vaadin.flow.component.page.AppShellConfigurator; +import com.vaadin.flow.component.page.Push; + +@Push +public class VaadinConfig implements AppShellConfigurator { +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/events/CachingEvent.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/events/CachingEvent.java new file mode 100644 index 0000000..cf80f69 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/events/CachingEvent.java @@ -0,0 +1,9 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.events; + +import org.ehcache.event.EventType; + +public record CachingEvent(EventType eventType, Object key) {} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/events/MethodCallEvent.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/events/MethodCallEvent.java new file mode 100644 index 0000000..33c3c26 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/events/MethodCallEvent.java @@ -0,0 +1,7 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.events; + +public record MethodCallEvent(Class clazz, String method) {} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/ext/ehcache/EhcachejCacheSpringConfiguration.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/ext/ehcache/EhcachejCacheSpringConfiguration.java new file mode 100644 index 0000000..34e5562 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/ext/ehcache/EhcachejCacheSpringConfiguration.java @@ -0,0 +1,89 @@ +package com.example.springbootehcache.ext.ehcache; + +import org.ehcache.core.spi.service.InstantiatorService; +import org.springframework.beans.factory.BeanClassLoaderAware; +import org.springframework.beans.factory.ObjectProvider; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.cache.CacheProperties; +import org.springframework.boot.autoconfigure.cache.JCacheManagerCustomizer; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.core.io.Resource; +import org.springframework.util.CollectionUtils; +import org.springframework.util.StringUtils; + +import javax.cache.CacheManager; +import javax.cache.Caching; +import javax.cache.configuration.MutableConfiguration; +import javax.cache.spi.CachingProvider; +import java.io.IOException; +import java.util.List; +import java.util.Properties; + +/** + * Ehcache Spring Boot support which works together with {@link org.springframework.boot.autoconfigure.cache.JCacheCacheConfiguration}. + *

+ * This class will provide a {@link CacheManager} to the latter, and will also use the same mechanism as the latter to customize the properties and the created cache manager. + */ +@AutoConfiguration +@ConditionalOnClass({org.ehcache.CacheManager.class}) +@ConditionalOnMissingBean(value = org.springframework.cache.CacheManager.class, name = "cacheResolver") +@EnableConfigurationProperties(CacheProperties.class) +@ConditionalOnProperty("spring.cache.jcache.config") +public class EhcachejCacheSpringConfiguration implements BeanClassLoaderAware { + private ClassLoader beanClassLoader; + + @Override + public void setBeanClassLoader(ClassLoader classLoader) { + this.beanClassLoader = classLoader; + } + + @Bean + @ConditionalOnMissingBean + public InstantiatorService instantiatorService() { + return new SpringBootInstantiatorService(); + } + + @Bean + public CacheManager jCacheCacheManager(CacheProperties cacheProperties, + ObjectProvider> defaultCacheConfiguration, + ObjectProvider cacheManagerCustomizers, + InstantiatorService instantiatorService) throws IOException { + CacheManager jCacheCacheManager = createCacheManager(cacheProperties, instantiatorService); + List cacheNames = cacheProperties.getCacheNames(); + if (!CollectionUtils.isEmpty(cacheNames)) { + for (String cacheName : cacheNames) { + jCacheCacheManager.createCache(cacheName, defaultCacheConfiguration.getIfAvailable(MutableConfiguration::new)); + } + } + cacheManagerCustomizers.orderedStream().forEach((customizer) -> customizer.customize(jCacheCacheManager)); + return jCacheCacheManager; + } + + private CacheManager createCacheManager(CacheProperties cacheProperties, InstantiatorService instantiatorService) throws IOException { + CachingProvider cachingProvider = getCachingProvider(cacheProperties.getJcache().getProvider()); + Properties properties = createCacheManagerProperties(instantiatorService); + Resource configLocation = cacheProperties.resolveConfigLocation(cacheProperties.getJcache().getConfig()); + if (configLocation != null) { + return cachingProvider.getCacheManager(configLocation.getURI(), this.beanClassLoader, properties); + } else { + return cachingProvider.getCacheManager(null, this.beanClassLoader, properties); + } + } + + private Properties createCacheManagerProperties(InstantiatorService instantiatorService) { + Properties properties = new Properties(); + properties.put("ehcache.service.instantiatorService", instantiatorService); + return properties; + } + + private static CachingProvider getCachingProvider(String cachingProviderFqn) { + if (StringUtils.hasText(cachingProviderFqn)) { + return Caching.getCachingProvider(cachingProviderFqn); + } + return Caching.getCachingProvider(); + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/ext/ehcache/SpringBootInstantiatorService.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/ext/ehcache/SpringBootInstantiatorService.java new file mode 100644 index 0000000..a82b649 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/ext/ehcache/SpringBootInstantiatorService.java @@ -0,0 +1,47 @@ +package com.example.springbootehcache.ext.ehcache; + +import org.ehcache.core.spi.service.InstantiatorService; +import org.ehcache.impl.internal.classes.DefaultInstantiatorService; +import org.ehcache.spi.service.Service; +import org.ehcache.spi.service.ServiceProvider; +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.BeanFactory; +import org.springframework.beans.factory.BeanFactoryAware; +import org.springframework.beans.factory.NoSuchBeanDefinitionException; +import org.springframework.stereotype.Component; + +@Component +public class SpringBootInstantiatorService implements InstantiatorService, BeanFactoryAware { + private final InstantiatorService delegate; + private BeanFactory beanFactory; + + public SpringBootInstantiatorService() { + this(new DefaultInstantiatorService()); + } + + public SpringBootInstantiatorService(InstantiatorService delegate) { + this.delegate = delegate; + } + + @Override + public void setBeanFactory(BeanFactory beanFactory) throws BeansException { + this.beanFactory = beanFactory; + } + + @Override + public T instantiate(Class clazz, Object... arguments) throws IllegalArgumentException { + try { + return beanFactory.getBean(clazz, arguments); + } catch (NoSuchBeanDefinitionException e) { + return delegate.instantiate(clazz, arguments); + } + } + + @Override + public void start(ServiceProvider serviceProvider) { + } + + @Override + public void stop() { + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/model/Currency.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/model/Currency.java new file mode 100644 index 0000000..cf8d913 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/model/Currency.java @@ -0,0 +1,7 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.model; + +public record Currency(String code, String name, String symbol) {} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/repository/CurrencyRepository.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/repository/CurrencyRepository.java new file mode 100644 index 0000000..d2fa9fa --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/repository/CurrencyRepository.java @@ -0,0 +1,14 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.repository; + +import com.example.springbootehcache.model.Currency; + +import java.util.Collection; + +public interface CurrencyRepository { + Collection getCurrencies(); + double getLatestRate(String code); +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/repository/OnlineCurrencyRepository.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/repository/OnlineCurrencyRepository.java new file mode 100644 index 0000000..1c1e926 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/repository/OnlineCurrencyRepository.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.repository; + +import com.example.springbootehcache.events.MethodCallEvent; +import com.example.springbootehcache.model.Currency; +import io.micrometer.observation.ObservationRegistry; +import io.micrometer.observation.annotation.Observed; +import jakarta.annotation.PostConstruct; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.cache.annotation.Cacheable; +import org.springframework.context.ApplicationEventPublisher; +import org.springframework.stereotype.Component; +import org.springframework.web.client.RestTemplate; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Map; + +@Component +public class OnlineCurrencyRepository implements CurrencyRepository { + private static final Logger LOGGER = LoggerFactory.getLogger(OnlineCurrencyRepository.class); + + @Value("${app.freecurrencyapi.key}") + public String apiKey; + + @Autowired + public ObservationRegistry observationRegistry; + + @Autowired + public ApplicationEventPublisher applicationEventPublisher; + + @PostConstruct + public void init() { + if (apiKey == null || apiKey.isBlank()) { + throw new IllegalStateException("You must get an API key at https://freecurrencyapi.com/ set: 'app.freecurrencyapi.key='"); + } + } + + @Override + @Observed(name = "OnlineCurrencyRepository#getCurrencies") + @Cacheable(cacheNames = "currencies", key = "'currencies'") + public Collection getCurrencies() { + simulateLatency(); + final var rest = new RestTemplate(); + final var response = rest.getForObject("https://api.freecurrencyapi.com/v1/currencies?apikey=" + apiKey, CurrencyResponse.class); + final var data = new ArrayList<>(response.data.values()); + LOGGER.info("getCurrencies(): {}", data); + applicationEventPublisher.publishEvent(new MethodCallEvent(getClass(), "getCurrencies")); + return data; + } + + @Override + @Observed(name = "OnlineCurrencyRepository#getLatestRates") + @Cacheable(cacheNames = "rates", key = "#code") + public double getLatestRate(String code) { + simulateLatency(); + final var rest = new RestTemplate(); + final var response = rest.getForObject("https://api.freecurrencyapi.com/v1/latest?currencies=" + code + "&apikey=" + apiKey, LatestRatesResponse.class); + final var data = response.data.get(code); + LOGGER.info("getLatestRate({}): {}", code, data); + applicationEventPublisher.publishEvent(new MethodCallEvent(getClass(), "getLatestRates")); + return data; + } + + private static void simulateLatency() { + try { + System.out.println(""); + Thread.sleep(2_000); + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + } + + record LatestRatesResponse(Map data) {} + + record CurrencyResponse(Map data) {} +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/service/DefaultExchangeService.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/service/DefaultExchangeService.java new file mode 100644 index 0000000..4867042 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/service/DefaultExchangeService.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.service; + +import com.example.springbootehcache.events.MethodCallEvent; +import com.example.springbootehcache.model.Currency; +import com.example.springbootehcache.repository.CurrencyRepository; +import io.micrometer.observation.annotation.Observed; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.ApplicationEventPublisher; +import org.springframework.stereotype.Component; + +import java.util.Collection; + +import static java.util.Objects.requireNonNull; +import static java.util.stream.Collectors.toList; + +@Component +public class DefaultExchangeService implements ExchangeService { + + @Autowired + public CurrencyRepository currencyRepository; + + @Autowired + public ApplicationEventPublisher applicationEventPublisher; + + @Override + @Observed(name = "ExchangeService#getCodes") + public Collection getCodes() { + applicationEventPublisher.publishEvent(new MethodCallEvent(getClass(), "getCodes")); + return currencyRepository.getCurrencies().stream().map(Currency::code).sorted().collect(toList()); + } + + @Override + @Observed(name = "ExchangeService#convert") + public double convert(double fromAmount, String fromCurrency, String toCurrency) { + requireNonNull(fromCurrency); + requireNonNull(toCurrency); + applicationEventPublisher.publishEvent(new MethodCallEvent(getClass(), "convert")); + final var usdToFrom = currencyRepository.getLatestRate(fromCurrency); + final var usdToTo = currencyRepository.getLatestRate(toCurrency); + return fromAmount / usdToFrom * usdToTo; + } +} diff --git a/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/service/ExchangeService.java b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/service/ExchangeService.java new file mode 100644 index 0000000..09201de --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/java/com/example/springbootehcache/service/ExchangeService.java @@ -0,0 +1,12 @@ +/* + * Copyright (c) 2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. + * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG. + */ +package com.example.springbootehcache.service; + +import java.util.Collection; + +public interface ExchangeService { + Collection getCodes(); + double convert(double fromAmount, String fromCurrency, String toCurrency); +} diff --git a/09-spring-boot-ehcache-xml/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/09-spring-boot-ehcache-xml/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 0000000..109665d --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1 @@ +com.example.springbootehcache.ext.ehcache.EhcachejCacheSpringConfiguration \ No newline at end of file diff --git a/09-spring-boot-ehcache-xml/src/main/resources/application.properties b/09-spring-boot-ehcache-xml/src/main/resources/application.properties new file mode 100644 index 0000000..a66b996 --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/resources/application.properties @@ -0,0 +1,7 @@ +management.endpoints.enabled-by-default=true +management.endpoints.web.exposure.include=* + +spring.cache.jcache.config=classpath:ehcache.xml + +# You must get an API key at https://freecurrencyapi.com/ +app.freecurrencyapi.key= diff --git a/09-spring-boot-ehcache-xml/src/main/resources/ehcache.xml b/09-spring-boot-ehcache-xml/src/main/resources/ehcache.xml new file mode 100644 index 0000000..ffea58e --- /dev/null +++ b/09-spring-boot-ehcache-xml/src/main/resources/ehcache.xml @@ -0,0 +1,63 @@ + + + + + + + + + java.lang.String + java.lang.Double + + 30 + + + + com.example.springbootehcache.caching.CacheEventRedirect + ASYNCHRONOUS + ORDERED + CREATED + UPDATED + EXPIRED + REMOVED + EVICTED + + + + 1 + + + + + java.lang.String + java.util.ArrayList + + 30 + + + + com.example.springbootehcache.caching.CacheEventRedirect + ASYNCHRONOUS + ORDERED + CREATED + UPDATED + EXPIRED + REMOVED + EVICTED + + + + 1 + + + +