diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..d12ced7 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,17 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 4 +indent_style = space +insert_final_newline = true +max_line_length = 120 +tab_width = 4 +ij_continuation_indent_size = 8 + +[*.yml] +indent_size = 2 + +[*.md] +max_line_length = off diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..b8afbf6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf encoding=utf-8 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..b9b965a --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,41 @@ +name: Publish package to GitHub Packages +on: + workflow_dispatch: + inputs: + version: + description: "Version name to publish (eg: x.x.x)" + type: string + required: true + +jobs: + publish: + timeout-minutes: 15 + runs-on: ubuntu-22.04 + permissions: + contents: read + packages: write + + steps: + - uses: actions/checkout@v3 + + - uses: aboutbits/github-actions-java/setup-and-update-dependencies@v1 + + - name: Set Version + run: sed -i 's/BUILD-SNAPSHOT<\/version>/${{ github.event.inputs.version }}<\/version>/g' pom.xml + + - name: Publish package + run: mvn --batch-mode deploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + tag: + timeout-minutes: 5 + runs-on: ubuntu-22.04 + needs: publish + steps: + - name: Tag Deployment + uses: aboutbits/github-actions-git/create-or-update-tag@v1 + with: + tag-name: ${{ github.event.inputs.version }} + user-name: 'AboutBits' + user-email: 'info@aboutbits.it' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..427ac49 --- /dev/null +++ b/.gitignore @@ -0,0 +1,39 @@ +HELP.md +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ + +### Mac ### +.DS_Store + +### Local Development ### +application-local.yml diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml new file mode 100644 index 0000000..5a91b4c --- /dev/null +++ b/checkstyle-suppressions.xml @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + diff --git a/checkstyle.xml b/checkstyle.xml new file mode 100644 index 0000000..7bdca34 --- /dev/null +++ b/checkstyle.xml @@ -0,0 +1,205 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/license.md b/license.md new file mode 100644 index 0000000..21586f5 --- /dev/null +++ b/license.md @@ -0,0 +1,7 @@ +Copyright About Bits GmbH + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..66df285 --- /dev/null +++ b/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/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..95ba6f5 --- /dev/null +++ b/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/pom.xml b/pom.xml new file mode 100644 index 0000000..82a2957 --- /dev/null +++ b/pom.xml @@ -0,0 +1,81 @@ + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 3.1.1 + + + + it.aboutbits.springboot + emailservice + BUILD-SNAPSHOT + Spring Boot Email Service + + + 17 + + + + + org.springframework.boot + spring-boot-starter-data-jpa + + + org.springframework.boot + spring-boot-starter-mail + + + org.springframework.boot + spring-boot-starter-validation + + + org.liquibase + liquibase-core + + + org.projectlombok + lombok + true + + + org.springframework.boot + spring-boot-starter-test + test + + + org.springframework.boot + spring-boot-configuration-processor + true + + + + + + + + github + GitHub Packages + https://maven.pkg.github.com/aboutbits/spring-boot-sendEmailCommand-service + + + diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..8c14a01 --- /dev/null +++ b/readme.md @@ -0,0 +1,85 @@ +# Spring Boot EMail Service + +A reusable mailer service to send emails. + +## Setup + +Add the mailer service to the classpath by adding the following maven dependeny: + +```xml + + + it.aboutbits.springboot + emailservice + x.x.x + +``` + +If you want to use attachments, you will have to create a bean implementing this interface: [AttachmentDataSource.java](src%2Fmain%2Fjava%2Fit%2Faboutbits%2Fspringboot%2Femailservice%2Flib%2FAttachmentDataSource.java) +This step is optional. + +## Usage + +Use the `ManageEmail` service to schedule sending an email. + +### Example + +```java +// @formatter:off +public void sendMail(final String to,final String subject,final String htmlBody,final String plainTextBody) { + manageEmail.schedule( + EmailParameter.builder() + .scheduleAt(OffsetDateTime.now()) + .email(EmailParameter.Email.builder() + .fromName(fromName) + .fromAddress(fromAddress) + .recipient(to) + .subject(subject) + .textBody(plainTextBody) + .htmlBody(htmlBody) + .build()) + .build() + ); +} +// @formatter:on +``` + +To read email datasets from the database use this class: [QueryEmail.java](src%2Fmain%2Fjava%2Fit%2Faboutbits%2Fspringboot%2Femailservice%2Flib%2Fapplication%2FQueryEmail.java) + +If you want to receive a report after each run of the scheduler, create a Bean implementing [EmailSchedulerCallback.java](src%2Fmain%2Fjava%2Fit%2Faboutbits%2Fspringboot%2Femailservice%2Flib%2FEmailSchedulerCallback.java) + +## Configuration + +You will have to enable `EntityScanning` for the package as well as your main package. You must also add it to the base packages for Spring to scan. + +```java +@SpringBootApplication(scanBasePackages = {"the.main.package", "it.aboutbits.springboot.emailservice"}) +@EntityScan({"the.main.package", "it.aboutbits.springboot.emailservice"}) +``` + +Available configuration options are: + +```yaml +lib.emailservice.scheduling.enabled: true +lib.emailservice.scheduling.interval: 30000 +``` + +## Building and releasing a new version: + +To create a new version of this package and push it to the maven registry, you will have to use the GitHub actions workflow and manually trigger it. + +## Information + +About Bits is a company based in South Tyrol, Italy. You can find more information about us on [our website](https://aboutbits.it). + +### Support + +For support, please contact [info@aboutbits.it](mailto:info@aboutbits.it). + +### Credits + +- [All Contributors](../../contributors) + +### License + +The MIT License (MIT). Please see the [license file](license.md) for more information. diff --git a/src/main/java/it/aboutbits/springboot/emailservice/EmailServiceAutoConfiguration.java b/src/main/java/it/aboutbits/springboot/emailservice/EmailServiceAutoConfiguration.java new file mode 100644 index 0000000..a7726b7 --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/EmailServiceAutoConfiguration.java @@ -0,0 +1,60 @@ +package it.aboutbits.springboot.emailservice; + +import it.aboutbits.springboot.emailservice.lib.AttachmentDataSource; +import it.aboutbits.springboot.emailservice.lib.EmailSchedulerCallback; +import it.aboutbits.springboot.emailservice.lib.application.ManageEmail; +import it.aboutbits.springboot.emailservice.lib.application.QueryEmail; +import it.aboutbits.springboot.emailservice.lib.application.SendScheduledEmails; +import it.aboutbits.springboot.emailservice.lib.application.UnavailableAttachmentDataSource; +import it.aboutbits.springboot.emailservice.lib.jpa.EmailRepository; +import jakarta.persistence.EntityManager; +import liquibase.integration.spring.SpringLiquibase; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.jpa.repository.support.JpaRepositoryFactory; +import org.springframework.mail.javamail.JavaMailSender; + +import javax.sql.DataSource; +import java.util.List; + +@Configuration +public class EmailServiceAutoConfiguration { + @Bean(name = "emailServiceLiquibase") + public SpringLiquibase emailServiceLiquibase(DataSource dataSource) { + var liquibase = new SpringLiquibase(); + liquibase.setDataSource(dataSource); + liquibase.setChangeLog("classpath:/db/changelog/emailservice/main.xml"); + liquibase.setShouldRun(true); + return liquibase; + } + + @Bean + public EmailRepository emailRepository(EntityManager entityManager) { + var factory = new JpaRepositoryFactory(entityManager); + return factory.getRepository(EmailRepository.class); + } + + @Bean + public QueryEmail queryEmail(EmailRepository emailRepository) { + return new QueryEmail(emailRepository); + } + + @Bean + public ManageEmail manageEmail(EmailRepository emailRepository, JavaMailSender javaMailSender, AttachmentDataSource attachmentDataSource) { + return new ManageEmail(emailRepository, javaMailSender, attachmentDataSource); + } + + @Bean + @ConditionalOnProperty(value = "lib.emailservice.scheduling.enabled", matchIfMissing = true) + public SendScheduledEmails sendScheduledEmails(QueryEmail queryEmail, ManageEmail manageEmail, List callbacks) { + return new SendScheduledEmails(queryEmail, manageEmail, callbacks); + } + + @Bean + @ConditionalOnMissingBean(AttachmentDataSource.class) + public AttachmentDataSource attachmentDataSource() { + return new UnavailableAttachmentDataSource(); + } +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/AttachmentDataSource.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/AttachmentDataSource.java new file mode 100644 index 0000000..a95b289 --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/AttachmentDataSource.java @@ -0,0 +1,9 @@ +package it.aboutbits.springboot.emailservice.lib; + +import java.io.InputStream; + +public interface AttachmentDataSource { + InputStream getAttachmentPayload(String reference); + + void releaseAttachment(String reference); +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/EmailSchedulerCallback.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/EmailSchedulerCallback.java new file mode 100644 index 0000000..6cba011 --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/EmailSchedulerCallback.java @@ -0,0 +1,12 @@ +package it.aboutbits.springboot.emailservice.lib; + +public interface EmailSchedulerCallback { + void report(Report report); + + record Report( + int totalAttempted, + int sent, + int errors + ) { + } +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/EmailState.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/EmailState.java new file mode 100644 index 0000000..f053425 --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/EmailState.java @@ -0,0 +1,7 @@ +package it.aboutbits.springboot.emailservice.lib; + +public enum EmailState { + PENDING, + SENT, + ERROR +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/application/EmailParameter.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/EmailParameter.java new file mode 100644 index 0000000..320b8cd --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/EmailParameter.java @@ -0,0 +1,62 @@ +package it.aboutbits.springboot.emailservice.lib.application; + +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.NotEmpty; +import lombok.Builder; +import lombok.NonNull; +import lombok.Singular; +import org.springframework.lang.Nullable; + +import java.time.OffsetDateTime; +import java.util.List; +import java.util.Set; + +@Builder +public record EmailParameter( + @NonNull OffsetDateTime scheduleAt, + + @NonNull Email email, + + @Nullable String reference +) { + + @Builder + public record Email( + @NonNull + @NotBlank + String subject, + + @Singular + @NonNull + @NotEmpty + List recipients, + + @NonNull String textBody, + @NonNull String htmlBody, + + @NonNull + @NotBlank + String fromAddress, + @NonNull + @NotBlank + String fromName, + + @Singular + @NonNull + Set attachments + ) { + @Builder + public record Attachment( + @NonNull + @NotBlank + String reference, + @NonNull + @NotBlank + String fileName, + @NonNull + @NotBlank + String contentType + ) { + } + } +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/application/ManageEmail.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/ManageEmail.java new file mode 100644 index 0000000..73f24ab --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/ManageEmail.java @@ -0,0 +1,138 @@ +package it.aboutbits.springboot.emailservice.lib.application; + + +import it.aboutbits.springboot.emailservice.lib.AttachmentDataSource; +import it.aboutbits.springboot.emailservice.lib.EmailState; +import it.aboutbits.springboot.emailservice.lib.jpa.EmailRepository; +import it.aboutbits.springboot.emailservice.lib.model.Email; +import it.aboutbits.springboot.emailservice.lib.model.EmailAttachment; +import jakarta.mail.MessagingException; +import jakarta.validation.Valid; +import lombok.NonNull; +import lombok.extern.log4j.Log4j2; +import org.springframework.core.io.ByteArrayResource; +import org.springframework.mail.javamail.JavaMailSender; +import org.springframework.mail.javamail.MimeMessageHelper; +import org.springframework.validation.annotation.Validated; + +import java.io.IOException; +import java.time.OffsetDateTime; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + + +@Validated +@Log4j2 +public class ManageEmail { + private final EmailRepository emailNotificationRepository; + private final JavaMailSender mailSender; + private final AttachmentDataSource attachmentDataSource; + + public ManageEmail( + EmailRepository emailNotificationRepository, + JavaMailSender mailSender, + AttachmentDataSource attachmentDataSource + ) { + + this.emailNotificationRepository = emailNotificationRepository; + this.mailSender = mailSender; + this.attachmentDataSource = attachmentDataSource; + } + + public Email schedule(@NonNull @Valid EmailParameter parameter) { + var emailData = parameter.email(); + + var email = new Email(); + email.setState(EmailState.PENDING); + email.setSendingScheduledAt(parameter.scheduleAt()); + email.setReference(parameter.reference()); + email.setSubject(emailData.subject()); + email.setTextBody(emailData.textBody()); + email.setHtmlBody(emailData.htmlBody()); + email.setRecipients(emailData.recipients()); + email.setFromAddress(emailData.fromAddress()); + email.setFromName(emailData.fromName()); + email.setAttachments(emailData.attachments().stream() + .map(a -> { + var attachment = new EmailAttachment(); + attachment.setReference(a.reference()); + attachment.setContentType(a.contentType()); + attachment.setFileName(a.fileName()); + return attachment; + }) + .collect(Collectors.toSet()) + ); + + email = emailNotificationRepository.save(email); + + return email; + } + + Email send(Email notification) { + if (EmailState.SENT.equals(notification.getState())) { + return notification; + } + + try { + sendMail(notification); + notification.setState(EmailState.SENT); + notification.setErrorMessage(""); + notification.setSentAt(OffsetDateTime.now()); + } catch (MessagingException | IOException e) { + log.error("Failed to send email", e); + notification.setErrorMessage(e.getMessage()); + notification.setState(EmailState.ERROR); + } + + var updatedNotification = emailNotificationRepository.save(notification); + + if (updatedNotification.isSent()) { + cleanupAttachments(notification); + } + + return updatedNotification; + } + + private void cleanupAttachments(final Email notification) { + notification.getAttachments().forEach(a -> attachmentDataSource.releaseAttachment(a.getReference())); + } + + + private void sendMail(Email notification) throws MessagingException, IOException { + sendMail( + notification.getFromAddress(), + notification.getFromName(), + notification.getRecipients(), + notification.getSubject(), + notification.getHtmlBody(), + notification.getTextBody(), + notification.getAttachments() + ); + } + + private void sendMail(String fromAddress, String fromName, List recipients, String subject, String htmlBody, String plainTextBody, Set attachments) throws MessagingException, IOException { + var message = mailSender.createMimeMessage(); + var helper = new MimeMessageHelper(message, true, "UTF-8"); + + helper.setFrom(fromAddress, fromName); + helper.setTo(recipients.toArray(String[]::new)); + helper.setSubject(subject); + + if (!htmlBody.isBlank()) { + helper.setText(plainTextBody, htmlBody); + } else { + helper.setText(plainTextBody); + } + + if (!attachments.isEmpty()) { + for (var attachment : attachments) { + var payload = attachmentDataSource.getAttachmentPayload(attachment.getReference()); + helper.addAttachment(attachment.getFileName(), new ByteArrayResource(payload.readAllBytes())); + payload.close(); + } + } + + mailSender.send(message); + } +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/application/QueryEmail.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/QueryEmail.java new file mode 100644 index 0000000..a315ca5 --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/QueryEmail.java @@ -0,0 +1,42 @@ +package it.aboutbits.springboot.emailservice.lib.application; + + +import it.aboutbits.springboot.emailservice.lib.EmailState; +import it.aboutbits.springboot.emailservice.lib.jpa.EmailRepository; +import it.aboutbits.springboot.emailservice.lib.model.Email; +import lombok.RequiredArgsConstructor; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.PageRequest; +import org.springframework.data.domain.Sort; + +import java.time.OffsetDateTime; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Optional; + +@RequiredArgsConstructor +public class QueryEmail { + private final EmailRepository emailNotificationRepository; + + public Page paginatedByState(final EmailState state, final PageRequest pageParameter) { + var pageRequest = PageRequest.of(pageParameter.getPageNumber(), pageParameter.getPageSize(), Sort.by("updatedAt")); + + return emailNotificationRepository.findByState(state, pageRequest); + } + + public List byIds(final Collection ids) { + if (ids.isEmpty()) { + return Collections.emptyList(); + } + return emailNotificationRepository.findByIdIn(ids); + } + + public List readyToSend() { + return emailNotificationRepository.findReadyToSend(OffsetDateTime.now()); + } + + public Optional byId(final long id) { + return emailNotificationRepository.findById(id); + } +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/application/SendScheduledEmails.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/SendScheduledEmails.java new file mode 100644 index 0000000..fbe5fba --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/SendScheduledEmails.java @@ -0,0 +1,50 @@ +package it.aboutbits.springboot.emailservice.lib.application; + + +import it.aboutbits.springboot.emailservice.lib.EmailSchedulerCallback; +import lombok.AllArgsConstructor; +import lombok.extern.log4j.Log4j2; +import org.springframework.scheduling.annotation.Scheduled; + +import java.util.List; + +@AllArgsConstructor +@Log4j2 +public class SendScheduledEmails { + private static final String JOB_DESCRIPTION = "Sending open and failed email notifications."; + + private final QueryEmail queryEmail; + private final ManageEmail manageEmail; + private final List callbacks; + + @Scheduled(initialDelayString = "${lib.emailservice.scheduling.interval:30000}", fixedDelayString = "${lib.emailservice.scheduling.interval:30000}") + void sendEmailNotifications() { + log.info("Start: " + JOB_DESCRIPTION); + + var emailsToSend = queryEmail.readyToSend(); + + var countSent = 0; + var countError = 0; + for (var email : emailsToSend) { + var updatedEmail = manageEmail.send(email); + switch (updatedEmail.getState()) { + case ERROR -> countError++; + case SENT -> countSent++; + default -> log.warn( + "Email job produced an invalid notification result state: {}.", + updatedEmail.getState().name()); + } + } + + log.info("Finished: " + JOB_DESCRIPTION); + log.info("Sent: {}, Errors: {}", countSent, countError); + + for (var callback : callbacks) { + callback.report(new EmailSchedulerCallback.Report( + emailsToSend.size(), + countSent, + countError + )); + } + } +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/application/UnavailableAttachmentDataSource.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/UnavailableAttachmentDataSource.java new file mode 100644 index 0000000..3308e68 --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/UnavailableAttachmentDataSource.java @@ -0,0 +1,17 @@ +package it.aboutbits.springboot.emailservice.lib.application; + +import it.aboutbits.springboot.emailservice.lib.AttachmentDataSource; + +import java.io.InputStream; + +public final class UnavailableAttachmentDataSource implements AttachmentDataSource { + @Override + public InputStream getAttachmentPayload(final String reference) { + throw new RuntimeException("attachments not available"); + } + + @Override + public void releaseAttachment(final String reference) { + throw new RuntimeException("attachments not available"); + } +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/application/package-info.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/package-info.java new file mode 100644 index 0000000..20c8675 --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/application/package-info.java @@ -0,0 +1,6 @@ +@NonNullApi +@NonNullFields +package it.aboutbits.springboot.emailservice.lib.application; + +import org.springframework.lang.NonNullApi; +import org.springframework.lang.NonNullFields; diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/jpa/EmailRepository.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/jpa/EmailRepository.java new file mode 100644 index 0000000..b2efee1 --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/jpa/EmailRepository.java @@ -0,0 +1,27 @@ +package it.aboutbits.springboot.emailservice.lib.jpa; + + +import it.aboutbits.springboot.emailservice.lib.EmailState; +import it.aboutbits.springboot.emailservice.lib.model.Email; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.PageRequest; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.jpa.repository.Query; + +import java.time.OffsetDateTime; +import java.util.Collection; +import java.util.List; + +public interface EmailRepository extends JpaRepository { + Page findByState(EmailState state, PageRequest pageRequest); + + @Query(""" + SELECT e from Email e WHERE e.sendingScheduledAt < :scheduledBefore AND e.state IN ( + it.aboutbits.springboot.emailservice.lib.EmailState.PENDING, + it.aboutbits.springboot.emailservice.lib.EmailState.ERROR + ) + """) + List findReadyToSend(OffsetDateTime scheduledBefore); + + List findByIdIn(Collection ids); +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/model/Email.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/model/Email.java new file mode 100644 index 0000000..030fd7e --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/model/Email.java @@ -0,0 +1,75 @@ +package it.aboutbits.springboot.emailservice.lib.model; + +import it.aboutbits.springboot.emailservice.lib.EmailState; +import jakarta.persistence.CascadeType; +import jakarta.persistence.Entity; +import jakarta.persistence.EnumType; +import jakarta.persistence.Enumerated; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.NamedAttributeNode; +import jakarta.persistence.NamedEntityGraph; +import jakarta.persistence.OneToMany; +import jakarta.persistence.Table; +import lombok.Getter; +import lombok.Setter; +import org.hibernate.annotations.CreationTimestamp; +import org.hibernate.annotations.JdbcTypeCode; +import org.hibernate.annotations.UpdateTimestamp; +import org.hibernate.type.SqlTypes; + +import java.time.OffsetDateTime; +import java.util.List; +import java.util.Set; + +@NamedEntityGraph( + name = "email_service_emails-entity-graph", + attributeNodes = { + @NamedAttributeNode("recipients") + } +) +@Entity +@Getter +@Setter +@Table(name = "email_service_emails") +public class Email { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @Enumerated(EnumType.STRING) + private EmailState state; + + private String subject; + + private String fromAddress; + private String fromName; + + @JdbcTypeCode(SqlTypes.JSON) + private List recipients; + + private String textBody; + private String htmlBody; + + @OneToMany(cascade = CascadeType.ALL, mappedBy = "email", orphanRemoval = true) + private Set attachments; + + private String reference; + + private OffsetDateTime sendingScheduledAt; + private OffsetDateTime sentAt; + + private OffsetDateTime errorAt; + private String errorMessage; + + @CreationTimestamp + private OffsetDateTime createdAt; + + @UpdateTimestamp + private OffsetDateTime updatedAt; + + public boolean isSent() { + return EmailState.SENT.equals(state); + } +} diff --git a/src/main/java/it/aboutbits/springboot/emailservice/lib/model/EmailAttachment.java b/src/main/java/it/aboutbits/springboot/emailservice/lib/model/EmailAttachment.java new file mode 100644 index 0000000..021784a --- /dev/null +++ b/src/main/java/it/aboutbits/springboot/emailservice/lib/model/EmailAttachment.java @@ -0,0 +1,31 @@ +package it.aboutbits.springboot.emailservice.lib.model; + +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.JoinColumn; +import jakarta.persistence.ManyToOne; +import jakarta.persistence.Table; +import lombok.Getter; +import lombok.Setter; + +@Entity +@Getter +@Setter +@Table(name = "email_service_email_attachments") +public class EmailAttachment { + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @ManyToOne + @JoinColumn(name = "email_id") + private Email email; + + private String fileName; + + private String contentType; + + private String reference; +} diff --git a/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/src/main/resources/META-INF/additional-spring-configuration-metadata.json new file mode 100644 index 0000000..128d011 --- /dev/null +++ b/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -0,0 +1,16 @@ +{ + "properties": [ + { + "name": "lib.emailservice.scheduling.enabled", + "type": "java.lang.Boolean", + "description": "Enables the scheduler sending the emails.", + "defaultValue": true + }, + { + "name": "lib.emailservice.scheduling.interval", + "type": "java.lang.Long", + "description": "Specifies the milliseconds delay between runs of the scheduler.", + "defaultValue": 30000 + } + ] +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..3ece23f --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,14 @@ +spring: + mail: + default-encoding: UTF-8 + host: ${MAIL_HOST:localhost} + username: ${MAIL_USERNAME:null} + password: ${MAIL_PASSWORD:null} + port: ${MAIL_PORT:1025} + protocol: smtp + properties: + mail: + smtp: + auth: ${MAIL_SSL:false} + starttls: + enable: ${MAIL_SSL:false} diff --git a/src/main/resources/db/changelog/emailservice/2023-01-30-create-email-tables.xml b/src/main/resources/db/changelog/emailservice/2023-01-30-create-email-tables.xml new file mode 100644 index 0000000..93bec1f --- /dev/null +++ b/src/main/resources/db/changelog/emailservice/2023-01-30-create-email-tables.xml @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ALTER TABLE email_service_emails + ADD CONSTRAINT email_service_emails_one_body_not_empty CHECK ( + (text_body != '') + OR (html_body != '') + ) + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/main/resources/db/changelog/emailservice/main.xml b/src/main/resources/db/changelog/emailservice/main.xml new file mode 100644 index 0000000..271ffbc --- /dev/null +++ b/src/main/resources/db/changelog/emailservice/main.xml @@ -0,0 +1,9 @@ + + + + +