Class S3MediaStorageStrategy
java.lang.Object
de.hybris.platform.amazon.media.storage.S3MediaStorageStrategy
- All Implemented Interfaces:
MediaStorageStrategy
Strategy which allows to store binaries for Media objects in Amazon S3 data storage.
Corresponding MediaFolder have to be configured with following properties:
media.folder.{mediaFolderQualifier}.storage.strategy=S3MediaStorageStrategy
media.folder.{mediaFolderQualifier}.bucketId=bucketId
media.folder.{mediaFolderQualifier}.accessKeyID=yourAccessKeyID
media.folder.{mediaFolderQualifier}.secretAccessKey=yourSecretAccessKey
media.folder.{mediaFolderQualifier}.endpoint=possibleEndpoint
where:
- mediaFolderQualifier is qualifier of MediaFolder
- bucketId is name of the S3 bucket
- accessKeyID is configured access key ID
- secretAccessKey is configured secret access key ID
- endpoint is optional endpoint (for instance: s3-eu-west-1.amazonaws.com)
Below is full example for MediaFolder with qualifier s3 and bucketId myBucket:
media.folder.s3.storage.strategy=S3MediaStorageStrategy media.folder.s3.bucketId=myBucket media.folder.s3.accessKeyID=XGDKJAKDJ12345 media.folder.s3.secretAccessKey=JSJD8JSJJ3KNSkskk88374ksjhahwl4w+
If you have more than one media folders, you can share common settings as follows:
media.globalSettings.s3MediaStorageStrategy.accessKeyId=yourAccessKeyID media.globalSettings.s3MediaStorageStrategy.secretAccessKey=yourSecretAccessKey media.globalSettings.s3MediaStorageStrategy.bucketId=myBucket media.globalSettings.s3MediaStorageStrategy.endpoint=possibleEndpoint
To control clean on init behavior use following property:
media.globalSettings.s3MediaStorageStrategy.cleanOnInit = true / false
- Spring Bean ID:
- s3MediaStorageStrategy
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddelete(MediaStorageConfigService.MediaFolderConfig config, String location) Delete media represented by location from the storage.getAsFile(MediaStorageConfigService.MediaFolderConfig config, String location) Gets the media data from the storage as file.getAsStream(MediaStorageConfigService.MediaFolderConfig config, String location) Gets the media data from the storage as stream.longgetSize(MediaStorageConfigService.MediaFolderConfig config, String location) Gets size of media data in bytes.voidsetLocationHashService(MediaLocationHashService locationHashService) voidsetMediaHeadersRegistry(MediaHeadersRegistry mediaHeadersRegistry) voidsetS3StorageServiceFactory(S3StorageServiceFactory s3StorageServiceFactory) voidstore(MediaStorageConfigService.MediaFolderConfig config, String mediaId, Map<String, Object> metaData, InputStream dataStream) Stores media data into the storage using unique location identifier.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface de.hybris.platform.media.storage.MediaStorageStrategy
hasValidMediaFolderName
-
Field Details
-
tenantPrefix
-
-
Constructor Details
-
S3MediaStorageStrategy
public S3MediaStorageStrategy()
-
-
Method Details
-
setTenantPrefix
public void setTenantPrefix() -
store
public StoredMediaData store(MediaStorageConfigService.MediaFolderConfig config, String mediaId, Map<String, Object> metaData, InputStream dataStream) Description copied from interface:MediaStorageStrategyStores media data into the storage using unique location identifier. Location identifier is computed by each implementation in different way which depends on API of underlying media storage but in most cases contains amediaIdas unique part.mediaIdis generated by platform for each upload attempt so it guarantees uniqueness.- Specified by:
storein interfaceMediaStorageStrategy- Parameters:
config- media folder configurationmediaId- the media identifiermetaData- the meta data containing additional possible informations like: original filename, MIME, folder pathdataStream- the data stream to store- Returns:
- object containing information about stored data like unique location in the storage, size and hash for location
-
delete
Description copied from interface:MediaStorageStrategyDelete media represented by location from the storage.- Specified by:
deletein interfaceMediaStorageStrategy- Parameters:
config- media folder configurationlocation- the string representation of location of media data in storage
-
getAsStream
Description copied from interface:MediaStorageStrategyGets the media data from the storage as stream.- Specified by:
getAsStreamin interfaceMediaStorageStrategy- Parameters:
config- media folder configurationlocation- the string representation of location of media data in storage- Returns:
- the data
-
getAsFile
Description copied from interface:MediaStorageStrategyGets the media data from the storage as file. Note that implementation of this method may be optional when underlying media storage does not support downloading data as File.- Specified by:
getAsFilein interfaceMediaStorageStrategy- Parameters:
config- media folder configurationlocation- the string representation of location of media data in storage- Returns:
- the media as file
-
getSize
Description copied from interface:MediaStorageStrategyGets size of media data in bytes.- Specified by:
getSizein interfaceMediaStorageStrategy- Parameters:
config- media folder configurationlocation- the string representation of location of media data in storage- Returns:
- the size of an media data in bytes
-
setLocationHashService
-
setS3StorageServiceFactory
-
setMediaHeadersRegistry
-