de.hybris.platform.media.storage.impl

Class DefaultLocalMediaFileCacheService

java.lang.Object

de.hybris.platform.media.storage.impl.DefaultLocalMediaFileCacheService

All Implemented Interfaces:

LocalMediaFileCacheService

public class DefaultLocalMediaFileCacheService
extends java.lang.Object
implements LocalMediaFileCacheService

Default implementation of LocalMediaFileCache interface. Allows to cache locally any stream and returns binary data as File or FileInputStream from local cache.

To configure folder to use local cache use following property key:

 folder.folderQualifier.local.cache = true
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultLocalMediaFileCacheService.MediaCacheFileInputStream
static class	DefaultLocalMediaFileCacheService.MediaCacheKey
static class	DefaultLocalMediaFileCacheService.MediaCacheUnit

Nested classes/interfaces inherited from interface de.hybris.platform.media.storage.LocalMediaFileCacheService

LocalMediaFileCacheService.StreamGetter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_FILE_NAME_DELIM

Constructor Summary

Constructors

Constructor and Description
DefaultLocalMediaFileCacheService()

Method Summary

Modifier and Type	Method and Description
void	init() Recreates cache and adds lifecycle callback after bean construction
void	removeFromCache(MediaStorageConfigService.MediaFolderConfig config, java.lang.String location) Removes given media from local cache.
void	setCacheController(CacheController cacheController)
void	setCacheRecreator(MediaCacheRecreator cacheRecreator)
void	setMainDataDir(java.io.File mainDataDir)
void	setMediaCacheRegion(MediaCacheRegion mediaCacheRegion)
void	setStorageConfigService(MediaStorageConfigService storageConfigService)
void	setStorageRegistry(MediaStorageRegistry storageRegistry)
void	setStorageStrategy(LocalFileMediaStorageStrategy storageStrategy)
java.io.File	storeOrGetAsFile(MediaStorageConfigService.MediaFolderConfig config, java.lang.String location, LocalMediaFileCacheService.StreamGetter streamGetter) Checks whether there is local cached version of media data and stores it if not, then returns it as regular File taken from cache.
java.io.InputStream	storeOrGetAsStream(MediaStorageConfigService.MediaFolderConfig config, java.lang.String location, LocalMediaFileCacheService.StreamGetter streamGetter) Checks whether there is local cached version of media data and stores it if not, then returns it as FileInputStream build on top of cached file.

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_FILE_NAME_DELIM

public static final java.lang.String CACHE_FILE_NAME_DELIM

See Also:

Constant Field Values

Constructor Detail

DefaultLocalMediaFileCacheService

public DefaultLocalMediaFileCacheService()

Method Detail

init

@PostConstruct
public void init()

Recreates cache and adds lifecycle callback after bean construction

storeOrGetAsFile

public java.io.File storeOrGetAsFile(MediaStorageConfigService.MediaFolderConfig config,
                                     java.lang.String location,
                                     LocalMediaFileCacheService.StreamGetter streamGetter)

Description copied from interface: LocalMediaFileCacheService

Checks whether there is local cached version of media data and stores it if not, then returns it as regular File taken from cache.

Specified by:

storeOrGetAsFile in interface LocalMediaFileCacheService

Parameters:

config - media folder config object

location - the location

streamGetter - the stream getter which returns proper data stream for particular Media item.

Returns:

the File object

storeOrGetAsStream

public java.io.InputStream storeOrGetAsStream(MediaStorageConfigService.MediaFolderConfig config,
                                              java.lang.String location,
                                              LocalMediaFileCacheService.StreamGetter streamGetter)

Description copied from interface: LocalMediaFileCacheService

Checks whether there is local cached version of media data and stores it if not, then returns it as FileInputStream build on top of cached file.

Specified by:

storeOrGetAsStream in interface LocalMediaFileCacheService

Parameters:

config - media folder config object

location - the location

streamGetter - the stream getter which returns proper data stream for particular Media item.

Returns:

the FileInputStream object

removeFromCache

public void removeFromCache(MediaStorageConfigService.MediaFolderConfig config,
                            java.lang.String location)

Description copied from interface: LocalMediaFileCacheService

Removes given media from local cache. This method is safe in terms of whenever some stream is already opened it will wait with removing cached file from disk until last client will close stream.

Specified by:

removeFromCache in interface LocalMediaFileCacheService

Parameters:

config - media folder config object

location - the location of cached file in real storage

setMainDataDir

public void setMainDataDir(java.io.File mainDataDir)

setCacheController

public void setCacheController(CacheController cacheController)

setStorageRegistry

public void setStorageRegistry(MediaStorageRegistry storageRegistry)

setStorageStrategy

public void setStorageStrategy(LocalFileMediaStorageStrategy storageStrategy)

setMediaCacheRegion

public void setMediaCacheRegion(MediaCacheRegion mediaCacheRegion)

setStorageConfigService

public void setStorageConfigService(MediaStorageConfigService storageConfigService)

setCacheRecreator

public void setCacheRecreator(MediaCacheRecreator cacheRecreator)