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

Interface StudioBlobStore

All Superinterfaces:

org.craftercms.commons.file.blob.BlobStore, ContentRepository, ContentRepository

All Known Subinterfaces:

StudioBlobStoreAdapter

All Known Implementing Classes:

StudioAwsS3BlobStore

public interface StudioBlobStore
extends org.craftercms.commons.file.blob.BlobStore, ContentRepository, ContentRepository

Extension of BlobStore that adds support for Studio content repository operations

Since:

3.1.6

Author:

joseross

Field Summary

Fields inherited from interface org.craftercms.commons.file.blob.BlobStore

CONFIG_KEY_CONFIGURATION, CONFIG_KEY_ID, CONFIG_KEY_MAPPING, CONFIG_KEY_MAPPING_PREFIX, CONFIG_KEY_MAPPING_PUBLISHING_TARGET, CONFIG_KEY_MAPPING_STORE_TARGET, CONFIG_KEY_PATTERN, CONFIG_KEY_READ_ONLY, CONFIG_KEY_STORE, CONFIG_KEY_TYPE

Method Summary

Modifier and Type	Method	Description
void	copyBlobs(StudioBlobStore sourceStore, String environment, List<String> items)	Copy the blob items from the source store
org.craftercms.commons.file.blob.Blob	getReference(String path)	Return a reference to a file in the store
boolean	isReadOnly()	Indicate if the store is read only

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

getId, getResource, init, isCompatible

Methods inherited from interface org.craftercms.studio.api.v1.repository.ContentRepository

addRemote, cleanupRepositories, contentExists, copyContent, createFolder, createVersion, createVersion, deleteContent, deleteSite, getContent, getContent, getContentChildren, getContentVersionHistory, getRepoFirstCommitId, getRepoLastCommitId, initialPublish, isFolder, listRemote, lockItemForPublishing, moveContent, moveContent, pullFromRemote, pushToRemote, removeRemoteRepositoriesForSite, resetStagingRepository, revertContent, shallowContentExists, unLockItem, unLockItemForPublishing, writeContent

Methods inherited from interface org.craftercms.studio.api.v2.repository.ContentRepository

cancelPublishAll, checkContentExists, commitIdExists, commitIdExists, completePublishAll, contentExists, createSiteCloneRemote, createSiteFromBlueprint, deleteSite, duplicateSite, forAllSitePaths, getCommitIdsBetween, getContentByCommitId, getContentItemHistory, getContentSize, getGlobalRepoLastCommitId, getIntroducedCommits, getItem, getItemEnvironmentProperties, getItemPaths, getLastEditCommitId, getOperationsFromDelta, getPreviousCommitId, getPublishingHistory, getRepoFirstCommitId, getRepoLastCommitId, getSubtreeItems, getSubtreeItems, initialPublish, itemUnlock, lockItem, preparePublishAll, publish, publishAll, publishedRepositoryExists, removeRemote, repositoryExists, shallowContentExists

Method Details

getReference

org.craftercms.commons.file.blob.Blob getReference(String path)

Return a reference to a file in the store

Parameters:

path - the path of the file

Returns:

the blob object

isReadOnly

boolean isReadOnly()

Indicate if the store is read only

Returns:

true if the store is read only

copyBlobs

void copyBlobs(StudioBlobStore sourceStore,
 String environment,
 List<String> items)

Copy the blob items from the source store

Parameters:

sourceStore - the source store

environment - the environment (publishing target)

items - the items to copy