Package com.github.workerframework.api

Interface FilePathProvider

All Known Implementing Classes:
FileSystemDataStore
public interface FilePathProvider
An interface intended to be implemented by DataStores that support the concept of a unique filepath to each stored asset.

  • Method Summary

    Modifier and Type
    Method
    Description
    Path
    getFilePath(String reference)
    Obtains the unique path to the asset identified by the supplied storage reference.

  • Method Details

    • getFilePath

      Path getFilePath(String reference) throws DataStoreException
      Obtains the unique path to the asset identified by the supplied storage reference.
      Parameters:
      reference - the storage reference of the asset whose path within the DataStore is to be returned
      Returns:
      the file path to the referenced asset
      Throws:
      DataStoreException - if the DataStore cannot service the request