Package com.hybris.backoffice.config.impl

Class DefaultBackofficeConfigurationMediaHelper

java.lang.Object

com.hybris.backoffice.config.impl.DefaultBackofficeConfigurationMediaHelper

All Implemented Interfaces:

BackofficeConfigurationMediaHelper

public class DefaultBackofficeConfigurationMediaHelper
extends Object
implements BackofficeConfigurationMediaHelper

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	PROPERTY_BACKOFFICE_CONFIGURATION_SECURE_MEDIA_FOLDER

Constructor Summary

Constructors

Constructor	Description
DefaultBackofficeConfigurationMediaHelper()

Method Summary

Modifier and Type	Method	Description
protected void	assureSecureFolderAssignment(MediaModel mediaModel)	The method assures secure media folder assignment of the given media.
protected MediaFolderModel	createSecureFolder()
MediaModel	createWidgetsConfigMedia(String mediaCode, String mediaMime)	Creates Backoffice configuration media and in case media cannot be created returns existing media with given code
protected void	failOnInsecureFolderAssignment(String folderQualifier)
protected CatalogVersionModel	findBackofficeMediaCatalog()	Deprecated, for removal: This API element is subject to removal in a future version. Since 2205, replaced by MediaUtil.findMediaCatalogVersion().
protected MediaModel	findMediaByCode(String mediaCode)	Deprecated, for removal: This API element is subject to removal in a future version. Since 2205, replaced by MediaUtil.findMediaByCode(String).
MediaModel	findOrCreateWidgetsConfigMedia(String mediaCode, String mediaMime)	Searches for Backoffice configuration media and creates one in case media is not found.
MediaModel	findOrCreateWidgetsConfigMedia(String mediaCode, String mediaMime, Consumer<MediaModel> newMediaInitializer)	Searches for Backoffice configuration media and creates one in case media is not found.
MediaModel	findWidgetsConfigMedia(String mediaCode)	Searches for Backoffice configuration media and removes all configurations if given mediaCode is ambiguous.
MediaUtil	getBackofficeMediaUtil()
protected CatalogVersionService	getCatalogVersionService()	Deprecated, for removal: This API element is subject to removal in a future version. since 2205
protected BackofficeConfigurationDao	getConfigurationDao()
String	getMediaCatalogId()	Deprecated, for removal: This API element is subject to removal in a future version. since 2205
String	getMediaCatalogVersion()	Deprecated, for removal: This API element is subject to removal in a future version. since 2205
protected MediaService	getMediaService()
MediaStorageConfigService	getMediaStorageConfigService()
protected ModelService	getModelService()
protected SearchRestrictionService	getSearchRestrictionService()
MediaFolderModel	getSecureFolder()	The method tries to load the Media Folder of 'backofficeconfiguration' qualifier.
protected SessionService	getSessionService()
protected UserService	getUserService()
protected MediaFolderModel	loadSecureFolder()
protected void	removeAmbiguousConfiguration(String mediaCode)
void	setBackofficeMediaUtil(MediaUtil backofficeMediaUtil)
void	setCatalogVersionService(CatalogVersionService catalogVersionService)	Deprecated, for removal: This API element is subject to removal in a future version. since 2205
void	setConfigurationDao(BackofficeConfigurationDao configurationDao)
void	setMediaCatalogId(String mediaCatalogId)	Deprecated, for removal: This API element is subject to removal in a future version. since 2205
void	setMediaCatalogVersion(String mediaCatalogVersion)	Deprecated, for removal: This API element is subject to removal in a future version. since 2205
void	setMediaService(MediaService mediaService)
void	setMediaStorageConfigService(MediaStorageConfigService mediaStorageConfigService)
void	setModelService(ModelService modelService)
void	setSearchRestrictionService(SearchRestrictionService searchRestrictionService)
void	setSessionService(SessionService sessionService)
void	setUserService(UserService userService)

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_BACKOFFICE_CONFIGURATION_SECURE_MEDIA_FOLDER

protected static final String PROPERTY_BACKOFFICE_CONFIGURATION_SECURE_MEDIA_FOLDER

See Also:

• Constant Field Values

Constructor Details

DefaultBackofficeConfigurationMediaHelper

public DefaultBackofficeConfigurationMediaHelper()

Method Details

findOrCreateWidgetsConfigMedia

public MediaModel findOrCreateWidgetsConfigMedia(String mediaCode,
 String mediaMime,
 Consumer<MediaModel> newMediaInitializer)

Description copied from interface: BackofficeConfigurationMediaHelper

Searches for Backoffice configuration media and creates one in case media is not found.

Specified by:

findOrCreateWidgetsConfigMedia in interface BackofficeConfigurationMediaHelper

Parameters:

mediaCode - code of MediaModel to be searched for

mediaMime - mime type used when new MediaModel is created

newMediaInitializer - initializer callback to call for new media created by this method

Returns:

MediaModel corresponding with given mediaCode

findOrCreateWidgetsConfigMedia

public MediaModel findOrCreateWidgetsConfigMedia(String mediaCode,
 String mediaMime)

Description copied from interface: BackofficeConfigurationMediaHelper

Searches for Backoffice configuration media and creates one in case media is not found.

Specified by:

findOrCreateWidgetsConfigMedia in interface BackofficeConfigurationMediaHelper

Parameters:

mediaCode - code of MediaModel to be searched for

mediaMime - mime type used when new MediaModel is created

Returns:

MediaModel corresponding with given mediaCode

findWidgetsConfigMedia

public MediaModel findWidgetsConfigMedia(String mediaCode)

Description copied from interface: BackofficeConfigurationMediaHelper

Searches for Backoffice configuration media and removes all configurations if given mediaCode
is ambiguous.

Specified by:

findWidgetsConfigMedia in interface BackofficeConfigurationMediaHelper

Parameters:

mediaCode - code of MediaModel to be searched for

Returns:

MediaModel corresponding with given mediaCode

findMediaByCode

@Deprecated(since="2205",
            forRemoval=true)
protected MediaModel findMediaByCode(String mediaCode)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 2205, replaced by MediaUtil.findMediaByCode(String).

createWidgetsConfigMedia

public MediaModel createWidgetsConfigMedia(String mediaCode,
 String mediaMime)

Description copied from interface: BackofficeConfigurationMediaHelper

Creates Backoffice configuration media and in case media cannot be created
returns existing media with given code

Specified by:

createWidgetsConfigMedia in interface BackofficeConfigurationMediaHelper

Parameters:

mediaCode - code of MediaModel to be created

mediaMime - mime type used when new MediaModel is created

Returns:

MediaModel corresponding with given mediaCode

findBackofficeMediaCatalog

@Deprecated(since="2205",
            forRemoval=true)
protected CatalogVersionModel findBackofficeMediaCatalog()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 2205, replaced by MediaUtil.findMediaCatalogVersion().

removeAmbiguousConfiguration

protected void removeAmbiguousConfiguration(String mediaCode)

getSecureFolder

public MediaFolderModel getSecureFolder()

Description copied from interface: BackofficeConfigurationMediaHelper

The method tries to load the Media Folder of 'backofficeconfiguration' qualifier. If the folder is found it is returned. Otherwise the method tries to create it and return. In case of a race condition, where two subsequent saves happen and the method fails to save the folder, it re-tries the fetch and return before it finally fails.

Specified by:

getSecureFolder in interface BackofficeConfigurationMediaHelper

Returns:

the standard secure media folder for backoffice configurations

See Also:

• MediaFolderModel

loadSecureFolder

protected MediaFolderModel loadSecureFolder()

createSecureFolder

protected MediaFolderModel createSecureFolder()

assureSecureFolderAssignment

protected void assureSecureFolderAssignment(MediaModel mediaModel)

The method assures secure media folder assignment of the given media. The following scenarios are covered:

• if the media is not assigned to a folder or it is assigned to the root folder it will be assigned to the standard one and persisted if the persistChanged argument is set to true
• if the media is assigned to a folder which is secure (see MediaStorageConfigService) nothing will be done
• if the media is assigned to a folder which is not secure (see MediaStorageConfigService) IllegalStateException will be thrown

In case of a race condition, where two subsequent saves happen and the method fails to save the folder, it re-tries the fetch and return before it finally fails.

Parameters:

mediaModel - media to checked for secure folder assignment

Throws:

IllegalStateException - if the media is assigned to a non-secure folder

IllegalArgumentException - if the passed media is null

See Also:

• MediaStorageConfigService
• assureSecureFolderAssignment(MediaModel)
• MediaManager.ROOT_FOLDER_QUALIFIER

failOnInsecureFolderAssignment

protected void failOnInsecureFolderAssignment(String folderQualifier)

getSessionService

protected SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getSearchRestrictionService

protected SearchRestrictionService getSearchRestrictionService()

setSearchRestrictionService

public void setSearchRestrictionService(SearchRestrictionService searchRestrictionService)

getMediaService

protected MediaService getMediaService()

setMediaService

public void setMediaService(MediaService mediaService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getConfigurationDao

protected BackofficeConfigurationDao getConfigurationDao()

setConfigurationDao

public void setConfigurationDao(BackofficeConfigurationDao configurationDao)

getMediaStorageConfigService

public MediaStorageConfigService getMediaStorageConfigService()

setMediaStorageConfigService

public void setMediaStorageConfigService(MediaStorageConfigService mediaStorageConfigService)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)

getCatalogVersionService

@Deprecated(since="2205",
            forRemoval=true)
protected CatalogVersionService getCatalogVersionService()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2205

setCatalogVersionService

@Deprecated(since="2205",
            forRemoval=true)
public void setCatalogVersionService(CatalogVersionService catalogVersionService)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2205

getMediaCatalogId

@Deprecated(since="2205",
            forRemoval=true)
public String getMediaCatalogId()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2205

setMediaCatalogId

@Deprecated(since="2205",
            forRemoval=true)
public void setMediaCatalogId(String mediaCatalogId)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2205

getMediaCatalogVersion

@Deprecated(since="2205",
            forRemoval=true)
public String getMediaCatalogVersion()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2205

setMediaCatalogVersion

@Deprecated(since="2205",
            forRemoval=true)
public void setMediaCatalogVersion(String mediaCatalogVersion)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2205

getBackofficeMediaUtil

public MediaUtil getBackofficeMediaUtil()

setBackofficeMediaUtil

public void setBackofficeMediaUtil(MediaUtil backofficeMediaUtil)