Package io.micronaut.objectstorage.local

Class LocalStorageOperations

java.lang.Object
io.micronaut.objectstorage.local.LocalStorageOperations
All Implemented Interfaces:
io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>
@EachBean(LocalStorageConfiguration.class) @Requires(condition=io.micronaut.objectstorage.configuration.ToggeableCondition.class) @Requires(beans=LocalStorageConfiguration.class) @Primary public class LocalStorageOperations extends Object implements io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>
An implementation of ObjectStorageOperations that uses the local file system. Useful for testing.
Since:
2.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    METADATA_DIRECTORY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    LocalStorageOperations(LocalStorageConfiguration configuration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    copy(@NonNull String sourceKey, @NonNull String destinationKey)
     
    @NonNull io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile
    delete(@NonNull String key)
     
    boolean
    exists(@NonNull String key)
     
    @NonNull Set<String>
    listObjects()
     
    @NonNull Optional<LocalStorageEntry>
    retrieve(@NonNull String key)
     
    @NonNull io.micronaut.objectstorage.response.UploadResponse<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>
    upload(@NonNull io.micronaut.objectstorage.request.UploadRequest request)
     
    @NonNull io.micronaut.objectstorage.response.UploadResponse<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>
    upload(@NonNull io.micronaut.objectstorage.request.UploadRequest request, @NonNull Consumer<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile> requestConsumer)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

  • Method Details

    • upload

      @NonNull public @NonNull io.micronaut.objectstorage.response.UploadResponse<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile> upload(@NonNull @NonNull io.micronaut.objectstorage.request.UploadRequest request)
      Specified by:
      upload in interface io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>

    • upload

      @NonNull public @NonNull io.micronaut.objectstorage.response.UploadResponse<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile> upload(@NonNull @NonNull io.micronaut.objectstorage.request.UploadRequest request, @NonNull @NonNull Consumer<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile> requestConsumer)
      Specified by:
      upload in interface io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>

    • retrieve

      @NonNull public @NonNull Optional<LocalStorageEntry> retrieve(@NonNull @NonNull String key)
      Specified by:
      retrieve in interface io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>

    • delete

      @NonNull public @NonNull io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile delete(@NonNull @NonNull String key)
      Specified by:
      delete in interface io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>

    • exists

      public boolean exists(@NonNull @NonNull String key)
      Specified by:
      exists in interface io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>

    • listObjects

      @NonNull public @NonNull Set<String> listObjects()
      Specified by:
      listObjects in interface io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>

    • copy

      public void copy(@NonNull @NonNull String sourceKey, @NonNull @NonNull String destinationKey)
      Specified by:
      copy in interface io.micronaut.objectstorage.ObjectStorageOperations<io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile,io.micronaut.objectstorage.local.LocalStorageOperations.LocalStorageFile>