Manages file content stored on a per-tenant basis in the local file system, keyed by directory and content name. A single instance is shared across the server and reached from Java via the C(FileStorageManager.class) context lookup, and its exported methods are bound into content-type and other scripts as the "fsm" variable, so a script calls fsm.storeContent(...), fsm.readContent(...) and so on. Storage is always scoped to the current tenant, resolved from CurrentTenantService, so these methods can only be used within a request or other context that has a current tenant.

Group: Managers

Implements: AssetContentStorageService

---

Properties

---

Methods

listDirs() · listDirs(String dir) · listDirectoryInfo(String dir) · listFiles(String filePrefix) · fileStats(String dir) · fileInfo(String dir) · fileInfo(String dir, Integer maxFiles) · listFiles(String dir, String filePrefix) · deleteFiles(List<String> fileNames) · deleteFiles(String dir, List<String> fileNames) · deleteDirectory(String toRemoveDirectory) · toInputStream(Object ob) · streamToString(InputStream in) · storeContent(String contentName, InputStream bin) · storeContentToPath(Path path, String contentName, InputStream bin) · storeContent(String dir, String contentName, InputStream bin) · storeContent(String dir, String contentName, FileItem file, List<String> allowedMimeTypes) · parseFileInputStream(FileItem file, List<String> allowedMimeTypes) · saveWithOutput(String dir, String fileName, boolean overwrite, Consumer<OutputStream> writer) · readContent(String contentName, Consumer<ContentInfo> consumer) · readContent(String dir, String contentName, Consumer<ContentInfo> consumer) · directoryExists(String directoryName) · contentExists(String contentName) · contentExists(String dir, String contentName) · storeFile(InputStream bin) · storeZipFile(InputStream in) · processZipInputStream(InputStream inputStream, Consumer<Map<String,Object>> consumer) · processGzipInputStream(InputStream inputStream, Consumer<InputStream> consumer) · getAsByteArray(Object o) · readFile(String hash) · saveAssetContent(String fileName, InputStream in) · lookupAssetContent(String fileName, Consumer<ContentInfo> c) · detectContentTypeForInputStream(InputStream in) · findFileExtension(FileItem fileItem) · findFileExtension(String fileName) · cropImage(String dir, String contentName, String newContentName, Map<String,Integer> boundary, String formatName) · rotateImage(InputStream in, int angle, String formatName) · rotateImage(InputStream in, int angle, String formatName, Float compressionQuality) · getExifRotation(InputStream imageInputStream) · getExifData(InputStream imageInputStream) · getExifDataByHash(String hash) · getExifDataByPath(String dir, String contentName) · getContentStorageContentPrefix() · generateContentStorageContentId(String directory, String contentName) · extractContentStorageFileName(String contentName) · exportToZip(String outputDir, String outputName, Consumer<ZipBuilder> c)

listDirs()

Returns: List<String>

List the first-level subdirectories of the current tenant's root storage directory.

listDirs(String dir)

Returns: List<String>

List the first-level subdirectories within the directory.

listDirectoryInfo(String dir)

Returns: List<Map<String,Object>>

List the first-level subdirectories of the given directory, with details about each one.

listFiles(String filePrefix)

Returns: List<String>

List the file names in the tenant's root storage directory that start with the given prefix, sorted alphabetically.

fileStats(String dir)

Returns: Map<String,Object>

Summary statistics for the files in the given directory, such as file count and total size.

fileInfo(String dir)

Returns: List<Map<String,Object>>

List the files in the given directory, with details such as name and size for each one.

fileInfo(String dir, Integer maxFiles)

Returns: List<Map<String,Object>>

List the files in the given directory, with details such as name and size for each one, up to a maximum number of files.

listFiles(String dir, String filePrefix)

Returns: List<String>

List the file names in the given directory that start with the given prefix, sorted alphabetically.

deleteFiles(List<String> fileNames)

Returns: void

Deletes the named files from the tenant's root storage directory.

deleteFiles(String dir, List<String> fileNames)

Returns: void

Deletes the named files from the given directory.

deleteDirectory(String toRemoveDirectory)

Returns: void

Deletes the named directory and its contents from per-tenant storage.

toInputStream(Object ob)

Returns: InputStream

Wraps the given data as an InputStream, converting it if needed. Accepts a String, StringBuilder, byte array or an existing InputStream (returned unchanged); any other type throws.

streamToString(InputStream in)

Returns: String

Reads the entire stream and returns its contents as a string, using the platform default character encoding.

storeContent(String contentName, InputStream bin)

Returns: long

Saves a content item to the tenant's root storage directory, overwriting any existing content with the same name.

storeContentToPath(Path path, String contentName, InputStream bin)

Returns: long

Saves a content item to per-tenant storage rooted at the given directory path, overwriting any existing content with the same name.

storeContent(String dir, String contentName, InputStream bin)

Returns: long

Saves a content item to the given directory in per-tenant storage, overwriting any existing content with the same name.

storeContent(String dir, String contentName, FileItem file, List<String> allowedMimeTypes)

Returns: long

If the given uploaded file's detected content type matches one of the allowed MIME types, saves it to per-tenant content storage and returns its size.

parseFileInputStream(FileItem file, List<String> allowedMimeTypes)

Returns: BufferedInputStream

Checks the given uploaded file's detected content type against the allowed MIME types and returns a buffered, mark-supporting stream over its content if it matches.

saveWithOutput(String dir, String fileName, boolean overwrite, Consumer<OutputStream> writer)

Returns: void

Saves content to the given directory by handing the caller an OutputStream to write to, rather than requiring the content up-front as an InputStream. Content is always saved with overwrite enabled, regardless of the overwrite argument.

readContent(String contentName, Consumer<ContentInfo> consumer)

Returns: void

Looks up a content item in the tenant's root storage directory and passes it to the given callback.

readContent(String dir, String contentName, Consumer<ContentInfo> consumer)

Returns: void

Looks up a content item in the given directory and passes it to the given callback.

directoryExists(String directoryName)

Returns: boolean

Checks whether the given directory exists in per-tenant storage.

contentExists(String contentName)

Returns: boolean

Checks whether content with the given name exists in the tenant's root storage directory.

contentExists(String dir, String contentName)

Returns: boolean

Checks whether content with the given name exists in the given directory.

storeFile(InputStream bin)

Returns: String

Saves the given content to the per-tenant blob store and returns its hash.

storeZipFile(InputStream in)

Returns: List<Map<String,Object>>

Extracts a zip file and stores each entry in the "zip" directory of per-tenant storage under a timestamp-prefixed name, returning the details of each stored file (its original name, stored name, size and directory). Use readContent with the returned dir and storedName to retrieve a stored entry.

processZipInputStream(InputStream inputStream, Consumer<Map<String,Object>> consumer)

Returns: void

Iterates over the entries of a zip stream, invoking the callback once per file entry with its name, size, an open InputStream over its content, the entry's file name and its parent path. Directory entries are skipped. Unlike storeZipFile, entries are not saved to per-tenant storage.

processGzipInputStream(InputStream inputStream, Consumer<InputStream> consumer)

Returns: void

Processes the contents of a GZIP-compressed InputStream by providing an uncompressed InputStream. This method decompresses the data from the provided InputStream using GZIP.

getAsByteArray(Object o)

Returns: byte[]

Converts the given data to a byte array. Accepts a byte array (returned unchanged), a String, a FileItem or an InputStream; any other type returns null.

readFile(String hash)

Returns: InputStream

Reads back the content previously stored in the hash-split blob store under the given hash.

saveAssetContent(String fileName, InputStream in)

Returns: long

Saves content to the tenant's "assets" directory, implementing the AssetContentStorageService contract used to persist asset binary content.

lookupAssetContent(String fileName, Consumer<ContentInfo> c)

Returns: void

Looks up content in the tenant's "assets" directory and passes it to the given callback, implementing the AssetContentStorageService contract used to read back asset binary content.

detectContentTypeForInputStream(InputStream in)

Returns: Map<String,String>

Detects the content type and corresponding file extension of a stream, using Apache Tika.

findFileExtension(FileItem fileItem)

Returns: String

Finds the file extension of an uploaded file, taken from its file name.

findFileExtension(String fileName)

Returns: String

Finds the extension of a file name.

cropImage(String dir, String contentName, String newContentName, Map<String,Integer> boundary, String formatName)

Returns: void

Crops a stored image and saves the result under a new name in the same directory.

rotateImage(InputStream in, int angle, String formatName)

Returns: InputStream

Rotates an image by the given angle, first correcting for any EXIF orientation already recorded against the image so the result always ends up the right way up. The rotation angle must be 0, 90, 180 or 270 degrees. Equivalent to calling the four-argument overload with maximum compression quality.

rotateImage(InputStream in, int angle, String formatName, Float compressionQuality)

Returns: InputStream

Rotates an image by the given angle, first correcting for any EXIF orientation already recorded against the image so the result always ends up the right way up. The rotation angle must be 0, 90, 180 or 270 degrees.

getExifRotation(InputStream imageInputStream)

Returns: int

Reads the EXIF orientation tag and returns the corresponding rotation angle.

getExifData(InputStream imageInputStream)

Returns: Map<String,Map<String,String>>

Reads all available metadata tags embedded in an image (EXIF, GPS, IPTC, etc).

getExifDataByHash(String hash)

Returns: Map<String,Map<String,String>>

Reads all available metadata tags embedded in an image stored under the given content hash.

getExifDataByPath(String dir, String contentName)

Returns: Map<String,Map<String,String>>

Reads all available metadata tags embedded in an image stored at the given path.

getContentStorageContentPrefix()

Returns: String

The prefix used to identify content stored in per-tenant storage. Only content ids carrying this prefix can be parsed by DefaultHashContentService.

generateContentStorageContentId(String directory, String contentName)

Returns: String

Builds the standard content id used to reference content stored in per-tenant storage, combining the content storage prefix with the directory and content name.

extractContentStorageFileName(String contentName)

Returns: Map<String,String>

Extracts the actual file name and directory name from a content storage content name previously built by generateContentStorageContentId.

exportToZip(String outputDir, String outputName, Consumer<ZipBuilder> c)

Returns: void

Creates a zip file in per-tenant content storage and hands the caller a ZipBuilder to add entries to it. A typical script reads other stored content and adds each item to the zip via the builder's add method inside the callback.