Updated Spring sample to support Dropbox as file storage via it's API

Author: oleksii-unnamed

Demos/Dropwizard/src/main/java/com/groupdocs/ui/comparison/provider/DropboxFilesProvider.java

@@ -87,7 +87,7 @@ public void receiveFilesInputStream(String path, Consumer<InputStream> streamCon
 
     @Override
     public void receiveFilesOutputStream(String path, Consumer<OutputStream> streamConsumer) throws ApiException {
-        logger.debug("Request to Dropbox API to upload file with name'" + path + "'");
+        logger.debug("Request to Dropbox API to upload file with name '" + path + "'");
 
         try {
             final DbxUserFilesRequests filesRequests = client.files();

Demos/Spring/configuration.yml

@@ -50,7 +50,7 @@ common:
 ################################################
 comparison:
   # Files provider, where to get files to show them in browse dialog
-  # Available values are `google` - using Google Drive API, `local` - using local directories
+  # Available values are `google` - using Google Drive API, `dropbox` - using Dropbox API, `local` - using local directories
   filesProviderType: ${FILES_PROVIDER_TYPE:local}
   # Result pages preload
   # How many pages from a result document should be loaded, remaining pages will be loaded on page scrolling
@@ -97,4 +97,14 @@ google:
   # Default value is `8888`
   localServerReceiverPort: ${LOCAL_SERVER_RECEIVER_PORT:8888}
   # user ID or null if not using a persisted credential store
-  authorizationUserId: user
+  authorizationUserId: user
+################################################
+# Dropbox API files provider Configuration
+################################################
+dropbox:
+  # The identifier that will be used as User-Agent in API requests
+  clientIdentifier: ${CLIENT_IDENTIFIER:groupdocs/comparison-java}
+  # Dropbox access token
+  accessToken: ${ACCESS_TOKEN:}
+  # Directory in which result files will be uploaded via Dropbox API, default value is `ResultFiles`.
+  resultDirectory: ${RESULT_DIR:ResultFiles}

Demos/Spring/pom.xml

@@ -53,6 +53,8 @@
     <properties>
         <start-class>com.groupdocs.ui.common.Application</start-class>
         <java.version>1.8</java.version>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
@@ -149,6 +151,13 @@
             <version>1.32.1</version>
         </dependency>
 
+        <!-- Dropbox API -->
+        <dependency>
+            <groupId>com.dropbox.core</groupId>
+            <artifactId>dropbox-core-sdk</artifactId>
+            <version>4.0.1</version>
+        </dependency>
+
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
@@ -180,10 +189,6 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.0</version>
-                <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
-                </configuration>
             </plugin>
             <plugin>
                 <groupId>com.github.eirslett</groupId>

Demos/Spring/src/main/java/com/groupdocs/ui/common/Application.java

@@ -22,13 +22,7 @@
 //@EnableAutoConfiguration
 @SpringBootApplication(
         scanBasePackages = {
-                "com.groupdocs.ui",
-//                "com.groupdocs.ui.common",
-//                "com.groupdocs.ui.comparison",
-//                "com.groupdocs.ui.common.config",
-//                "com.groupdocs.ui.comparison.config",
-//                "com.groupdocs.ui.comparison.resources",
-//                "com.groupdocs.ui.comparison.service"
+                "com.groupdocs.ui"
         }
 )
 public class Application extends SpringBootServletInitializer {

Demos/Spring/src/main/java/com/groupdocs/ui/common/Defaults.java

@@ -8,7 +8,7 @@ interface Application {
 
     interface Comparison {
         enum FilesProviderType {
-            LOCAL, GOOGLE
+            LOCAL, GOOGLE, DROPBOX
         }
 
         int DEFAULT_PRELOAD_RESULT_PAGE_COUNT = 2;

Demos/Spring/src/main/java/com/groupdocs/ui/common/config/GlobalConfiguration.java

@@ -1,11 +1,15 @@
 package com.groupdocs.ui.common.config;
 
 import com.groupdocs.ui.comparison.config.ComparisonConfiguration;
+import com.groupdocs.ui.comparison.config.DropboxProviderConfiguration;
 import com.groupdocs.ui.comparison.config.GoogleProviderConfiguration;
 import com.groupdocs.ui.comparison.config.LocalProviderConfiguration;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
+/**
+ * The type Global configuration.
+ */
 @Component
 public class GlobalConfiguration {
 
@@ -26,27 +30,59 @@ public class GlobalConfiguration {
 
     @Autowired
     private GoogleProviderConfiguration google;
+    @Autowired
+    private DropboxProviderConfiguration dropbox;
 
+    /**
+     * Gets server configuration
+     *
+     * @return the server configuration
+     */
     public ServerConfiguration getServer() {
         return server;
     }
 
+    /**
+     * Sets server configuration
+     *
+     * @param server the server configuration
+     */
     public void setServer(ServerConfiguration server) {
         this.server = server;
     }
 
+    /**
+     * Gets application configuration
+     *
+     * @return the application configuration
+     */
     public ApplicationConfiguration getApplication() {
         return application;
     }
 
+    /**
+     * Sets application configuration
+     *
+     * @param application the application configuration
+     */
     public void setApplication(ApplicationConfiguration application) {
         this.application = application;
     }
 
+    /**
+     * Gets common configuration
+     *
+     * @return the common configuration
+     */
     public CommonConfiguration getCommon() {
         return common;
     }
 
+    /**
+     * Gets comparison configuration
+     *
+     * @return the comparison configuration
+     */
     public ComparisonConfiguration getComparison() {
         return comparison;
     }
@@ -60,6 +96,15 @@ public GoogleProviderConfiguration getGoogle() {
         return google;
     }
 
+    /**
+     * Gets dropbox provider configuration
+     *
+     * @return the dropbox provider configuration
+     */
+    public DropboxProviderConfiguration getDropbox() {
+        return dropbox;
+    }
+
     /**
      * Get local provider configuration
      *

Demos/Spring/src/main/java/com/groupdocs/ui/common/exception/ApiException.java

@@ -0,0 +1,26 @@
+package com.groupdocs.ui.common.exception;
+
+/**
+ * The type Api exception.
+ */
+public class ApiException extends TotalGroupDocsException {
+
+    /**
+     * Instantiates a new Api exception.
+     *
+     * @param message the message
+     */
+    public ApiException(String message) {
+        super(message);
+    }
+
+    /**
+     * Instantiates a new Api exception.
+     *
+     * @param message the message
+     * @param cause   the cause
+     */
+    public ApiException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

Demos/Spring/src/main/java/com/groupdocs/ui/common/exception/LocalDiskException.java

@@ -0,0 +1,26 @@
+package com.groupdocs.ui.common.exception;
+
+/**
+ * The type Api exception.
+ */
+public class LocalDiskException extends TotalGroupDocsException {
+
+    /**
+     * Instantiates a new Api exception.
+     *
+     * @param message the message
+     */
+    public LocalDiskException(String message) {
+        super(message);
+    }
+
+    /**
+     * Instantiates a new Api exception.
+     *
+     * @param message the message
+     * @param cause   the cause
+     */
+    public LocalDiskException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

Demos/Spring/src/main/java/com/groupdocs/ui/common/util/CachedPageStream.java

@@ -69,7 +69,7 @@ public InputStream createPageStream(int pageIndex) {
         }
         logger.debug("Creating cached page stream...");
         try {
-            return Files.newInputStream(mCacheFiles.get(pageIndex).toFile().toPath());
+            return Files.newInputStream(mCacheFiles.get(pageIndex));
         } catch (Exception e) {
             throw new TotalGroupDocsException("Cache exception occurred", e);
         }
@@ -79,7 +79,7 @@ public Stream<PageStream> stream() {
         logger.debug("Iterating cached pages stream...");
         return mCacheFiles.entrySet().stream().map(entry -> {
             try {
-                return new PageStream(entry.getKey(), Files.newInputStream(entry.getValue().toFile().toPath()));
+                return new PageStream(entry.getKey(), Files.newInputStream(entry.getValue()));
             } catch (Exception e) {
                 throw new TotalGroupDocsException("Cache exception occurred", e);
             }

Demos/Spring/src/main/java/com/groupdocs/ui/common/util/TempFilesManager.java

@@ -0,0 +1,51 @@
+package com.groupdocs.ui.common.util;
+
+import com.groupdocs.ui.common.exception.TotalGroupDocsException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.nio.file.FileSystems;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+public final class TempFilesManager {
+    private static final Logger logger = LoggerFactory.getLogger(TempFilesManager.class);
+    private static TempFilesManager INSTANCE;
+    private final Path tempDirectoryAbsolutePath;
+
+    private TempFilesManager(Path tempDirectory) {
+        final boolean isRelative = !tempDirectory.isAbsolute();
+        if (isRelative) {
+            tempDirectory = FileSystems.getDefault().getPath(tempDirectory.toString()).toAbsolutePath();
+        }
+        logger.debug("Temp directory is going to be '" + tempDirectory + "', creating it...");
+        Path createdTempDirectory = tempDirectory;
+        try {
+            if (Files.notExists(tempDirectory)) {
+                createdTempDirectory = Files.createDirectories(tempDirectory);
+            }
+        } catch (IOException e) {
+            logger.error("Exception throws while creating temp directory: '" + tempDirectory + "'");
+            throw new TotalGroupDocsException("Can't access temp directory", e);
+        }
+        this.tempDirectoryAbsolutePath = createdTempDirectory.toAbsolutePath();
+    }
+
+    public static void createInstance(String tempDirectory) {
+        if (tempDirectory == null) {
+            throw new IllegalArgumentException("tempDirectory must not be null");
+        }
+        INSTANCE = new TempFilesManager(Paths.get(tempDirectory));
+    }
+
+    public static TempFilesManager getInstance() {
+        return INSTANCE;
+    }
+
+    public Path createTempPath(String fileName) {
+
+        return tempDirectoryAbsolutePath.resolve(fileName);
+    }
+}