StaticAssetStorageServiceImpl (BroadleafCommerce CMS Module 6.2.10-GA API)

java.lang.Object
- org.broadleafcommerce.cms.file.service.StaticAssetStorageServiceImpl

All Implemented Interfaces:: StaticAssetStorageService

@Service(value="blStaticAssetStorageService")
public class StaticAssetStorageServiceImpl
extends Object
implements StaticAssetStorageService

Author:: Jeff Fischer, Brian Polster

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArtifactService`	`artifactService`
`protected org.broadleafcommerce.common.file.service.BroadleafFileService`	`broadleafFileService`
`protected String`	`cacheDirectory`
`protected org.broadleafcommerce.common.io.ConcurrentFileOutputStream`	`concurrentFileOutputStream`
`protected static String`	`DEFAULT_ADMIN_IMAGE_EXTENSIONS`
`static long`	`DEFAULT_ASSET_UPLOAD_SIZE`
`protected static int`	`DEFAULT_BUFFER_SIZE`
`protected org.springframework.boot.autoconfigure.web.servlet.MultipartProperties`	`defaultMultipartSettings`
`protected org.springframework.core.env.Environment`	`env`
`protected StaticAssetServiceExtensionManager`	`extensionManager`
`protected NamedOperationManager`	`namedOperationManager`
`protected String`	`recompressFormats`
`protected StaticAssetService`	`staticAssetService`
`protected StaticAssetStorageDao`	`staticAssetStorageDao`
`protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil`	`transUtil`

Constructor Summary

Constructors
Constructor and Description

StaticAssetStorageServiceImpl()

Constructors
Constructor and Description
`StaticAssetStorageServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<String,String>`	`buildModel(String returnFilePath, String mimeType)`
`protected String`	`constructCacheFileName(StaticAsset staticAsset, Map<String,String> parameterMap)` Builds a file system path for the passed in static asset and paramaterMap.
`StaticAssetStorage`	`create()`
`Blob`	`createBlob(InputStream uploadedFileInputStream, long fileSize)` Creates a blob from an input stream with a given filesize.
`Blob`	`createBlob(org.springframework.web.multipart.MultipartFile uploadedFile)`
`protected void`	`createLocalFileFromClassPathResource(StaticAsset staticAsset, File baseLocalFile)`
`protected void`	`createLocalFileFromInputStream(InputStream is, File baseLocalFile)`
`void`	`createStaticAssetStorage(InputStream fileInputStream, StaticAsset staticAsset)` Similar to `StaticAssetStorageService.createStaticAssetStorageFromFile(MultipartFile, StaticAsset)` except that this does not depend on an uploaded file and can support more generic use cases
`void`	`createStaticAssetStorageFromFile(org.springframework.web.multipart.MultipartFile file, StaticAsset staticAsset)` Persists the file to the DB or FileSystem according to the staticAsset's StorageType.
`void`	`delete(StaticAssetStorage assetStorage)` Removes a static asset from the database.
`protected StaticAsset`	`findStaticAsset(String fullUrl)`
`StaticAssetStorage`	`findStaticAssetStorageById(Long id)` Returns a StaticAssetStorage object.
`protected List<String>`	`getAdminImageFileExtensions()`
`Map<String,String>`	`getCacheFileModel(String fullUrl, Map<String,String> parameterMap)`
`protected int`	`getFileBufferSize()`
`protected String`	`getFileExtension(String assetPath)`
`protected File`	`getFileFromLocalRepository(String cachedFileName)`
`protected long`	`getMaxUploadableFileSize()`
`protected long`	`getMaxUploadableImageSize()`
`protected long`	`getMaxUploadSizeForFile(String fileName)`
`protected boolean`	`isImageFile(String fileName)`
`protected File`	`lookupAssetAndCreateLocalFile(StaticAsset staticAsset, File baseLocalFile)`
`protected String`	`pad(String s, int length, char pad)`
`StaticAssetStorage`	`readStaticAssetStorageByStaticAssetId(Long id)` Returns a StaticAssetStorage object using the id of a related StaticAsset.
`StaticAssetStorage`	`save(StaticAssetStorage assetStorage)` Persists a static asset to the database.
`protected boolean`	`shouldRecompress(String mimeType)`
`protected boolean`	`shouldUseSharedFile(InputStream is)`
`void`	`validateFileSize(org.springframework.web.multipart.MultipartFile file)` Validates given file with the maximum upload file size value

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ADMIN_IMAGE_EXTENSIONS

protected static final String DEFAULT_ADMIN_IMAGE_EXTENSIONS

See Also:: Constant Field Values

DEFAULT_ASSET_UPLOAD_SIZE
```
public static final long DEFAULT_ASSET_UPLOAD_SIZE
```
See Also:

Constant Field Values

DEFAULT_BUFFER_SIZE
```
protected static final int DEFAULT_BUFFER_SIZE
```
See Also:

Constant Field Values

cacheDirectory
```
protected String cacheDirectory
```

env

@Autowired
protected org.springframework.core.env.Environment env

staticAssetService

protected StaticAssetService staticAssetService

broadleafFileService

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

artifactService

protected ArtifactService artifactService

staticAssetStorageDao

protected StaticAssetStorageDao staticAssetStorageDao

namedOperationManager

protected NamedOperationManager namedOperationManager

extensionManager

protected StaticAssetServiceExtensionManager extensionManager

transUtil

protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil

recompressFormats

@Value(value="${image.artifact.recompress.formats:png}")
protected String recompressFormats

defaultMultipartSettings

@Autowired(required=false)
protected org.springframework.boot.autoconfigure.web.servlet.MultipartProperties defaultMultipartSettings

concurrentFileOutputStream

protected org.broadleafcommerce.common.io.ConcurrentFileOutputStream concurrentFileOutputStream

Constructor Detail
- StaticAssetStorageServiceImpl
```
public StaticAssetStorageServiceImpl()
```

Method Detail
- findStaticAsset
```
protected StaticAsset findStaticAsset(String fullUrl)
```
- shouldUseSharedFile
```
protected boolean shouldUseSharedFile(InputStream is)
```
- getFileFromLocalRepository
```
protected File getFileFromLocalRepository(String cachedFileName)
```
- lookupAssetAndCreateLocalFile
```
protected File lookupAssetAndCreateLocalFile(StaticAsset staticAsset,
                                             File baseLocalFile)
                                      throws IOException,
                                             SQLException
```
  Throws:
  
  IOException
  
  SQLException
- createLocalFileFromClassPathResource
```
protected void createLocalFileFromClassPathResource(StaticAsset staticAsset,
                                                    File baseLocalFile)
                                             throws IOException
```
  Throws:
  
  IOException
- createLocalFileFromInputStream
```
protected void createLocalFileFromInputStream(InputStream is,
                                              File baseLocalFile)
                                       throws IOException
```
  Throws:
  
  IOException
- getCacheFileModel
```
public Map<String,String> getCacheFileModel(String fullUrl,
                                            Map<String,String> parameterMap)
                                     throws Exception
```
  Specified by:
  
  getCacheFileModel in interface StaticAssetStorageService
  
  Returns:
  
  Throws:
  
  Exception
- shouldRecompress
```
protected boolean shouldRecompress(String mimeType)
```
- buildModel
```
protected Map<String,String> buildModel(String returnFilePath,
                                        String mimeType)
```
- findStaticAssetStorageById
```
public StaticAssetStorage findStaticAssetStorageById(Long id)
```
  Description copied from interface: StaticAssetStorageService
  
  Returns a StaticAssetStorage object. Assumes that the asset is stored in the Database. Storing Assets in the DB is not the preferred mechanism for Broadleaf as of 3.0 so in most cases, this method would not be used by Broadleaf implementations.
  
  Specified by:
  
  findStaticAssetStorageById in interface StaticAssetStorageService
  
  Returns:
- create
```
public StaticAssetStorage create()
```
  Specified by:
  
  create in interface StaticAssetStorageService
  
  Returns:
- readStaticAssetStorageByStaticAssetId
```
public StaticAssetStorage readStaticAssetStorageByStaticAssetId(Long id)
```
  Description copied from interface: StaticAssetStorageService
  
  Returns a StaticAssetStorage object using the id of a related StaticAsset. Assumes that the asset is stored in the Database. Storing Assets in the DB is not the preferred mechanism for Broadleaf as of 3.0 so in most cases, this method would not be used by Broadleaf implementations.
  
  Specified by:
  
  readStaticAssetStorageByStaticAssetId in interface StaticAssetStorageService
  
  Returns:
- save
```
public StaticAssetStorage save(StaticAssetStorage assetStorage)
```
  Description copied from interface: StaticAssetStorageService
  
  Persists a static asset to the database. Not typically used since Broadleaf 3.0 as the preferred method for storing assets is on a shared-filesystem.
  
  Specified by:
  
  save in interface StaticAssetStorageService
  
  Returns:
- delete
```
public void delete(StaticAssetStorage assetStorage)
```
  Description copied from interface: StaticAssetStorageService
  
  Removes a static asset from the database. Not typically used since Broadleaf 3.0 as the preferred method for storing assets is on a shared-filesystem.
  
  Specified by:
  
  delete in interface StaticAssetStorageService
- createBlob
```
public Blob createBlob(org.springframework.web.multipart.MultipartFile uploadedFile)
                throws IOException
```
  Specified by:
  
  createBlob in interface StaticAssetStorageService
  
  Returns:
  
  Throws:
  
  IOException
- createBlob
```
public Blob createBlob(InputStream uploadedFileInputStream,
                       long fileSize)
                throws IOException
```
  Description copied from interface: StaticAssetStorageService
  
  Creates a blob from an input stream with a given filesize. This method wraps the call in a transactional tag.
  
  Specified by:
  
  createBlob in interface StaticAssetStorageService
  
  Returns:
  
  Throws:
  
  IOException
- constructCacheFileName
```
protected String constructCacheFileName(StaticAsset staticAsset,
                                        Map<String,String> parameterMap)
```
  Builds a file system path for the passed in static asset and paramaterMap.
  
  Parameters:
  
  staticAsset -
  
  parameterMap -
  
  Returns:
- pad
```
protected String pad(String s,
                     int length,
                     char pad)
```
- createStaticAssetStorageFromFile
```
@Transactional(value="blTransactionManagerAssetStorageInfo")
public void createStaticAssetStorageFromFile(org.springframework.web.multipart.MultipartFile file,
                                                                                                          StaticAsset staticAsset)
                                                                                                   throws IOException
```
  Description copied from interface: StaticAssetStorageService
  
  Persists the file to the DB or FileSystem according to the staticAsset's StorageType. Typically, the MultipartFile is passed in from a Controller like the AdminAssetUploadController
  
  Specified by:
  
  createStaticAssetStorageFromFile in interface StaticAssetStorageService
  
  Parameters:
  
  file - the uploaded file from the Spring controller
  
  staticAsset - the StaticAsset entity to obtain storage information from like file size and the file name, usually created from StaticAssetService.createStaticAssetFromFile(MultipartFile, Map)
  
  Throws:
  
  IOException
  
  See Also:
  
  StaticAssetService#createStaticAssetFromFile(MultipartFile, Map)}
- createStaticAssetStorage
```
@Transactional(value="blTransactionManagerAssetStorageInfo")
public void createStaticAssetStorage(InputStream fileInputStream,
                                                                                                  StaticAsset staticAsset)
                                                                                           throws IOException
```
  Description copied from interface: StaticAssetStorageService
  
  Similar to StaticAssetStorageService.createStaticAssetStorageFromFile(MultipartFile, StaticAsset) except that this does not depend on an uploaded file and can support more generic use cases
  
  Specified by:
  
  createStaticAssetStorage in interface StaticAssetStorageService
  
  Parameters:
  
  fileInputStream - the input stream of the uploaded file
  
  staticAsset - the StaticAsset entity to obtain storage information from like file size and the file name, usually created from StaticAssetService.createStaticAsset(InputStream, String, long, Map)
  
  Throws:
  
  IOException
  
  See Also:
  
  StaticAssetService#createStaticAsset(InputStream, String, long, Map)}
- getMaxUploadSizeForFile
```
protected long getMaxUploadSizeForFile(String fileName)
```
- isImageFile
```
protected boolean isImageFile(String fileName)
```
- getFileExtension
```
protected String getFileExtension(String assetPath)
```
- getMaxUploadableFileSize
```
protected long getMaxUploadableFileSize()
```
- getMaxUploadableImageSize
```
protected long getMaxUploadableImageSize()
```
- getFileBufferSize
```
protected int getFileBufferSize()
```
- getAdminImageFileExtensions
```
protected List<String> getAdminImageFileExtensions()
```
- validateFileSize
```
public void validateFileSize(org.springframework.web.multipart.MultipartFile file)
                      throws IOException
```
  Description copied from interface: StaticAssetStorageService
  
  Validates given file with the maximum upload file size value
  
  Specified by:
  
  validateFileSize in interface StaticAssetStorageService
  
  Throws:
  
  IOException

Class StaticAssetStorageServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ADMIN_IMAGE_EXTENSIONS

DEFAULT_ASSET_UPLOAD_SIZE

DEFAULT_BUFFER_SIZE

cacheDirectory

env

staticAssetService

broadleafFileService

artifactService

staticAssetStorageDao

namedOperationManager

extensionManager

transUtil

recompressFormats

defaultMultipartSettings

concurrentFileOutputStream

Constructor Detail

StaticAssetStorageServiceImpl

Method Detail

findStaticAsset

shouldUseSharedFile

getFileFromLocalRepository

lookupAssetAndCreateLocalFile

createLocalFileFromClassPathResource

createLocalFileFromInputStream

getCacheFileModel

shouldRecompress

buildModel

findStaticAssetStorageById

create

readStaticAssetStorageByStaticAssetId

save

delete

createBlob

createBlob

constructCacheFileName

pad

createStaticAssetStorageFromFile

createStaticAssetStorage

getMaxUploadSizeForFile

isImageFile

getFileExtension

getMaxUploadableFileSize

getMaxUploadableImageSize

getFileBufferSize

getAdminImageFileExtensions

validateFileSize