diff --git a/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/DocumentStorageFileRepository.java b/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/DocumentStorageFileRepository.java index 60593ef7..4e93add1 100644 --- a/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/DocumentStorageFileRepository.java +++ b/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/DocumentStorageFileRepository.java @@ -10,12 +10,14 @@ public interface DocumentStorageFileRepository { /** * Gets the file specified in the parameter from the document storage. * - * @param pathToFile defines the path to the file. + * @param pathToFile defines the path to the file. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @return the file. * @throws DocumentStorageClientErrorException if the problem is with the client. - * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 storage or the document storage. + * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document + * storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 + * storage or the document storage. */ byte[] getFile(String pathToFile, int expireInMinutes) throws DocumentStorageException, DocumentStorageClientErrorException, DocumentStorageServerErrorException; @@ -26,8 +28,10 @@ byte[] getFile(String pathToFile, int expireInMinutes) * @param pathToFile defines the path to the file. * @return the file size. * @throws DocumentStorageClientErrorException if the problem is with the client. - * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 storage or the document storage. + * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document + * storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 + * storage or the document storage. */ Mono getFileSize(String pathToFile) throws DocumentStorageClientErrorException, DocumentStorageServerErrorException, DocumentStorageException; @@ -35,12 +39,14 @@ Mono getFileSize(String pathToFile) /** * Gets an InputStream for the file specified in the parameter from the document storage. * - * @param pathToFile defines the path to the file. + * @param pathToFile defines the path to the file. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @return the InputStream for the file. * @throws DocumentStorageClientErrorException if the problem is with the client. - * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 storage or the document storage. + * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document + * storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 + * storage or the document storage. */ InputStream getFileInputStream(String pathToFile, int expireInMinutes) throws DocumentStorageException, DocumentStorageClientErrorException, DocumentStorageServerErrorException; @@ -48,12 +54,14 @@ InputStream getFileInputStream(String pathToFile, int expireInMinutes) /** * Saves the file specified in the parameter to the document storage. * - * @param pathToFile defines the path to the file. - * @param file to save. + * @param pathToFile defines the path to the file. + * @param file to save. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @throws DocumentStorageClientErrorException if the problem is with the client. - * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 storage or the document storage. + * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document + * storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 + * storage or the document storage. */ void saveFile(String pathToFile, byte[] file, int expireInMinutes) throws DocumentStorageException, DocumentStorageClientErrorException, DocumentStorageServerErrorException; @@ -61,12 +69,14 @@ void saveFile(String pathToFile, byte[] file, int expireInMinutes) /** * Saves the file specified in the parameter to the document storage. * - * @param pathToFile defines the path to the file. - * @param file to save. + * @param pathToFile defines the path to the file. + * @param file to save. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @throws DocumentStorageClientErrorException if the problem is with the client. - * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 storage or the document storage. + * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document + * storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 + * storage or the document storage. */ void saveFileInputStream(String pathToFile, InputStream file, int expireInMinutes) throws DocumentStorageException, DocumentStorageClientErrorException, DocumentStorageServerErrorException; @@ -74,12 +84,14 @@ void saveFileInputStream(String pathToFile, InputStream file, int expireInMinute /** * Updates the file specified in the parameter to the document storage. * - * @param pathToFile defines the path to the file. - * @param file which overwrites the file in the document storage. + * @param pathToFile defines the path to the file. + * @param file which overwrites the file in the document storage. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @throws DocumentStorageClientErrorException if the problem is with the client. - * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 storage or the document storage. + * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document + * storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 + * storage or the document storage. */ void updateFile(String pathToFile, byte[] file, int expireInMinutes) throws DocumentStorageException, DocumentStorageClientErrorException, DocumentStorageServerErrorException; @@ -87,12 +99,14 @@ void updateFile(String pathToFile, byte[] file, int expireInMinutes) /** * Updates the file specified in the parameter withinq the document storage. * - * @param pathToFile defines the path to the file. - * @param file which overwrites the file in the document storage. + * @param pathToFile defines the path to the file. + * @param file which overwrites the file in the document storage. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @throws DocumentStorageClientErrorException if the problem is with the client. - * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 storage or the document storage. + * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document + * storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 + * storage or the document storage. */ void updateFileInputStream(String pathToFile, InputStream file, int expireInMinutes) throws DocumentStorageException, DocumentStorageClientErrorException, DocumentStorageServerErrorException; @@ -100,11 +114,13 @@ void updateFileInputStream(String pathToFile, InputStream file, int expireInMinu /** * Deletes the file specified in the parameter from the document storage. * - * @param pathToFile defines the path to the file. + * @param pathToFile defines the path to the file. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @throws DocumentStorageClientErrorException if the problem is with the client. - * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 storage or the document storage. + * @throws DocumentStorageServerErrorException if the problem is with the S3 storage or document + * storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the S3 + * storage or the document storage. */ void deleteFile(String pathToFile, int expireInMinutes) throws DocumentStorageException, DocumentStorageClientErrorException, DocumentStorageServerErrorException; diff --git a/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/DocumentStorageFolderRepository.java b/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/DocumentStorageFolderRepository.java index c1ec59e7..0cd38fac 100644 --- a/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/DocumentStorageFolderRepository.java +++ b/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/DocumentStorageFolderRepository.java @@ -14,7 +14,8 @@ public interface DocumentStorageFolderRepository { * @param pathToFolder which defines the folder in the document storage. * @throws DocumentStorageClientErrorException if the problem is with the client. * @throws DocumentStorageServerErrorException if the problem is with the document storage. - * @throws DocumentStorageException if the problem cannot be assigned directly to the document storage. + * @throws DocumentStorageException if the problem cannot be assigned directly to the document + * storage. */ void deleteFolder(String pathToFolder) throws DocumentStorageClientErrorException, DocumentStorageServerErrorException, DocumentStorageException; @@ -25,7 +26,8 @@ void deleteFolder(String pathToFolder) * @param pathToFolder which defines the folder in the document storage. * @throws DocumentStorageClientErrorException if the problem is with the client. * @throws DocumentStorageServerErrorException if the problem is with the document storage. - * @throws DocumentStorageException if the problem cannot be assigned directly to the document storage. + * @throws DocumentStorageException if the problem cannot be assigned directly to the document + * storage. */ Mono> getAllFilesInFolderRecursively(String pathToFolder) throws DocumentStorageClientErrorException, DocumentStorageServerErrorException, DocumentStorageException; @@ -37,7 +39,8 @@ Mono> getAllFilesInFolderRecursively(String pathToFolder) * @return file paths with their file sizes. * @throws DocumentStorageClientErrorException if the problem is with the client. * @throws DocumentStorageServerErrorException if the problem is with the document storage. - * @throws DocumentStorageException if the problem cannot be assigned directly to the document storage. + * @throws DocumentStorageException if the problem cannot be assigned directly to the document + * storage. */ Mono> getAllFileSizesInFolderRecursively(String pathToFolder) throws DocumentStorageClientErrorException, DocumentStorageServerErrorException, DocumentStorageException; diff --git a/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/presignedurl/PresignedUrlRepository.java b/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/presignedurl/PresignedUrlRepository.java index 1f014884..00aba92d 100644 --- a/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/presignedurl/PresignedUrlRepository.java +++ b/refarch-integrations/refarch-s3-integration/refarch-s3-integration-client-core/src/main/java/de/muenchen/refarch/integration/s3/client/repository/presignedurl/PresignedUrlRepository.java @@ -8,53 +8,61 @@ public interface PresignedUrlRepository { /** - * Fetches a presignedURL for the file named in the parameter to get a file from the document storage. + * Fetches a presignedURL for the file named in the parameter to get a file from the document + * storage. * - * @param pathToFile defines the path to the file. + * @param pathToFile defines the path to the file. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @return the presignedURL. * @throws DocumentStorageClientErrorException if the problem is with the client. * @throws DocumentStorageServerErrorException if the problem is with the document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the document storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the + * document storage. */ Mono getPresignedUrlGetFile(String pathToFile, int expireInMinutes) throws DocumentStorageClientErrorException, DocumentStorageServerErrorException, DocumentStorageException; /** - * Fetches a presignedURL for the file named in the parameter to store a file in the document storage. + * Fetches a presignedURL for the file named in the parameter to store a file in the document + * storage. * - * @param pathToFile defines the path to the file. + * @param pathToFile defines the path to the file. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @return the presignedURL. * @throws DocumentStorageClientErrorException if the problem is with the client. * @throws DocumentStorageServerErrorException if the problem is with the document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the document storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the + * document storage. */ String getPresignedUrlSaveFile(String pathToFile, int expireInMinutes) throws DocumentStorageClientErrorException, DocumentStorageServerErrorException, DocumentStorageException; /** - * Fetches a presignedURL for the file named in the parameter to update a file in the document storage. + * Fetches a presignedURL for the file named in the parameter to update a file in the document + * storage. * - * @param pathToFile defines the path to the file. + * @param pathToFile defines the path to the file. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @return the presignedURL. * @throws DocumentStorageClientErrorException if the problem is with the client. * @throws DocumentStorageServerErrorException if the problem is with the document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the document storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the + * document storage. */ String getPresignedUrlUpdateFile(String pathToFile, int expireInMinutes) throws DocumentStorageClientErrorException, DocumentStorageServerErrorException, DocumentStorageException; /** - * Fetches a presignedURL for the file named in the parameter to delete a file from the document storage. + * Fetches a presignedURL for the file named in the parameter to delete a file from the document + * storage. * - * @param pathToFile defines the path to the file. + * @param pathToFile defines the path to the file. * @param expireInMinutes the expiration time of the presignedURL in minutes. * @return the presignedURL. * @throws DocumentStorageClientErrorException if the problem is with the client. * @throws DocumentStorageServerErrorException if the problem is with the document storage. - * @throws DocumentStorageException if the problem cannot be assigned to either the client or the document storage. + * @throws DocumentStorageException if the problem cannot be assigned to either the client or the + * document storage. */ String getPresignedUrlDeleteFile(String pathToFile, int expireInMinutes) throws DocumentStorageClientErrorException, DocumentStorageServerErrorException, DocumentStorageException;