Package de.hybris.platform.mediaconversion.conversion

Class DefaultMediaConversionService

java.lang.Object

de.hybris.platform.mediaconversion.conversion.DefaultMediaConversionService

All Implemented Interfaces:

MediaConversionService, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class DefaultMediaConversionService
extends java.lang.Object
implements MediaConversionService, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

Default MediaConversionService implementation.

Constructor Summary

Constructors

Constructor	Description
DefaultMediaConversionService()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	convertMedias(MediaContainerModel container)	Converts the MediaContainerModel's master media to all formats which are currently not present in the given MediaContainerModel.
int	deleteConvertedMedias(MediaContainerModel container)	Removes all converted medias within the specified MediaContainerModel.
protected MediaModel	doConvert(MediaContainerModel container, ConversionMediaFormatModel format)
java.util.Collection<ConversionMediaFormatModel>	getAllConversionFormats()	Retrieves all configured ConversionMediaFormatModel from database.
org.springframework.context.ApplicationContext	getApplicationContext()
ConversionErrorLogStrategy	getConversionErrorLogStrategy()
ConversionStatus	getConversionStatus(MediaContainerModel model)	Computes the current ConversionStatus for the given MediaContainerModel.
java.util.Collection<MediaModel>	getConvertedMedias(MediaContainerModel container)	Retrieves all converted medias in the given MediaContainerModel, i.e.
MediaConversionServiceDao	getDao()
LockRowInTransactionStrategy	getLockRowInTransactionStrategy()
MediaModel	getMaster(MediaContainerModel model)	Retrieves the current 'master' MediaModel of the given MediaContainerModel.
protected MediaConversionStrategy	getMediaConversionStrategy(ConversionMediaFormatModel format)
MediaService	getMediaService()
ModelService	getModelService()
MediaModel	getOrConvert(MediaContainerModel container, MediaFormatModel format)	Retrieves the MediaModel in the specified MediaFormatModel associated with the given MediaContainerModel.
protected MediaModel	getUpToDateMediaByFormat(MediaContainerModel container, MediaFormatModel format)	Retrieves the media in the given format and checks whether it is up to date.
protected boolean	isUpToDate(MediaModel ret)	Checks whether a media is up to date.
protected java.util.Collection<MediaModel>	selectDerivedMedias(MediaContainerModel container)	Naive approach to determine the derived medias of an MediaContainerModel.
protected MediaModel	selectMasterFromUnsavedContainer(MediaContainerModel model)	Naive approach to determine the master of an MediaContainerModel.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setConversionErrorLogStrategy(ConversionErrorLogStrategy whoToDoIt)
void	setDao(MediaConversionServiceDao dao)
void	setLockRowInTransactionStrategy(LockRowInTransactionStrategy strategy)
void	setMediaService(MediaService mediaService)
void	setModelService(ModelService modelService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMediaConversionService

public DefaultMediaConversionService()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

See Also:

InitializingBean.afterPropertiesSet()

deleteConvertedMedias

public int deleteConvertedMedias(MediaContainerModel container)

Removes all converted medias within the specified MediaContainerModel.

Specified by:

deleteConvertedMedias in interface MediaConversionService

Parameters:

container - the MediaContainerModel to clean up

Returns:

the number of medias removed

See Also:

MediaConversionService.deleteConvertedMedias(MediaContainerModel)

getConvertedMedias

public java.util.Collection<MediaModel> getConvertedMedias(MediaContainerModel container)

Retrieves all converted medias in the given MediaContainerModel, i.e. all medias within this container which have a parent and a format set.

Specified by:

getConvertedMedias in interface MediaConversionService

Parameters:

container - the MediaContainerModel in question.

Returns:

A collection of all converted medias in the given MediaContainerModel.

See Also:

MediaConversionService.getConvertedMedias(MediaContainerModel)

selectDerivedMedias

protected java.util.Collection<MediaModel> selectDerivedMedias(MediaContainerModel container)

Naive approach to determine the derived medias of an MediaContainerModel. This method is just used if the container is not persisted yet, otherwise a query on the database if used.

Parameters:

container - the container to determine the derived medias for

Returns:

collection of derived medias of the given container

See Also:

MediaConversionService.getConvertedMedias(MediaContainerModel)

convertMedias

public void convertMedias(MediaContainerModel container)

Converts the MediaContainerModel's master media to all formats which are currently not present in the given MediaContainerModel.

Specified by:

convertMedias in interface MediaConversionService

Parameters:

container - the MediaContainerModel to 'fill up'.

See Also:

MediaConversionService.convertMedias(MediaContainerModel)

getAllConversionFormats

public java.util.Collection<ConversionMediaFormatModel> getAllConversionFormats()

Retrieves all configured ConversionMediaFormatModel from database.

Specified by:

getAllConversionFormats in interface MediaConversionService

Returns:

all currently configured ConversionMediaFormatModels.

See Also:

MediaConversionService.getAllConversionFormats()

getConversionStatus

public ConversionStatus getConversionStatus(MediaContainerModel model)

Computes the current ConversionStatus for the given MediaContainerModel. The conversion status is

• ConversionStatus.EMPTY, if the container has no master, or
• ConversionStatus.UNCONVERTED, if there are none of the target formats available,
• ConversionStatus.PARTIALLY_CONVERTED, if there are some of the target formats available, or
• ConversionStatus.CONVERTED, if all of the target formats are available.

Wherein the target formats are defined through the either

• the supportedFormat of the assigned ConversionGroupModel or
• all ConversionMediaFormatModel instances in the system, if no ConversionGroupModel is set on the given MediaContainerModel

Specified by:

getConversionStatus in interface MediaConversionService

Parameters:

model - the MediaContainerModel to compute the conversion status for

Returns:

the current ConversionStatus for the given MediaContainerModel

See Also:

MediaConversionService.getConversionStatus(MediaContainerModel)

getMaster

public MediaModel getMaster(MediaContainerModel model)

Retrieves the current 'master' MediaModel of the given MediaContainerModel. The master media is defined as the MediaModel within the MediaContainerModel which has no original and no original data pk set (attributes MediaModel.ORIGINAL and MediaModel.ORIGINALDATAPK).

Specified by:

getMaster in interface MediaConversionService

Parameters:

model - the MediaContainerModel in question

Returns:

the current master media or null if no such media exists.

See Also:

MediaConversionService.getMaster(MediaContainerModel)

selectMasterFromUnsavedContainer

protected MediaModel selectMasterFromUnsavedContainer(MediaContainerModel model)

Naive approach to determine the master of an MediaContainerModel. This method is just used if the container is not persisted yet, otherwise a query on the database if used.

Parameters:

model - the container to determine the master for

Returns:

the master media of the given container or null if none could be determined

See Also:

MediaConversionService.getMaster(MediaContainerModel)

getOrConvert

public MediaModel getOrConvert(MediaContainerModel container,
                               MediaFormatModel format)

Description copied from interface: MediaConversionService

Retrieves the MediaModel in the specified MediaFormatModel associated with the given MediaContainerModel. If no such media exists the service will try to convert the media to that format automatically (synchronous). The conversion will also be performed if the converted media is outdated, i.e. if the binary data of the converted media's original is not the same anymore.

Specified by:

getOrConvert in interface MediaConversionService

Parameters:

container - the MediaContainerModel to search.

format - the MediaFormatModel to retrieve.

Returns:

the MediaModel of the given MediaContainerModel in the given MediaFormatModel.

getUpToDateMediaByFormat

protected MediaModel getUpToDateMediaByFormat(MediaContainerModel container,
                                              MediaFormatModel format)

Retrieves the media in the given format and checks whether it is up to date.

Throws:

ModelNotFoundException - if the media does not exist or is not up to date.

isUpToDate

protected boolean isUpToDate(MediaModel ret)

Checks whether a media is up to date.

Parameters:

ret - the media to check

Returns:

true if the given MediaModel is up to date and needs no conversion

doConvert

protected MediaModel doConvert(MediaContainerModel container,
                               ConversionMediaFormatModel format)
                        throws MediaConversionException

Throws:

MediaConversionException

getMediaConversionStrategy

protected MediaConversionStrategy getMediaConversionStrategy(ConversionMediaFormatModel format)
                                                      throws org.springframework.beans.factory.NoSuchBeanDefinitionException

Throws:

org.springframework.beans.factory.NoSuchBeanDefinitionException

getMediaService

public MediaService getMediaService()

setMediaService

public void setMediaService(MediaService mediaService)

getModelService

public ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getDao

public MediaConversionServiceDao getDao()

setDao

public void setDao(MediaConversionServiceDao dao)

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

See Also:

ApplicationContextAware.setApplicationContext(ApplicationContext)

getLockRowInTransactionStrategy

public LockRowInTransactionStrategy getLockRowInTransactionStrategy()

setLockRowInTransactionStrategy

public void setLockRowInTransactionStrategy(LockRowInTransactionStrategy strategy)

getConversionErrorLogStrategy

public ConversionErrorLogStrategy getConversionErrorLogStrategy()

setConversionErrorLogStrategy

public void setConversionErrorLogStrategy(ConversionErrorLogStrategy whoToDoIt)