Updated README and license setting functionality

oleksii-unnamed · oleksii-unnamed · commit a5e2a25d6082 · 2022-06-23T12:37:31.000+03:00
diff --git a/Demos/Micronaut/LICENSE b/Demos/Micronaut/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 GroupDocs.Comparison Product Family
+
+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/Demos/Micronaut/README.md b/Demos/Micronaut/README.md
@@ -1,15 +1,145 @@
-## Micronaut 3.5.2 Documentation
+![GroupDocs.Comparison](https://raw.githubusercontent.com/groupdocs-comparison/groupdocs-comparison.github.io/master/resources/image/banner.png "GroupDocs.Comparison")
+# GroupDocs.Comparison Micronaut Example
+New GroupDocs.Comparison for Java UI Example
+###### version 22.3
 
-- [User Guide](https://docs.micronaut.io/3.5.2/guide/index.html)
-- [API Reference](https://docs.micronaut.io/3.5.2/api/index.html)
-- [Configuration Reference](https://docs.micronaut.io/3.5.2/guide/configurationreference.html)
-- [Micronaut Guides](https://guides.micronaut.io/index.html)
----
+[![GitHub license](https://img.shields.io/github/license/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring.svg)](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/blob/master/Demos/Micronaut/LICENSE)
 
-- [Shadow Gradle Plugin](https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow)
-## Feature http-client documentation
+## System Requirements
+- Java 11+ (JDK 11+)
 
-- [Micronaut HTTP Client documentation](https://docs.micronaut.io/latest/guide/index.html#httpClient)
 
+## Compare documents with Java API
 
-ANNOTATION PROCESSOR
+**GroupDocs.Comparison** is a library that allows you to **compare PDF, DOCX, PPT, XLS,** and over 90 other document formats. With GroupDocs.Comparison you will be able to compare two or more files, perform style and text comparison and generate a detailed report with changes.
+
+This application allows you to compare multiple documents and can be used as a standalone application or integrated as part of your project.
+
+**Note:** without a license application will run in trial mode, purchase [GroupDocs.Comparison for Java license](https://purchase.groupdocs.com/order-online-step-1-of-8.aspx) or request [GroupDocs.Comparison for Java temporary license](https://purchase.groupdocs.com/temporary-license).
+
+
+## Demo Video
+
+<p align="center">
+  <a title="Document comparison" href="https://www.youtube.com/watch?v=82RuvtV2qpw"> 
+    <img src="https://raw.githubusercontent.com/groupdocs-comparison/groupdocs-comparison.github.io/master/resources/image/comparison.gif" width="100%" style="width:100%;">
+  </a>
+</p>
+
+
+## Features
+#### GroupDocs.Comparison
+- Clean, modern and intuitive design
+- Easily switchable colour theme (create your own colour theme in 5 minutes)
+- Responsive design
+- Mobile support (open application on any mobile device)
+- HTML and image modes
+- Fully customizable navigation panel
+- Compare documents
+- Multi-compare several documents
+- Compare password protected documents
+- Upload documents
+- Display clearly visible differences
+- Download comparison results
+- Print comparison results
+- Smooth document scrolling
+- Preload pages for faster document rendering
+- Multi-language support for displaying errors
+- Cross-browser support (Safari, Chrome, Opera, Firefox)
+- Cross-platform support (Windows, Linux, MacOS)
+
+
+## How to run
+
+You can run this sample by one of following methods
+
+
+#### Run using IDE
+
+Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/releases/download/v22.3/groupdocs-comparison-micronaut-22.3.0.zip) from github or clone this repository.
+
+```bash
+git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java.git
+cd GroupDocs.Comparison-for-Java/Demos/Micronaut
+```
+Run IDE settings and enable **Annotation processor**
+Open project in IDE. Open `Application.kt` file and run `main` method inside it. Then open [http://localhost:8080/comparison/](http://localhost:8080/comparison/) in your favorite browser.
+
+#### Run from command line
+
+Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/archive/refs/heads/master.zip) from github.
+
+Alternatively you can clone this repository using next command
+```bash
+git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java.git
+```
+
+Run sample from Windows PowerShell or Linux Terminal using next commands
+
+```bash
+cd GroupDocs.Comparison-for-Java/Demos/Micronaut
+.\gradlew.bat :run
+```
+
+Open [http://localhost:8080/comparison/](http://localhost:8080/comparison/) in your favorite browser.
+
+#### Build distribution archive
+
+Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/archive/refs/heads/master.zip) from github.
+
+Alternatively you can clone this repository using next command
+```bash
+git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java.git
+```
+
+Run sample from Windows PowerShell or Linux Terminal using next commands
+
+```bash
+cd GroupDocs.Comparison-for-Java/Demos/Micronaut
+.\gradlew.bat :assembleDist
+```
+
+After that, go to `.\build\distributions\` directory to get distribution files.
+
+#### Binary release (with all dependencies) for Linux
+
+Download [latest release](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/releases/latest) from [releases page](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/releases).
+
+**Note**: This method is **recommended** for running this sample behind firewall.
+
+```bash
+curl -J -L -o release.tar.gz https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/releases/download/v22.3/groupdocs-comparison-micronaut-22.3.0.tar
+tar -xvzf release.tar.gz
+cd release/comparison-micronaut-22.3
+## Make `bin/comparison-micronaut` file to be runnable
+bin/comparison-micronaut
+## Open http://localhost:8080/comparison/ in your favorite browser.
+```
+
+## Configuration
+You can adjust settings in `/src/main/resources/application.conf`. Specify relative/absolute path to license file by setting `licensePath` value in `/src/main/resources/application.conf` or by setting up `LIC_PATH` environment variable
+
+### Comparison configuration options
+
+| Option                 | Type    |     Default value     | Description                                                                                                          |
+|------------------------| ------- |:---------------------:|:---------------------------------------------------------------------------------------------------------------------|
+| **`filesDirectory`**   | String  |   `DocumentSamples`   | Files directory path. Indicates where uploaded and predefined files are stored. It can be absolute or relative path  |
+| **`tempDirectory`**    | String  | system temp directory | Absolute or relative path to directory to save temporary files                                                       |
+| **`resultDirectory`**  | String  |     `ResultFiles`     | Result files directory path. Directory must be created before app starts                                             |
+
+## License
+The MIT License (MIT).
+
+Please have a look at the LICENSE.md for more details
+
+## GroupDocs Comparison on other platforms & frameworks
+
+- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Compose) with Kotlin in Compose Desktop application
+- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Javalin) with Javalin application
+- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Ktor) with Ktor application
+- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Spring) with Spring application
+- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-MVC) with .NET MVC
+- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-WebForms) with .NET WebForms
+
+
+[Home](https://www.groupdocs.com/) | [Product Page](https://products.groupdocs.com/comparison/java) | [Documentation](https://docs.groupdocs.com/comparison/java/) | [Demos](https://products.groupdocs.app/comparison/family) | [API Reference](https://apireference.groupdocs.com/java/comparison) | [Examples](https://github.com/groupdocs-comparison/GroupDocs.comparison-for-Java/tree/master/Examples) | [Blog](https://blog.groupdocs.com/category/comparison/) | [Free Support](https://forum.groupdocs.com/c/comparison) | [Temporary License](https://purchase.groupdocs.com/temporary-license)
diff --git a/Demos/Micronaut/build.gradle.kts b/Demos/Micronaut/build.gradle.kts
@@ -39,6 +39,11 @@ dependencies {
 application {
     mainClass.set("com.groupdocs.ui.ApplicationKt")
 }
+
+tasks {
+    create("stage").dependsOn("installDist")
+}
+
 java {
     sourceCompatibility = JavaVersion.toVersion("11")
 }
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/Application.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/Application.kt
@@ -4,5 +4,4 @@ import io.micronaut.runtime.Micronaut.run
 
 fun main(args: Array<String>) {
     run(*args)
-}
-
+}
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/compare/CompareController.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/compare/CompareController.kt
@@ -9,8 +9,10 @@ import io.micronaut.http.annotation.Controller
 import io.micronaut.http.annotation.Post
 import io.micronaut.http.annotation.Produces
 import jakarta.inject.Inject
+import jakarta.inject.Singleton
 import kotlinx.coroutines.runBlocking
 
+@Singleton
 @Controller("/comparison")
 class CompareController(
     @Inject private val compareBean: CompareBean
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/config/ConfigController.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/config/ConfigController.kt
@@ -7,8 +7,10 @@ import io.micronaut.http.annotation.Controller
 import io.micronaut.http.annotation.Get
 import io.micronaut.http.annotation.Produces
 import jakarta.inject.Inject
+import jakarta.inject.Singleton
 import kotlinx.coroutines.runBlocking
 
+@Singleton
 @Controller("/comparison")
 class ConfigController(
     @Inject val configBean: ConfigBean
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/description/DescriptionController.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/description/DescriptionController.kt
@@ -8,8 +8,10 @@ import io.micronaut.http.annotation.Controller
 import io.micronaut.http.annotation.Post
 import io.micronaut.http.annotation.Produces
 import jakarta.inject.Inject
+import jakarta.inject.Singleton
 import kotlinx.coroutines.runBlocking
 
+@Singleton
 @Controller("/comparison")
 class DescriptionController(
     @Inject private val descriptionBean: DescriptionBean
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/download/DownloadController.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/download/DownloadController.kt
@@ -8,11 +8,13 @@ import io.micronaut.http.annotation.Get
 import io.micronaut.http.annotation.Produces
 import io.micronaut.http.annotation.QueryValue
 import jakarta.inject.Inject
+import jakarta.inject.Singleton
 import kotlinx.coroutines.runBlocking
 import java.io.BufferedInputStream
 import java.nio.charset.StandardCharsets
 import java.nio.file.Paths
 
+@Singleton
 @Controller("/comparison")
 class DownloadController(
     @Inject private val downloadBean: DownloadBean
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/home/HomeController.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/home/HomeController.kt
@@ -1,13 +1,21 @@
 package com.groupdocs.ui.modules.home
 
+import com.groupdocs.ui.config.ApplicationConfig
+import com.groupdocs.ui.util.setGroupdocsLicense
 import io.micronaut.http.HttpResponse
 import io.micronaut.http.annotation.Controller
 import io.micronaut.http.annotation.Get
 import io.micronaut.views.View
+import jakarta.inject.Inject
+import jakarta.inject.Singleton
 import java.net.URI
 
+@Singleton
 @Controller("/")
-class HomeController {
+class HomeController(
+    @Inject private val appConfig: ApplicationConfig
+) {
+    private var isLicenseSet: Boolean = false
     @Get("/")
     fun home(): HttpResponse<String> {
         return HttpResponse.redirect(URI("/comparison"))
@@ -16,6 +24,10 @@ class HomeController {
     @View("comparison")
     @Get("/comparison")
     fun comparison() {
-
+        if (!isLicenseSet) {
+            isLicenseSet = true
+            val licensePath = appConfig.licensePathOrDefault
+            setGroupdocsLicense(licensePath)
+        }
     }
 }
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/tree/TreeController.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/tree/TreeController.kt
@@ -9,8 +9,10 @@ import io.micronaut.http.annotation.Controller
 import io.micronaut.http.annotation.Post
 import io.micronaut.http.annotation.Produces
 import jakarta.inject.Inject
+import jakarta.inject.Singleton
 import kotlinx.coroutines.runBlocking
 
+@Singleton
 @Controller("/comparison")
 class TreeController(
     @Inject private val treeBean: TreeBean
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/upload/UploadController.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/modules/upload/UploadController.kt
@@ -10,9 +10,11 @@ import io.micronaut.http.annotation.Post
 import io.micronaut.http.annotation.Produces
 import io.micronaut.http.multipart.CompletedFileUpload
 import jakarta.inject.Inject
+import jakarta.inject.Singleton
 import kotlinx.coroutines.runBlocking
 import java.io.BufferedInputStream
 
+@Singleton
 @Controller("/comparison")
 class UploadController(
     @Inject private val uploadBean: UploadBean,
diff --git a/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/util/Tool.kt b/Demos/Micronaut/src/main/kotlin/com/groupdocs/ui/util/Tool.kt
@@ -1,3 +1,43 @@
 package com.groupdocs.ui.util
 
-open class InternalServerException(override val message: String = "Internal server error", throwable: Throwable? = null) : Exception(message, throwable)
+import com.groupdocs.comparison.license.License
+import com.groupdocs.ui.Defaults
+import java.io.BufferedInputStream
+import java.net.URL
+import java.nio.file.Files
+import java.nio.file.Path
+import java.nio.file.Paths
+
+open class InternalServerException(override val message: String = "Internal server error", throwable: Throwable? = null) : Exception(message, throwable)
+
+fun setGroupdocsLicense(licensePath: String) {
+    try {
+        println("Setting Groupdocs license...")
+
+        val licenseExtension = Defaults.DEFAULT_LICENSE_EXTENSION
+        val license = License()
+        if (licensePath.startsWith("http://") || licensePath.startsWith("https://")) {
+            val url = URL(licensePath)
+            BufferedInputStream(url.openStream()).use { inputStream -> license.setLicense(inputStream) }
+        } else {
+            val path = Paths.get(licensePath)
+            if (Files.exists(path)) {
+                if (Files.isRegularFile(path)) {
+                    license.setLicense(licensePath)
+                } else {
+                    Files.list(path).use { pathStream ->
+                        val first =
+                            pathStream.filter { path ->
+                                path.endsWith(licenseExtension)
+                            }.findFirst()
+                        first.ifPresent { licensePath: Path? ->
+                            license.setLicense(licensePath)
+                        }
+                    }
+                }
+            }
+        }
+    } catch (e: Exception) {
+        println("Can not verify Comparison license: ${e.message}")
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,11 @@ dependencies {`
`39`	`39`	`application {`
`40`	`40`	`mainClass.set("com.groupdocs.ui.ApplicationKt")`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+tasks {`
	`44`	`+ create("stage").dependsOn("installDist")`
	`45`	`+}`
	`46`	`+`
`42`	`47`	`java {`
`43`	`48`	`sourceCompatibility = JavaVersion.toVersion("11")`
`44`	`49`	`}`