Fix #1561: Refactor CreateDeviceRequest#platform into enum

pom.xml

@@ -94,7 +94,11 @@
         <bcprov-jdk18on.version>1.77</bcprov-jdk18on.version>
         <zxing.version>3.5.2</zxing.version>
         <passay.version>1.6.4</passay.version>
+
+        <!-- Documentation Dependencies -->
         <springdoc-openapi-starter-webmvc-ui.version>2.3.0</springdoc-openapi-starter-webmvc-ui.version>
+        <swagger-annotations-jakarta.version>2.2.20</swagger-annotations-jakarta.version>
+
         <guava.version>33.0.0-jre</guava.version>
         <moneta.version>1.4.2</moneta.version>
         <owasp-java-html-sanitizer.version>20220608.1</owasp-java-html-sanitizer.version>
@@ -293,6 +297,12 @@
                 <scope>provided</scope>
             </dependency>
 
+            <!-- Documentation -->
+            <dependency>
+                <groupId>io.swagger.core.v3</groupId>
+                <artifactId>swagger-annotations-jakarta</artifactId>
+                <version>${swagger-annotations-jakarta.version}</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>
 

powerauth-mtoken-model/pom.xml

@@ -39,6 +39,11 @@
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-annotations</artifactId>
         </dependency>
+
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-annotations-jakarta</artifactId>
+        </dependency>
     </dependencies>
 
 </project>

powerauth-mtoken-model/src/main/java/io/getlime/security/powerauth/lib/mtoken/model/request/PushRegisterRequest.java

@@ -17,44 +17,41 @@
  */
 package io.getlime.security.powerauth.lib.mtoken.model.request;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import lombok.Getter;
+import lombok.Setter;
+
 /**
  * Request to register for sending push messages.
  * @author Petr Dvorak, [email protected]
  */
+@Getter
+@Setter
 public class PushRegisterRequest {
 
-    private String platform;
-    private String token;
-
     /**
-     * Get mobile platform - "ios" / "android".
-     * @return Mobile platform.
+     * Platform
      */
-    public String getPlatform() {
-        return platform;
-    }
+    @NotNull
+    @Schema(description = "Platform.")
+    private Platform platform;
 
     /**
-     * Set mobile platform - "ios" / "android".
-     * @param platform Mobile platform.
+     *
      */
-    public void setPlatform(String platform) {
-        this.platform = platform;
-    }
+    @NotBlank
+    @Schema(description = "Push registration token.")
+    private String token;
 
-    /**
-     * Get push registration token.
-     * @return Push registration token.
-     */
-    public String getToken() {
-        return token;
-    }
+    public enum Platform {
+        @JsonProperty("ios")
+        IOS,
 
-    /**
-     * Set push registration token.
-     * @param token Push registration token.
-     */
-    public void setToken(String token) {
-        this.token = token;
+        @JsonProperty("android")
+        ANDROID
     }
+
 }

powerauth-webflow-authentication-mtoken/src/main/java/io/getlime/security/powerauth/lib/webflow/authentication/mtoken/controller/PushRegistrationController.java

@@ -140,7 +140,6 @@ private Response registerDeviceImpl(@RequestBody ObjectRequest<PushRegisterReque
         }
 
         // Get the values from the request
-        String platform = requestObject.getPlatform();
         String token = requestObject.getToken();
 
         // Check if the context is authenticated - if it is, add activation ID.
@@ -154,13 +153,9 @@ private Response registerDeviceImpl(@RequestBody ObjectRequest<PushRegisterReque
             throw new PushRegistrationFailedException();
         }
 
-        // Register the device and return response
-        MobilePlatform p = MobilePlatform.Android;
-        if ("ios".equalsIgnoreCase(platform)) {
-            p = MobilePlatform.iOS;
-        }
+        final MobilePlatform platform = convert(requestObject.getPlatform());
         try {
-            boolean result = pushServerClient.createDevice(applicationId, token, p, activationId);
+            boolean result = pushServerClient.createDevice(applicationId, token, platform, activationId);
             if (result) {
                 logger.info("Push registration succeeded, user ID: {}", apiAuthentication.getUserId());
                 return new Response();
@@ -174,4 +169,11 @@ private Response registerDeviceImpl(@RequestBody ObjectRequest<PushRegisterReque
         }
     }
 
+    private static MobilePlatform convert(final PushRegisterRequest.Platform source) {
+        return switch (source) {
+            case IOS -> MobilePlatform.IOS;
+            case ANDROID -> MobilePlatform.ANDROID;
+        };
+    }
+
 }