Merge pull request #20 from cryptlex/borrowing-develop

ahmad-kemsan · web-flow · commit 84ea24e3f389 · 2024-08-06T12:24:29.000+05:30
Borrowing develop
diff --git a/pom.xml b/pom.xml
@@ -43,6 +43,11 @@
             <artifactId>jna</artifactId>
             <version>5.10.0</version>
         </dependency>
+        <dependency>
+        <groupId>com.fasterxml.jackson.core</groupId>
+        <artifactId>jackson-databind</artifactId>
+        <version>2.14.2</version>
+        </dependency>
     </dependencies>
 
     <distributionManagement>
diff --git a/src/main/java/com/cryptlex/lexfloatclient/HostConfig.java b/src/main/java/com/cryptlex/lexfloatclient/HostConfig.java
@@ -0,0 +1,5 @@
+package com.cryptlex.lexfloatclient;
+
+public class HostConfig {
+    public String maxOfflineLeaseDuration;
+}
diff --git a/src/main/java/com/cryptlex/lexfloatclient/LexFloatClient.java b/src/main/java/com/cryptlex/lexfloatclient/LexFloatClient.java
@@ -6,6 +6,8 @@
 import java.nio.CharBuffer;
 import java.io.UnsupportedEncodingException;
 import com.sun.jna.ptr.IntByReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.core.JsonProcessingException;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -56,6 +58,28 @@ public static void SetHostUrl(String hostUrl) throws LexFloatClientException {
         }
     }
 
+    /**
+     * Sets the permission flag. This function must be called on every start of your program 
+     * after SetHostProductId() function in case the application allows borrowing of licenses 
+     * or system wide activation.
+     *
+     * @param flag depending on your application's requirements, choose one of 
+     * the following values: LF_USER, LF_ALL_USERS.
+     * <ul>
+     * <li> LF_USER: This flag indicates that the application does not require admin or root permissions to run.</li>
+     * <li> LF_ALL_USERS: This flag is specifically designed for Windows and should be used for system-wide activations.</li>
+     * </ul>
+     * @throws LexFloatClientException
+     */
+    public static void SetPermissionFlag(int flag) throws LexFloatClientException {
+        int status;
+        status = LexFloatClientNative.SetPermissionFlag(flag)
+                
+        if (LF_OK != status) {
+            throw new LexFloatClientException(status);
+        }
+    }
+
     /**
      * Sets the renew license callback function.<br>
      * Whenever the license lease is about to expire, a renew request is sent to
@@ -113,6 +137,24 @@ public static void SetFloatingClientMetadata(String key, String value) throws Le
         }
     }
 
+    /**
+     * Gets the lease expiry date timestamp of the floating client.
+     *
+     * @return Returns the timestamp
+     * @throws LexFloatClientException
+     */
+    public static int GetFloatingClientLeaseExpiryDate() throws LexFloatClientException {
+        int status;
+        IntByReference expiryDate = new IntByReference(0);
+        status = LexFloatClientNative.GetFloatingClientLeaseExpiryDate(expiryDate);
+        switch (status) {
+            case LF_OK:
+                return expiryDate.getValue();
+            default:
+                throw new LexFloatClientException(status);
+        }
+    }
+
     /**
      * Gets the version of this library.
      * 
@@ -138,6 +180,53 @@ public static String GetFloatingClientLibraryVersion() throws LexFloatClientExce
         throw new LexFloatClientException(status);
     }
 
+    /**
+     * Gets the host configuration.
+     * This function sends a network request to LexFloatServer to get the configuration details.
+     
+     * @return Returns host configuration.
+     * @throws LexFloatClientException
+     * @throws UnsupportedEncodingException
+     */
+    public static HostConfig GetHostConfig() throws LexFloatClientException, UnsupportedEncodingException {
+        int status;
+        int bufferSize = 1024;
+        if (Platform.isWindows()) {
+            CharBuffer buffer = CharBuffer.allocate(bufferSize);
+            status = LexFloatClientNative.GetHostConfigInternal(buffer, bufferSize);
+            if (LF_OK == status) {
+                String hostConfigJson = buffer.toString().trim();
+                if (!hostConfigJson.isEmpty()) {
+                    HostConfig hostConfig = null;
+                    ObjectMapper objectMapper = new ObjectMapper();
+                    try {
+                        hostConfig = objectMapper.readValue(hostConfigJson, HostConfig.class);
+                    } catch (JsonProcessingException e) {}
+                    return hostConfig;
+                } else {
+                    return null;
+                } 
+            }
+        } else {
+            ByteBuffer buffer = ByteBuffer.allocate(bufferSize);
+            status = LexFloatClientNative.GetHostConfigInternal(buffer, bufferSize);
+            if (LF_OK == status) {
+                String hostConfigJson = new String(buffer.array(), "UTF-8").trim();
+                if (!hostConfigJson.isEmpty()) {
+                    HostConfig hostConfig = null;
+                    ObjectMapper objectMapper = new ObjectMapper();
+                    try {
+                        hostConfig = objectMapper.readValue(hostConfigJson, HostConfig.class);
+                    } catch (JsonProcessingException e) {}
+                    return hostConfig;
+                } else {
+                    return null;
+                } 
+            }
+        }
+        throw new LexFloatClientException(status);
+    }
+
     /**
      * Gets the product version name.
      * 
@@ -246,6 +335,32 @@ public static String GetHostLicenseMetadata(String key) throws LexFloatClientExc
         throw new LexFloatClientException(status);
     }
 
+    /**
+     * Get the value of the license metadata field associated with the LexFloatServer license.
+     *
+     * @param key key of the metadata field whose value you want to get
+     * @return Returns the metadata key value
+     * @throws LexFloatClientException
+     * @throws UnsupportedEncodingException
+     */
+    public static String GetFloatingClientMetadata(String key) throws LexFloatClientException, UnsupportedEncodingException {
+        int status;
+        if (Platform.isWindows()) {
+            CharBuffer buffer = CharBuffer.allocate(256);
+            status = LexFloatClientNative.GetFloatingClientMetadata(new WString(key), buffer, 256);
+            if (LF_OK == status) {
+                return buffer.toString().trim();
+            }
+        } else {
+            ByteBuffer buffer = ByteBuffer.allocate(256);
+            status = LexFloatClientNative.GetFloatingClientMetadata(key, buffer, 256);
+            if (LF_OK == status) {
+                return new String(buffer.array(), "UTF-8");
+            }
+        }
+        throw new LexFloatClientException(status);
+    }
+    
     /**
      * Gets the license meter attribute allowed uses and total uses associated 
      * with the LexFloatServer license.
@@ -293,6 +408,31 @@ public static int GetHostLicenseExpiryDate() throws LexFloatClientException {
         }
     }
 
+    /**
+     * Gets the mode of the floating license (online or offline).
+     * 
+     * @return mode - Returns the floating license mode.
+     * @throws LexFloatClientException
+     * @throws UnsupportedEncodingException
+     */
+    public static String GetFloatingLicenseMode() throws LexFloatClientException, UnsupportedEncodingException {
+        int status;
+        if (Platform.isWindows()) {
+            CharBuffer buffer = CharBuffer.allocate(256);
+            status = LexFloatClientNative.GetFloatingLicenseMode(buffer, 256);
+            if (LF_OK == status) {
+                return buffer.toString().trim();
+            }
+        } else {
+            ByteBuffer buffer = ByteBuffer.allocate(256);
+            status = LexFloatClientNative.GetFloatingLicenseMode(buffer, 256);
+            if (LF_OK == status) {
+                return new String(buffer.array(), "UTF-8").trim();
+            }
+        }
+        throw new LexFloatClientException(status);
+    }
+
     /**
      * Gets the meter attribute uses consumed by the floating client.
      *
@@ -318,6 +458,21 @@ public static int GetFloatingClientMeterAttributeUses(String name) throws LexFlo
         throw new LexFloatClientException(status);
     }
 
+    /**
+     * Sends the request to lease the license from the LexFloatServer for offline usage.
+     * The maximum value of lease duration is configured in the config.yml of LexFloatServer.
+     *
+     * @param leaseDuration value of the lease duration.
+     * @throws LexFloatClientException
+     */
+    public static void RequestOfflineFloatingLicense(int leaseDuration) throws LexFloatClientException {
+        int status;
+        status = LexFloatClientNative.RequestOfflineFloatingLicense(leaseDuration);
+        if (LF_OK != status) {
+            throw new LexFloatClientException(status);
+        }
+    }
+    
     /**
      * Sends the request to lease the license from the LexFloatServer
      *
diff --git a/src/main/java/com/cryptlex/lexfloatclient/LexFloatClientException.java b/src/main/java/com/cryptlex/lexfloatclient/LexFloatClientException.java
@@ -75,11 +75,32 @@ public static String getErrorMessage(int errorCode) {
             message = "No product version is linked with the license.";
             break;
         case LF_E_FEATURE_FLAG_NOT_FOUND:
-            message = "The product version feature flag does not exist.";
+            message = "The product version feature flag does not exist."; 
             break;
         case LF_E_IP:
             message = "IP address is not allowed.";
             break;
+        case LF_E_SYSTEM_PERMISSION:
+            message = "Insufficient system permissions.";
+            break;
+        case LF_E_INVALID_PERMISSION_FLAG:
+            message = "Invalid permission flag.";
+            break;
+        case LF_E_OFFLINE_FLOATING_LICENSE_NOT_ALLOWED:
+            message = "Offline floating license is not allowed for per-instance leasing strategy.";
+            break;
+        case LF_E_MAX_OFFLINE_LEASE_DURATION_EXCEEDED:
+            message = "Maximum offline lease duration exceeded.";
+            break;
+        case LF_E_ALLOWED_OFFLINE_FLOATING_CLIENTS_LIMIT_REACHED:
+            message = "Allowed offline floating clients limit reached.";
+            break;
+        case LF_E_WMIC:
+            message = "Fingerprint couldn't be generated because Windows Management Instrumentation (WMI) service has been disabled.";
+            break;
+        case LF_E_MACHINE_FINGERPRINT:
+            message = "Machine fingerprint has changed since activation.";
+            break;
         case LF_E_CLIENT:
             message = "Client error.";
             break;
@@ -101,13 +122,14 @@ public static String getErrorMessage(int errorCode) {
         case LF_E_SERVER_LICENSE_GRACE_PERIOD_OVER:
             message = "The grace period for server license is over.";
             break;
+        case LF_E_PROXY_NOT_TRUSTED:
+            message = "Request blocked due to untrusted proxy.";
+            break;
         default:
             message = "Unknown error!";
-
         }
         return message;
     }
-
     /*
      * CODE: LF_OK
      * 
@@ -245,25 +267,78 @@ public static String getErrorMessage(int errorCode) {
 
     /*
      * CODE: LF_E_PRODUCT_VERSION_NOT_LINKED
-     *
+     * 
      * MESSAGE: No product version is linked with the license.
      */
     public static final int LF_E_PRODUCT_VERSION_NOT_LINKED = 57;
 
     /*
      * CODE: LF_E_FEATURE_FLAG_NOT_FOUND
-     *
+     * 
      * MESSAGE: The product version feature flag does not exist.
      */
     public static final int LF_E_FEATURE_FLAG_NOT_FOUND = 58;
     
+    /*
+     * Insufficient system permissions.
+    */
+    public static final int LF_E_SYSTEM_PERMISSION = 59;
+    
     /*
      * CODE: LF_E_IP
      * 
      * MESSAGE: IP address is not allowed.
      */
     public static final int LF_E_IP = 60;
 
+    /*
+    * CODE: LF_E_INVALID_PERMISSION_FLAG
+    * 
+    * MESSAGE: Invalid permission flag.
+    */
+    public static final int LF_E_INVALID_PERMISSION_FLAG = 61;
+
+    /*
+    * CODE: LF_E_OFFLINE_FLOATING_LICENSE_NOT_ALLOWED
+    * 
+    * MESSAGE: Offline floating license is not allowed for per-instance leasing strategy.
+    */
+    public static final int LF_E_OFFLINE_FLOATING_LICENSE_NOT_ALLOWED = 62;
+
+    /*
+    * CODE: LF_E_MAX_OFFLINE_LEASE_DURATION_EXCEEDED
+    * 
+    * MESSAGE: Maximum offline lease duration exceeded.
+    */
+    public static final int LF_E_MAX_OFFLINE_LEASE_DURATION_EXCEEDED = 63;
+
+    /*
+    * CODE: LF_E_ALLOWED_OFFLINE_FLOATING_CLIENTS_LIMIT_REACHED
+    * 
+    * MESSAGE: Allowed offline floating clients limit reached.
+    */
+    public static final int LF_E_ALLOWED_OFFLINE_FLOATING_CLIENTS_LIMIT_REACHED = 64;
+
+    /*
+    * CODE: LF_E_WMIC
+    * 
+    * MESSAGE: Fingerprint couldn't be generated because Windows Management Instrumentation (WMI) service has been disabled.
+    */
+    public static final int LF_E_WMIC = 65;
+
+    /*
+    * CODE: LF_E_MACHINE_FINGERPRINT
+    * 
+    * MESSAGE: Machine fingerprint has changed since activation.
+    */
+    public static final int LF_E_MACHINE_FINGERPRINT = 66;
+    /*
+    * CODE: LF_E_PROXY_NOT_TRUSTED
+    *
+    * MESSAGE: Request blocked due to untrusted proxy.
+    */
+    public static final int LF_E_PROXY_NOT_TRUSTED = 67;
+
     /*
      * CODE: LF_E_CLIENT
      * 
@@ -313,4 +388,4 @@ public static String getErrorMessage(int errorCode) {
      * MESSAGE: The grace period for server license is over.
      */
     public static final int LF_E_SERVER_LICENSE_GRACE_PERIOD_OVER = 76;
-}
+}
diff --git a/src/main/java/com/cryptlex/lexfloatclient/LexFloatClientNative.java b/src/main/java/com/cryptlex/lexfloatclient/LexFloatClientNative.java
