8 adapt to reference implementation

.github/workflows/ci.yml

@@ -12,6 +12,10 @@ on:
       - development
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+*'
+    paths-ignore:
+      - '**/*.md'   # Ignore markdown files
+      - '**/LICENSE' 
+      - 'scripts/**' 
   pull_request:
     branches:
       - main
@@ -23,6 +27,7 @@ on:
 
 jobs:
   build:
+    if: "!startsWith(github.event.head_commit.message, 'style:') && !startsWith(github.event.head_commit.message, 'docs:')"  #do not run workflow on style or documentation changes
     name: Build
     runs-on: ubuntu-latest
 
@@ -38,7 +43,7 @@ jobs:
           architecture: x64
 
       - name: Cache Maven dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}-${{ hashFiles('**/src/**') }}
@@ -57,12 +62,13 @@ jobs:
 
       - name: Save Maven build artifacts
         if: success()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: maven-artifacts
           path: target/
 
   test:
+    if: "!startsWith(github.event.head_commit.message, 'style:') && !startsWith(github.event.head_commit.message, 'docs:')"  #do not run workflow on style or documentation changes
     name: Test
     runs-on: ubuntu-latest
     needs: build  # Ensure build job runs before this one
@@ -77,7 +83,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Download build artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: maven-artifacts
 
@@ -89,7 +95,7 @@ jobs:
           architecture: x64
 
       - name: Cache Maven dependencies for tests
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ matrix.java-version }}-${{ hashFiles('**/pom.xml') }}-${{ hashFiles('**/src/**') }}
@@ -98,9 +104,10 @@ jobs:
 
       - name: Run test suite
         env:
-            CORBADO_API_SECRET: ${{ secrets.CORBADO_API_SECRET }}
-            CORBADO_PROJECT_ID: ${{ secrets.CORBADO_PROJECT_ID }}
-            CORBADO_BACKEND_API: ${{ vars.CORBADO_BACKEND_API }}
+          CORBADO_PROJECT_ID: ${{ secrets.CORBADO_PROJECT_ID }}
+          CORBADO_API_SECRET: ${{ secrets.CORBADO_API_SECRET }}
+          CORBADO_FRONTEND_API: ${{ vars.CORBADO_FRONTEND_API }}
+          CORBADO_BACKEND_API: ${{ vars.CORBADO_BACKEND_API }}
         run: mvn --batch-mode --update-snapshots verify -DskipInstall
 
   deploy:
@@ -114,7 +121,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Download build artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: maven-artifacts
 
@@ -128,7 +135,7 @@ jobs:
           server-id: central
 
       - name: Cache Maven dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}-${{ hashFiles('**/src/**') }}

README.md

@@ -27,7 +27,7 @@ You can find the latest SDK version at [central repository](https://repo1.maven.
 Add this dependency to your project's build file:
 
 ```groovy
-implementation "com.corbado:corbado-java:1.0.4"
+implementation "com.corbado:corbado-java:2.0.0b"
 ```
 
 #### Maven users
@@ -38,7 +38,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.corbado</groupId>
   <artifactId>corbado-java</artifactId>
-  <version>1.0.4</version>
+  <version>2.0.0b</version>
 </dependency>
 ```
 

VERSION

@@ -1 +1 @@
-1.0.4
+2.0.0b

pom.xml

@@ -3,7 +3,7 @@
     <groupId>com.corbado</groupId>
     <artifactId>corbado-java</artifactId>
     <packaging>jar</packaging>
-    <version>1.0.4</version>
+    <version>2.0.0b</version>
     <name>Corbado Java</name>
     <description>Corbado Java SDK</description>
     <url>https://github.com/corbado/corbado-java</url>

src/main/java/com/corbado/enums/exception/ValidationErrorType.java

@@ -0,0 +1,49 @@
+package com.corbado.enums.exception;
+
+import com.corbado.exceptions.TokenValidationException;
+
+/** Enum representing error types for {@link TokenValidationException}. */
+public enum ValidationErrorType {
+
+  /** The invalid token. */
+  CODE_INVALID_TOKEN("Invalid token"),
+
+  /** The empty session token. */
+  CODE_EMPTY_SESSION_TOKEN("Session token is empty"),
+
+  /** The empty issuer. */
+  CODE_EMPTY_ISSUER("Issuer is empty"),
+
+  CODE_JWT_BEFORE("Token is not valid yet"),
+
+  CODE_JWT_EXPIRED("Token is expired"),
+
+  CODE_INVALID_PUBLIC_KEY("Public key is invalid"),
+
+  CODE_JWT_INVALID_SIGNATURE("Token signature is invalid"),
+
+  /** The issuer missmatch. */
+  CODE_ISSUER_MISSMATCH("Token issuer does not match");
+
+  /** The description. */
+  private final String description;
+
+  /**
+   * Instantiates a new validation error type.
+   *
+   * @param description the description
+   */
+  ValidationErrorType(final String description) {
+    this.description = description;
+  }
+
+  /**
+   * To string.
+   *
+   * @return the string
+   */
+  @Override
+  public String toString() {
+    return this.description;
+  }
+}

src/main/java/com/corbado/exceptions/CorbadoServerException.java

@@ -1,12 +1,10 @@
 package com.corbado.exceptions;
 
+import com.corbado.generated.invoker.ApiException;
+import com.google.gson.Gson;
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
-
-import com.corbado.generated.invoker.ApiException;
-import com.google.gson.Gson;
-
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.Getter;

src/main/java/com/corbado/exceptions/TokenValidationException.java

@@ -0,0 +1,67 @@
+package com.corbado.exceptions;
+
+import com.corbado.enums.exception.ValidationErrorType;
+import lombok.Getter;
+
+/**
+ * TokenValidationException is a custom exception used to indicate issues during token validation.
+ * This exception is typically thrown when the token's issuer, format, or other key attributes do
+ * not meet the expected validation criteria.
+ *
+ * <p>This exception wraps a specific {@link ValidationErrorType} enum value to categorize the type
+ * of validation error encountered, and it provides a descriptive message detailing the reason for
+ * the exception. Additionally, it can wrap an underlying exception that caused the validation
+ * failure, allowing for more detailed error tracing.
+ *
+ * <p>Typical usage includes handling invalid token attributes, such as missing or mismatched
+ * issuers, empty tokens, or other validation failures.
+ *
+ * <p>Example usage:
+ *
+ * <pre>{@code
+ * try {
+ *     validateToken(token);
+ * } catch (SomeOtherException e) {
+ *     throw new TokenValidationException(ValidationErrorType.ISSUER_MISMATCH,
+ *         "Issuer mismatch (configured issuer: 'expected.com', JWT issuer: 'actual.com')", e);
+ * }
+ * }</pre>
+ *
+ * @see ValidationErrorType
+ */
+public class TokenValidationException extends RuntimeException {
+
+  /** The Constant serialVersionUID. */
+  @Getter private static final long serialVersionUID = -2978676337061777870L;
+
+  /** The error type. */
+  @Getter private final ValidationErrorType errorType;
+
+  /**
+   * Constructs a new TokenValidationException with a specified error type, a detailed message, and
+   * an optional original exception that caused this validation failure.
+   *
+   * @param errorType the type of validation error encountered, represented by {@link
+   *     ValidationErrorType}
+   * @param message a descriptive message providing additional context for the validation error
+   * @param cause the original exception that caused this validation failure, if any
+   */
+  public TokenValidationException(
+      final ValidationErrorType errorType, final String message, final Throwable cause) {
+    super(message, cause);
+    this.errorType = errorType;
+  }
+
+  /**
+   * Constructs a new TokenValidationException with a specified error type and detailed message,
+   * without an underlying cause.
+   *
+   * @param errorType the type of validation error encountered, represented by {@link
+   *     ValidationErrorType}
+   * @param message a descriptive message providing additional context for the validation error
+   */
+  public TokenValidationException(final ValidationErrorType errorType, final String message) {
+    super(message);
+    this.errorType = errorType;
+  }
+}

src/main/java/com/corbado/generated/api/AuthEventsApi.java

@@ -82,7 +82,8 @@ public void setCustomBaseUrl(String customBaseUrl) {
      * @return Call to execute
      * @throws ApiException If fail to serialize the request body object
      * @http.response.details
-     <table summary="Response Details" border="1">
+     <table border="1">
+       <caption>Response Details</caption>
         <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
         <tr><td> 200 </td><td> Auth event has been created </td><td>  -  </td></tr>
         <tr><td> 0 </td><td> Error </td><td>  -  </td></tr>
@@ -158,7 +159,8 @@ private okhttp3.Call authEventCreateValidateBeforeCall(String userID, AuthEventC
      * @return AuthEvent
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
      * @http.response.details
-     <table summary="Response Details" border="1">
+     <table border="1">
+       <caption>Response Details</caption>
         <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
         <tr><td> 200 </td><td> Auth event has been created </td><td>  -  </td></tr>
         <tr><td> 0 </td><td> Error </td><td>  -  </td></tr>
@@ -177,7 +179,8 @@ public AuthEvent authEventCreate(String userID, AuthEventCreateReq authEventCrea
      * @return ApiResponse&lt;AuthEvent&gt;
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
      * @http.response.details
-     <table summary="Response Details" border="1">
+     <table border="1">
+       <caption>Response Details</caption>
         <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
         <tr><td> 200 </td><td> Auth event has been created </td><td>  -  </td></tr>
         <tr><td> 0 </td><td> Error </td><td>  -  </td></tr>
@@ -198,7 +201,8 @@ public ApiResponse<AuthEvent> authEventCreateWithHttpInfo(String userID, AuthEve
      * @return The request call
      * @throws ApiException If fail to process the API call, e.g. serializing the request body object
      * @http.response.details
-     <table summary="Response Details" border="1">
+     <table border="1">
+       <caption>Response Details</caption>
         <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
         <tr><td> 200 </td><td> Auth event has been created </td><td>  -  </td></tr>
         <tr><td> 0 </td><td> Error </td><td>  -  </td></tr>