de.hybris.platform.media.storage.impl

Class DefaultMediaStorageConfigService

java.lang.Object

de.hybris.platform.media.storage.impl.DefaultMediaStorageConfigService

All Implemented Interfaces:

MediaStorageConfigService

public class DefaultMediaStorageConfigService
extends java.lang.Object
implements MediaStorageConfigService

Configuration object for media storage. Each MediaFolder object can contain separate configuration.

Spring Bean ID:

mediaStorageConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultMediaStorageConfigService.DefaultSettingKeys Keeps all default media configuration subKeys.

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

MediaStorageConfigService.AbstractStorageConfig, MediaStorageConfigService.GlobalMediaStorageConfig, MediaStorageConfigService.MediaFolderConfig

Constructor Summary

Constructors

Constructor and Description
DefaultMediaStorageConfigService(ConfigValueMappingRegistry valueMappingRegistry)

Method Summary

Modifier and Type	Method and Description
MediaStorageConfigService.MediaFolderConfig	getConfigForFolder(java.lang.String folderQualifier) Gets folder configuration for any media folder (not only directly configured in properties) which contains mandatory data like folder qualifier, media storage strategy ID as well information whether folder is secured, is local caching enabled and what is hashing depth.
java.lang.String	getDefaultCacheFolderName() Gets the default folder name under which all cached files will be stored.
java.lang.String	getDefaultStrategyId() Returns default storage strategy ID.
java.util.Set<MediaStorageConfigService.MediaFolderConfig>	getFolderConfigsForStrategy(java.lang.String strategyId) Gets all folder configurations for strategy identified by strategyId (Spring based).
MediaStorageConfigService.GlobalMediaStorageConfig	getGlobalSettingsForStrategy(java.lang.String strategyId) Gets the global settings for strategy identified by strategyId.
java.util.Collection<java.lang.String>	getSecuredFolders() Returns a collection of all secured folders (configured with media.folder.FOLDER_NAME.secured property).
void	init()
boolean	isStorageStrategyConfigured(java.lang.String strategyId) Checks if particular media storage strategy with strategyId is configured in properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMediaStorageConfigService

public DefaultMediaStorageConfigService(ConfigValueMappingRegistry valueMappingRegistry)

Method Detail

init

@PostConstruct
public void init()

isStorageStrategyConfigured

public boolean isStorageStrategyConfigured(java.lang.String strategyId)

Description copied from interface: MediaStorageConfigService

Checks if particular media storage strategy with strategyId is configured in properties. Storage strategy is considered as configured when it is either set as global strategy or one of media folders has it configured directly.

Specified by:

isStorageStrategyConfigured in interface MediaStorageConfigService

Parameters:

strategyId - the strategy id

Returns:

true, if storage strategy is configured

getSecuredFolders

public java.util.Collection<java.lang.String> getSecuredFolders()

Description copied from interface: MediaStorageConfigService

Returns a collection of all secured folders (configured with media.folder.FOLDER_NAME.secured property).

Specified by:

getSecuredFolders in interface MediaStorageConfigService

Returns:

all secured folders defined in properties

getConfigForFolder

public MediaStorageConfigService.MediaFolderConfig getConfigForFolder(java.lang.String folderQualifier)

Description copied from interface: MediaStorageConfigService

Gets folder configuration for any media folder (not only directly configured in properties) which contains mandatory data like folder qualifier, media storage strategy ID as well information whether folder is secured, is local caching enabled and what is hashing depth. Additionally any configured URL strategies and any attached to folder custom settings are available. Method will return also configuration for folders which are not configured directly in properties. In this case service will try to collect required configuration from default settings as well from storage strategy global settings. Keep in mind that this method does not execute any validation against database whether media folder identified by folderQualifier exists.

Specified by:

getConfigForFolder in interface MediaStorageConfigService

Parameters:

folderQualifier - the folder qualifier

Returns:

configuration for folder

getDefaultStrategyId

public java.lang.String getDefaultStrategyId()

Description copied from interface: MediaStorageConfigService

Returns default storage strategy ID. Default storage strategy is mandatory in configuration.

Specified by:

getDefaultStrategyId in interface MediaStorageConfigService

getFolderConfigsForStrategy

public java.util.Set<MediaStorageConfigService.MediaFolderConfig> getFolderConfigsForStrategy(java.lang.String strategyId)

Description copied from interface: MediaStorageConfigService

Gets all folder configurations for strategy identified by strategyId (Spring based). If no folders have been configured directly empty set will be returned.

Specified by:

getFolderConfigsForStrategy in interface MediaStorageConfigService

Parameters:

strategyId - the strategy Spring Bean id

Returns:

set of MediaFolderConfig objects containing folder configuration or empty set when storage strategy does not have any directly configured folders.

getGlobalSettingsForStrategy

public MediaStorageConfigService.GlobalMediaStorageConfig getGlobalSettingsForStrategy(java.lang.String strategyId)

Description copied from interface: MediaStorageConfigService

Gets the global settings for strategy identified by strategyId.

Specified by:

getGlobalSettingsForStrategy in interface MediaStorageConfigService

Parameters:

strategyId - the strategy id

Returns:

the global settings for strategy

getDefaultCacheFolderName

public java.lang.String getDefaultCacheFolderName()

Description copied from interface: MediaStorageConfigService

Gets the default folder name under which all cached files will be stored.

Specified by:

getDefaultCacheFolderName in interface MediaStorageConfigService