Package org.craftercms.commons.file.blob

Interface BlobStore

All Known Implementing Classes:
AbstractBlobStore, AwsS3BlobStore
public interface BlobStore
Defines the operations to handle blob files
Since:
3.1.6
Author:
joseross

  • Field Details

  • Method Details

    • init

      void init(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config) throws ConfigurationException
      Performs all setup needed with the given configuration
      Parameters:
      config - the configuration object
      Throws:
      ConfigurationException - is any error occurs

    • getId

      String getId()
      Returns the unique id of the store
      Returns:
      the id

    • isCompatible

      boolean isCompatible(String path)
      Indicates if the given path is compatible with the store
      Parameters:
      path - path to check
      Returns:
      true if the path is compatible

    • getResource

      org.springframework.core.io.Resource getResource(String path, Blob blob)
      Resolves the given blob to a readable resource
      Parameters:
      path - the path of the resource
      blob - the blob file
      Returns:
      the resource object