Package org.broadleafcommerce.cms.file.service

Class StaticAssetServiceImpl

java.lang.Object

org.broadleafcommerce.cms.file.service.StaticAssetServiceImpl

All Implemented Interfaces:

StaticAssetService

@Service("blStaticAssetService")
public class StaticAssetServiceImpl
extends Object
implements StaticAssetService

Created by bpolster.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	allowedFileExtensions
protected String	disabledFileExtensions
protected boolean	exceptionOnInvalidChar
protected ImageArtifactProcessor	imageArtifactProcessor
protected char[]	notAllowedCharsInFileName
protected String	replacementString
protected boolean	shouldAcceptNonImageAsset
protected StaticAssetDao	staticAssetDao
protected StaticAssetMultiTenantExtensionManager	staticAssetExtensionManager
protected org.broadleafcommerce.common.file.service.StaticAssetPathService	staticAssetPathService
protected StaticAssetStorageService	staticAssetStorageService
protected boolean	storeAssetsOnFileSystem

Constructor Summary

Constructors

Constructor	Description
StaticAssetServiceImpl()

Method Summary

Modifier and Type	Method	Description
StaticAsset	addStaticAsset(StaticAsset staticAsset)	Add an asset outside of Broadleaf Admin.
protected String	buildAssetURL(Map<String,String> assetProperties, String originalFilename)	Will assemble the url from the passed in properties as /{entityType}/{fileName} /product/7001-ab12
String	convertAssetPath(String assetPath, String contextPath, boolean secureRequest)
protected StaticAsset	createNonImageAsset(InputStream inputStream, String fileName, Map<String,String> properties)	Hook-point for implementors to add custom business logic for handling files that are non-images
StaticAsset	createStaticAsset(InputStream inputStream, String fileName, long fileSize, Map<String,String> properties)	Similar to StaticAssetService.createStaticAssetFromFile(MultipartFile, Map) except not dependent upon an uploaded file from a controller
StaticAsset	createStaticAssetFromFile(org.springframework.web.multipart.MultipartFile file, Map<String,String> properties)	Used when uploading a file to Broadleaf.
void	deleteStaticAsset(StaticAsset staticAsset)	Delete an asset outside of Broadleaf Admin.
StaticAsset	findStaticAssetByFullUrl(String fullUrl)
StaticAsset	findStaticAssetById(Long id)
Long	findTotalStaticAssetCount()
protected String	generateFileName(int size)	Generates a filename as a set of Hex digits.
String	getAllowedFileExtensions()
protected String	getCountUrl(String fullUrl, int count, boolean legacyFormat)	Gets the count URL based on the original fullUrl.
String	getDisabledFileExtensions()
protected String	getFileExtension(String fileName)
protected void	getMimeType(InputStream inputStream, String fileName, StaticAsset newAsset)
String	getPrefixedStaticAssetUrl(String assetUrl)	Return a prefixed version of the given asset url, assuming a static asset url prefix is set
boolean	getShouldAcceptNonImageAsset()
String	getStaticAssetEnvironmentSecureUrlPrefix()
String	getStaticAssetEnvironmentUrlPrefix()
String	getStaticAssetUrlPrefix()
List<StaticAsset>	readAllStaticAssets()
void	setAllowedFileExtensions(String allowedFileExtensions)
void	setDisabledFileExtensions(String disabledFileExtensions)
void	setShouldAcceptNonImageAsset(boolean accept)
StaticAsset	updateStaticAsset(StaticAsset staticAsset)	Update an asset outside of Broadleaf Admin.
void	validateFileExtension(org.springframework.web.multipart.MultipartFile file)
protected boolean	validateFileName(String fileName)

Methods inherited from class java.lang.Object

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

Field Details

imageArtifactProcessor

protected ImageArtifactProcessor imageArtifactProcessor

storeAssetsOnFileSystem

@Value("${asset.use.filesystem.storage}")
protected boolean storeAssetsOnFileSystem

staticAssetDao

protected StaticAssetDao staticAssetDao

staticAssetStorageService

protected StaticAssetStorageService staticAssetStorageService

staticAssetPathService

protected org.broadleafcommerce.common.file.service.StaticAssetPathService staticAssetPathService

staticAssetExtensionManager

protected StaticAssetMultiTenantExtensionManager staticAssetExtensionManager

shouldAcceptNonImageAsset

@Value("${should.accept.non.image.asset:true}")
protected boolean shouldAcceptNonImageAsset

disabledFileExtensions

@Value("${disabled.file.extensions}")
protected String disabledFileExtensions

allowedFileExtensions

@Value("${allowed.file.extensions}")
protected String allowedFileExtensions

notAllowedCharsInFileName

@Value("${static.asset.invalid.chars.in.filename}")
protected char[] notAllowedCharsInFileName

exceptionOnInvalidChar

@Value("${static.asset.exception.on.invalid.char.in.filename:false}")
protected boolean exceptionOnInvalidChar

replacementString

@Value("${static.asset.invalid.chars.replacement}")
protected String replacementString

Constructor Details

StaticAssetServiceImpl

public StaticAssetServiceImpl()

Method Details

findStaticAssetById

public StaticAsset findStaticAssetById(Long id)

Specified by:

findStaticAssetById in interface StaticAssetService

readAllStaticAssets

public List<StaticAsset> readAllStaticAssets()

Specified by:

readAllStaticAssets in interface StaticAssetService

findTotalStaticAssetCount

public Long findTotalStaticAssetCount()

Specified by:

findTotalStaticAssetCount in interface StaticAssetService

getFileExtension

protected String getFileExtension(String fileName)

generateFileName

protected String generateFileName(int size)

Generates a filename as a set of Hex digits.

Parameters:

size -

Returns:

buildAssetURL

protected String buildAssetURL(Map<String,String> assetProperties,
 String originalFilename)

Will assemble the url from the passed in properties as /{entityType}/{fileName} /product/7001-ab12

If the properties above are not set, it will generate the fileName randomly.

Parameters:

assetProperties -

originalFilename -

Returns:

validateFileExtension

public void validateFileExtension(org.springframework.web.multipart.MultipartFile file)
                           throws IOException

Throws:

IOException

createStaticAssetFromFile

@Transactional("blTransactionManager")
public StaticAsset createStaticAssetFromFile(org.springframework.web.multipart.MultipartFile file,
 Map<String,String> properties)

Description copied from interface: StaticAssetService

Used when uploading a file to Broadleaf. This method will create the corresponding asset.

Depending on the the implementation, the actual asset may be saved to the DB or to the file system. The default implementation StaticAssetServiceImpl has a environment properties that determine this behavior asset.use.filesystem.storage

The properties Map allows for implementors to update other Asset properties at the same time they are uploading a file. The default implementation uses this for an optional URL to be specified.

To actually create the physical file that this asset represents see StaticAssetStorageService.createStaticAssetStorageFromFile(MultipartFile, StaticAsset)

Specified by:

createStaticAssetFromFile in interface StaticAssetService

Parameters:

file - - the file being uploaded

properties - - additional meta-data properties

Returns:

See Also:

• StaticAssetServiceImpl

validateFileName

protected boolean validateFileName(String fileName)

createStaticAsset

@Transactional("blTransactionManager")
public StaticAsset createStaticAsset(InputStream inputStream,
 String fileName,
 long fileSize,
 Map<String,String> properties)

Description copied from interface: StaticAssetService

Similar to StaticAssetService.createStaticAssetFromFile(MultipartFile, Map) except not dependent upon an uploaded file from a controller

To actually create the physical file that this asset represents see StaticAssetStorageService.createStaticAssetStorage(InputStream, StaticAsset)

Specified by:

createStaticAsset in interface StaticAssetService

Parameters:

inputStream - the input stream of a file to create the asset from

fileName - the name of the file

fileSize - the size of the file, in bytes

properties - additional metadata properties

Returns:

createNonImageAsset

protected StaticAsset createNonImageAsset(InputStream inputStream,
 String fileName,
 Map<String,String> properties)

Hook-point for implementors to add custom business logic for handling files that are non-images

Parameters:

inputStream -

fileName -

properties -

Returns:

getCountUrl

protected String getCountUrl(String fullUrl,
 int count,
 boolean legacyFormat)

Gets the count URL based on the original fullUrl. If requested in legacy format this will return URLs like:

/path/to/image.jpg-1 /path/to/image.jpg-2

Whereas if this is in non-legacy format (legacy == false):

/path/to/image-1.jpg /path/to/image-2.jpg

Used to deal with duplicate URLs of uploaded assets

getMimeType

protected void getMimeType(InputStream inputStream,
 String fileName,
 StaticAsset newAsset)

findStaticAssetByFullUrl

public StaticAsset findStaticAssetByFullUrl(String fullUrl)

Specified by:

findStaticAssetByFullUrl in interface StaticAssetService

addStaticAsset

@Transactional("blTransactionManager")
public StaticAsset addStaticAsset(StaticAsset staticAsset)

Description copied from interface: StaticAssetService

Add an asset outside of Broadleaf Admin.

Specified by:

addStaticAsset in interface StaticAssetService

Returns:

updateStaticAsset

@Transactional("blTransactionManager")
public StaticAsset updateStaticAsset(StaticAsset staticAsset)

Description copied from interface: StaticAssetService

Update an asset outside of Broadleaf Admin.

Specified by:

updateStaticAsset in interface StaticAssetService

Returns:

deleteStaticAsset

@Transactional("blTransactionManager")
public void deleteStaticAsset(StaticAsset staticAsset)

Description copied from interface: StaticAssetService

Delete an asset outside of Broadleaf Admin.

Specified by:

deleteStaticAsset in interface StaticAssetService

getStaticAssetUrlPrefix

public String getStaticAssetUrlPrefix()

Specified by:

getStaticAssetUrlPrefix in interface StaticAssetService

See Also:

• StaticAssetPathService.getStaticAssetUrlPrefix()

getPrefixedStaticAssetUrl

public String getPrefixedStaticAssetUrl(String assetUrl)

Description copied from interface: StaticAssetService

Return a prefixed version of the given asset url, assuming a static asset url prefix is set

Specified by:

getPrefixedStaticAssetUrl in interface StaticAssetService

Returns:

getStaticAssetEnvironmentUrlPrefix

public String getStaticAssetEnvironmentUrlPrefix()

Specified by:

getStaticAssetEnvironmentUrlPrefix in interface StaticAssetService

See Also:

• StaticAssetPathService.getStaticAssetEnvironmentUrlPrefix()

getStaticAssetEnvironmentSecureUrlPrefix

public String getStaticAssetEnvironmentSecureUrlPrefix()

Specified by:

getStaticAssetEnvironmentSecureUrlPrefix in interface StaticAssetService

See Also:

• StaticAssetPathService.getStaticAssetEnvironmentSecureUrlPrefix()

convertAssetPath

public String convertAssetPath(String assetPath,
 String contextPath,
 boolean secureRequest)

Specified by:

convertAssetPath in interface StaticAssetService

See Also:

• StaticAssetPathService.convertAssetPath(String, String, boolean)

getShouldAcceptNonImageAsset

public boolean getShouldAcceptNonImageAsset()

setShouldAcceptNonImageAsset

public void setShouldAcceptNonImageAsset(boolean accept)

getDisabledFileExtensions

public String getDisabledFileExtensions()

setDisabledFileExtensions

public void setDisabledFileExtensions(String disabledFileExtensions)

getAllowedFileExtensions

public String getAllowedFileExtensions()

setAllowedFileExtensions

public void setAllowedFileExtensions(String allowedFileExtensions)