Package org.craftercms.studio.api.v2.repository.blob

Interface StudioBlobStoreResolver

All Superinterfaces:

org.craftercms.commons.file.blob.BlobStoreResolver

All Known Implementing Classes:

StudioBlobStoreResolverImpl

public interface StudioBlobStoreResolver
extends org.craftercms.commons.file.blob.BlobStoreResolver

Extension of BlobStoreResolver that adds site multi-tenancy

Since:

3.1.6

Author:

joseross

Method Summary

Modifier and Type	Method	Description
List<StudioBlobStore>	getAll(String siteId)	Returns all StudioBlobStore configured for the given site
StudioBlobStore	getByPaths(String site, String... paths)	Returns the first StudioBlobStore compatible with all given paths for the given site
boolean	isBlob(String site, String path)	Indicates if a given path belongs to a blob store

Methods inherited from interface org.craftercms.commons.file.blob.BlobStoreResolver

getById

Method Details

getAll

List<StudioBlobStore> getAll(String siteId)
                      throws ServiceLayerException

Returns all StudioBlobStore configured for the given site

Parameters:

siteId - the id of the site

Returns:

list of blob stores

Throws:

ServiceLayerException

getByPaths

StudioBlobStore getByPaths(String site,
 String... paths)
                    throws ServiceLayerException

Returns the first StudioBlobStore compatible with all given paths for the given site

Parameters:

site - the id of the site

paths - the lists of paths to check

Returns:

the blob store object

Throws:

ServiceLayerException - if there is any error looking up the stores

isBlob

boolean isBlob(String site,
 String path)
        throws ServiceLayerException

Indicates if a given path belongs to a blob store

Parameters:

site - the id of the site

path - the path to check

Returns:

true if there is a matching blob store

Throws:

ServiceLayerException - if there is any error looking up the stores