preparation : set code base

Author: patternhelloworld

.docker/entrypoint/run-app.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Graceful Shutdown
+#trap exitHandler EXIT
+#exitHandler() {
+ #   echo "[INSIDE APP CONTAINER][WARN] Server will be shutdown soon." 1>&2
+  #  kill -TERM $(jps | grep jar | awk '{print $1}')
+#}
+
+if [ -z "$1" ]; then
+    echo "[INSIDE APP CONTAINER][ERROR] No project root path parameter found for the 'run-app.sh'"
+    exit 1
+fi
+if [ -z "$2" ]; then
+    echo "[INSIDE APP CONTAINER][ERROR] No file root path parameter found for the 'run-app.sh'"
+    exit 1
+fi
+if [ -z "$3" ]; then
+    echo "[INSIDE APP CONTAINER][ERROR] No Xms parameter found for the 'run-app.sh'"
+    exit 1
+fi
+if [ -z "$4" ]; then
+    echo "[INSIDE APP CONTAINER][ERROR] No Xmx parameter found for the 'run-app.sh'"
+    exit 1
+fi
+
+echo "[INSIDE APP CONTAINER][NOTICE] Run : java -Xms${3}m -Xmx${4}m -XX:+PrintGCDetails -Xloggc:${2}/logs/auth-gc.log -Dspring.config.location=file:${1}/src/main/resources/application.properties -Dlogging.config=file:${1}/src/main/resources/logback-spring.xml -jar /app.jar > ${2}/logs/auth-start.log 2>&1 &"
+java -XX:+PrintGCDetails -Xms${3}m -Xmx${4}m -Xloggc:${2}/logs/auth-gc.log -Dspring.config.location=file:${1}/src/main/resources/application.properties -Dlogging.config=file:${1}/src/main/resources/logback-spring.xml -jar /app.jar > ${2}/logs/auth-start.log 2>&1 &

.docker/ssl/.gitkeep

@@ -0,0 +1,45 @@
+/.docker/ssl/*
+!/.docker/ssl/.gitkeep
+
+/target/
+
+# docker
+/.docker/env/*
+!/.docker/env/.gitkeep
+/.docker/ssh/*
+!/.docker/ssh/.gitkeep
+
+### STS ###
+/.apt_generated
+/.classpath
+/.factorypath
+/.project
+/.settings
+/.springBeans
+/.sts4-cache
+
+# Mac
+/.DS_Store
+
+
+### IntelliJ IDEA ###
+/.idea
+/*.iws
+/*.iml
+/*.ipr
+
+# logs
+/logs/*
+!/logs/.gitkeep
+
+# files
+/files/*
+!/files/.gitkeep
+
+# .properties
+#/src/main/resources/application.properties
+
+# logback
+#/src/main/resources/logback-spring.xml
+
+

.gitignore

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2007-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import java.net.*;
+import java.io.*;
+import java.nio.channels.*;
+import java.util.Properties;
+
+public class MavenWrapperDownloader {
+
+    private static final String WRAPPER_VERSION = "0.5.6";
+    /**
+     * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
+     */
+    private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
+        + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
+
+    /**
+     * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
+     * use instead of the default one.
+     */
+    private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
+            ".mvn/wrapper/maven-wrapper.properties";
+
+    /**
+     * Path where the maven-wrapper.jar will be saved to.
+     */
+    private static final String MAVEN_WRAPPER_JAR_PATH =
+            ".mvn/wrapper/maven-wrapper.jar";
+
+    /**
+     * Name of the property which should be used to override the default download url for the wrapper.
+     */
+    private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
+
+    public static void main(String args[]) {
+        System.out.println("- Downloader started");
+        File baseDirectory = new File(args[0]);
+        System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
+
+        // If the maven-wrapper.properties exists, read it and check if it contains a custom
+        // wrapperUrl parameter.
+        File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
+        String url = DEFAULT_DOWNLOAD_URL;
+        if(mavenWrapperPropertyFile.exists()) {
+            FileInputStream mavenWrapperPropertyFileInputStream = null;
+            try {
+                mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
+                Properties mavenWrapperProperties = new Properties();
+                mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
+                url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
+            } catch (IOException e) {
+                System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
+            } finally {
+                try {
+                    if(mavenWrapperPropertyFileInputStream != null) {
+                        mavenWrapperPropertyFileInputStream.close();
+                    }
+                } catch (IOException e) {
+                    // Ignore ...
+                }
+            }
+        }
+        System.out.println("- Downloading from: " + url);
+
+        File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
+        if(!outputFile.getParentFile().exists()) {
+            if(!outputFile.getParentFile().mkdirs()) {
+                System.out.println(
+                        "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
+            }
+        }
+        System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
+        try {
+            downloadFileFromURL(url, outputFile);
+            System.out.println("Done");
+            System.exit(0);
+        } catch (Throwable e) {
+            System.out.println("- Error downloading");
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private static void downloadFileFromURL(String urlString, File destination) throws Exception {
+        if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+            String username = System.getenv("MVNW_USERNAME");
+            char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+            Authenticator.setDefault(new Authenticator() {
+                @Override
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication(username, password);
+                }
+            });
+        }
+        URL website = new URL(urlString);
+        ReadableByteChannel rbc;
+        rbc = Channels.newChannel(website.openStream());
+        FileOutputStream fos = new FileOutputStream(destination);
+        fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+        fos.close();
+        rbc.close();
+    }
+
+}

.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,2 @@
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar

.mvn/wrapper/maven-wrapper.jar

@@ -1,13 +1,13 @@
 # Spring Security Oauth2 Password JPA Implementation
 ## Overview
 
-* In the Spring Security 6 ecosystem, compared to 5, there is a preference for JSON Web Tokens and Keycloak over traditional OAuth2, and for the Authorization Code flow over the Password Grant method. In this context, the OAuth2 Password Grant method has been implemented with the following advantages:
+* In the Spring Security 6 ecosystem, compared to 5, there is a preference for Jwt or Keycloak over traditional OAuth2, and for the Authorization Code flow over the Password Grant method. In this context, the OAuth2 Password Grant method has been implemented with the following advantages:
 
-  * Implemented using JPA.
-  * Authentication management based on a combination of username, client id, and an extra token (referred to in the source code as APP TOKEN, which receives a unique value from the calling devices).
+  * Set up access & refresh token API on both ``/oauth2/token`` and on the controller layer, both of which function same. 
+  * Authentication management based on a combination of username, client id, and an extra token (referred to in the source code as ``App-Token``, which receives a unique value from the calling devices).
   * Separated UserDetails implementation for Admin and Customer roles.
   * Integration with spring-security-oauth2-authorization-server.
-  * Provision of MySQL DDL.
+    * Provision of MySQL DDL, which consists of ``oauth_access_token``, ``oauth_refresh_token`` and ``oauth_client_details``
   * Application of Spring Rest Docs.
 
 ## Dependencies
@@ -18,4 +18,17 @@
 | Backend-Framework | Spring Boot 3.1.2                          |
 | Main Libraries    | Spring Security Authorization Server 1.2.3 |
 | Package-Manager   | Maven 3.6.3 (mvnw, Dockerfile)             |
-| RDBMS             | Mysql 8.0.17                               |
+| RDBMS             | Mysql 8.0.17                               |
+
+## Implementation
+
+#### Import the SQL file in the ``mysql`` folder.
+
+#### The API information is on ``src/main/asciidoc/api-app.adoc``, managed by Spring Rest Doc.
+
+
+
+### Running this App with Docker
+* Use the following module for Blue-Green deployment:
+  * https://github.com/Andrew-Kang-G/docker-blue-green-runner
+* The above module references this app's Dockerfile and the entrypoint script in the .docker folder.