Class LocalStorageConfiguration

java.lang.Object
io.micronaut.objectstorage.configuration.AbstractObjectStorageModuleConfiguration
io.micronaut.objectstorage.configuration.AbstractObjectStorageConfiguration
io.micronaut.objectstorage.local.LocalStorageConfiguration
All Implemented Interfaces:
io.micronaut.core.naming.Named, io.micronaut.core.util.Toggleable, ObjectStorageConfiguration, ObjectStorageModuleConfiguration
@EachProperty("micronaut.object-storage.local") @Requires(condition=EachPropertyContainsEntriesCondition.class) public class LocalStorageConfiguration extends AbstractObjectStorageConfiguration
Configuration class for local storage.
Since:
2.0.0
Author:
Álvaro Sánchez-Mariscal

  • Field Details

  • Constructor Details

    • LocalStorageConfiguration

      public LocalStorageConfiguration(@Parameter String name)

  • Method Details

    • getInternalDirectory

      public @NonNull String getInternalDirectory()
      Returns the provider working directory name, relative to the storage root.
      Returns:
      The directory name, defaulting to .mn-storage.
      Since:
      3.1.1

    • setInternalDirectory

      public void setInternalDirectory(@NonNull String internalDirectory)
      Sets the directory used for metadata, multipart state, temporary files, and snapshots.
      Parameters:
      internalDirectory - One safe relative directory name.
      Since:
      3.1.1

    • getPath

      public @NonNull Path getPath()
      The path of the local storage.
      Returns:
      The path of the local storage.

    • setPath

      public void setPath(@NonNull Path path)
      Parameters:
      path - The path of the local storage.

    • isEnabled

      public boolean isEnabled()
      Whether to enable or disable this object storage.
      Since:
      2.0.2