To be used together with essencium-backend (version >=2.4.5).

This module provides an abstraction layer to store files needed for your application. The actual persistence location and implementation is independent of the handling of files. This is achieved by providing various storage provider implementations that can be used independently of another.

It is possible to store a file with multiple storage providers to provide redundancy and to access these even if not all used providers are available at the time of requesting a file.

In order to integrate the file-storage-module into your own application, a strategic decision must be made at the beginning. There are several methods available to generate the primary key of an entry (ID). By the integration of the specific components one determines which strategy is followed.

Example using the sequence strategy:

@SpringBootApplication(
    scanBasePackages = {
      "de.frachtwerk.my.application",
      "de.frachtwerk.essencium.backend",
      "de.frachtwerk.essencium.storage.generic",
      "de.frachtwerk.essencium.storage.impl.sequence"
    })
@EntityScan(
    basePackages = {
      "de.frachtwerk.my.application",
      "de.frachtwerk.essencium.backend",
      "de.frachtwerk.essencium.storage.generic",
      "de.frachtwerk.essencium.storage.impl.sequence"
    })
@ConfigurationPropertiesScan(
    basePackages = {
      "de.frachtwerk.my.application",
      "de.frachtwerk.essencium.backend",
      "de.frachtwerk.essencium.storage.generic",
      "de.frachtwerk.essencium.storage.impl.sequence",
    })
@EnableJpaRepositories(
    basePackages = {
      "de.frachtwerk.my.application",
      "de.frachtwerk.essencium.backend",
      "de.frachtwerk.essencium.storage.generic",
      "de.frachtwerk.essencium.storage.impl.sequence"
    })
public class SpringBootApp {
  public static void main(String[] args) {
    SpringApplication.run(SpringBootApp.class, args);
  }
}

Note that when linking custom entities to files, do not specify an abstract File class, but the specific implementation of the File class (SequenceFile or IdentityFile).

The module is configured by using the application.yaml config file of your essencium application. The used prefix is file.storage

• Type: String[]
• Required: yes

Specifies the providers that should be used to store files. Note: This does not activate the specified providers.

Config parameters for the local provider.

Config parameters for the s3 provider.

If endpointUrl, accessKey and secretKey are not provided, the aws default credentials provider chain is used. For non-AWS S3-Buckets, the endpointUrl, accessKey and secretKey have to be set to the S3-Endpoint and Credentials of the host.

• JDK 17
• Maven

The backend lib comprises both unit- and integration tests.

• Unit Tests: mvn test
• Integration Tests: mvn failsafe:integration-test

Frachtwerk GmbH