org.broadleafcommerce.vendor.amazon.s3

Class S3FileServiceProvider

java.lang.Object

org.broadleafcommerce.vendor.amazon.s3.S3FileServiceProvider

All Implemented Interfaces:

org.broadleafcommerce.common.file.service.FileServiceProvider

@Service(value="blS3FileServiceProvider")
public class S3FileServiceProvider
extends Object
implements org.broadleafcommerce.common.file.service.FileServiceProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.file.service.BroadleafFileService	blFileService
protected org.broadleafcommerce.common.io.ConcurrentFileOutputStream	concurrentFileOutputStream
protected Map<S3Configuration,com.amazonaws.services.s3.AmazonS3>	configClientMap
protected S3ConfigurationService	s3ConfigurationService

Constructor Summary

Constructors

Constructor and Description
S3FileServiceProvider()

Method Summary

Modifier and Type	Method and Description
void	addOrUpdateResources(org.broadleafcommerce.common.file.domain.FileWorkArea workArea, List<File> files, boolean removeFilesFromWorkArea)
List<String>	addOrUpdateResourcesForPaths(org.broadleafcommerce.common.file.domain.FileWorkArea workArea, List<File> files, boolean removeFilesFromWorkArea) Writes the resource to S3.
protected List<String>	addOrUpdateResourcesInternal(S3Configuration s3config, com.amazonaws.services.s3.AmazonS3 s3, org.broadleafcommerce.common.file.domain.FileWorkArea workArea, List<File> files, boolean removeFilesFromWorkArea)
protected String	buildResourceName(String name) hook for overriding name used for resource in S3
protected com.amazonaws.services.s3.AmazonS3	getAmazonS3Client(S3Configuration s3config)
protected com.amazonaws.services.s3.AmazonS3	getAmazonS3ClientFromConfiguration(S3Configuration s3config) Creates an instance of the S3 Client based on the 'use instance profile' property.
protected com.amazonaws.auth.AWSCredentials	getAWSCredentials(S3Configuration s3configParam)
File	getResource(String name)
File	getResource(String name, org.broadleafcommerce.common.file.service.type.FileApplicationType fileApplicationType)
protected String	getSiteDirectory(org.broadleafcommerce.common.site.domain.Site site)
protected String	getSiteSpecificResourceName(String resourceName)
boolean	removeResource(String name)
void	setBroadleafFileService(org.broadleafcommerce.common.file.service.BroadleafFileService bfs)
void	setConcurrentFileOutputStream(org.broadleafcommerce.common.io.ConcurrentFileOutputStream concurrentFileOutputStream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

s3ConfigurationService

protected S3ConfigurationService s3ConfigurationService

blFileService

protected org.broadleafcommerce.common.file.service.BroadleafFileService blFileService

configClientMap

protected Map<S3Configuration,com.amazonaws.services.s3.AmazonS3> configClientMap

concurrentFileOutputStream

protected org.broadleafcommerce.common.io.ConcurrentFileOutputStream concurrentFileOutputStream

Constructor Detail

S3FileServiceProvider

public S3FileServiceProvider()

Method Detail

getResource

public File getResource(String name)

Specified by:

getResource in interface org.broadleafcommerce.common.file.service.FileServiceProvider

getResource

public File getResource(String name,
                        org.broadleafcommerce.common.file.service.type.FileApplicationType fileApplicationType)

Specified by:

getResource in interface org.broadleafcommerce.common.file.service.FileServiceProvider

addOrUpdateResources

public void addOrUpdateResources(org.broadleafcommerce.common.file.domain.FileWorkArea workArea,
                                 List<File> files,
                                 boolean removeFilesFromWorkArea)

Specified by:

addOrUpdateResources in interface org.broadleafcommerce.common.file.service.FileServiceProvider

addOrUpdateResourcesForPaths

public List<String> addOrUpdateResourcesForPaths(org.broadleafcommerce.common.file.domain.FileWorkArea workArea,
                                                 List<File> files,
                                                 boolean removeFilesFromWorkArea)

Writes the resource to S3. If the bucket returns as "NoSuchBucket" then will attempt to create the bucket and try again.

Specified by:

addOrUpdateResourcesForPaths in interface org.broadleafcommerce.common.file.service.FileServiceProvider

addOrUpdateResourcesInternal

protected List<String> addOrUpdateResourcesInternal(S3Configuration s3config,
                                                    com.amazonaws.services.s3.AmazonS3 s3,
                                                    org.broadleafcommerce.common.file.domain.FileWorkArea workArea,
                                                    List<File> files,
                                                    boolean removeFilesFromWorkArea)

removeResource

public boolean removeResource(String name)

Specified by:

removeResource in interface org.broadleafcommerce.common.file.service.FileServiceProvider

buildResourceName

protected String buildResourceName(String name)

hook for overriding name used for resource in S3

Parameters:

name -

Returns:

getSiteSpecificResourceName

protected String getSiteSpecificResourceName(String resourceName)

getSiteDirectory

protected String getSiteDirectory(org.broadleafcommerce.common.site.domain.Site site)

getAmazonS3Client

protected com.amazonaws.services.s3.AmazonS3 getAmazonS3Client(S3Configuration s3config)

getAmazonS3ClientFromConfiguration

protected com.amazonaws.services.s3.AmazonS3 getAmazonS3ClientFromConfiguration(S3Configuration s3config)

Creates an instance of the S3 Client based on the 'use instance profile' property. If it exists, it retrieves credentials from the IAM role (valid only on EC2 instances). Otherwise, a secret key and access key ID must be provided.

Parameters:

s3config - Configuration object

Returns:

an authenticated AmazonS3Client

getAWSCredentials

protected com.amazonaws.auth.AWSCredentials getAWSCredentials(S3Configuration s3configParam)

setBroadleafFileService

public void setBroadleafFileService(org.broadleafcommerce.common.file.service.BroadleafFileService bfs)

setConcurrentFileOutputStream

public void setConcurrentFileOutputStream(org.broadleafcommerce.common.io.ConcurrentFileOutputStream concurrentFileOutputStream)