de.hybris.platform.mediaconversion

Interface MediaConversionService

All Known Implementing Classes:

DefaultMediaConversionService

public interface MediaConversionService

Service to convert medias and manage conversion formats and converted medias.

Since:

4.6

Method Summary

Modifier and Type	Method and Description
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.
java.util.Collection<ConversionMediaFormatModel>	getAllConversionFormats() Retrieves all configured ConversionMediaFormatModel from database.
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.
MediaModel	getMaster(MediaContainerModel model) Retrieves the current 'master' MediaModel of the given MediaContainerModel.
MediaModel	getOrConvert(MediaContainerModel container, MediaFormatModel format) Retrieves the MediaModel in the specified MediaFormatModel associated with the given MediaContainerModel.

Method Detail

deleteConvertedMedias

int deleteConvertedMedias(MediaContainerModel container)

Removes all converted medias within the specified MediaContainerModel.

Parameters:

container - the MediaContainerModel to clean up

Returns:

the number of medias removed

Throws:

java.lang.IllegalArgumentException - if the specified container is null.

convertMedias

void convertMedias(MediaContainerModel container)

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

Parameters:

container - the MediaContainerModel to 'fill up'.

Throws:

java.lang.IllegalArgumentException - if the specified container is null.

getConvertedMedias

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.

Parameters:

container - the MediaContainerModel in question.

Returns:

A collection of all converted medias in the given MediaContainerModel.

Throws:

java.lang.IllegalArgumentException - if the specified container is null.

getAllConversionFormats

java.util.Collection<ConversionMediaFormatModel> getAllConversionFormats()

Retrieves all configured ConversionMediaFormatModel from database.

Returns:

all currently configured ConversionMediaFormatModels.

getConversionStatus

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

Parameters:

model - the MediaContainerModel to compute the conversion status for

Returns:

the current ConversionStatus for the given MediaContainerModel

Throws:

java.lang.IllegalArgumentException - if the specified model is null.

getMaster

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).

Parameters:

model - the MediaContainerModel in question

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the specified model is null.

See Also:

MediaContainerModel.getMaster(), MediaModel.getOriginal()

getOrConvert

MediaModel getOrConvert(MediaContainerModel container,
                        MediaFormatModel format)

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.

Parameters:

container - the MediaContainerModel to search.

format - the MediaFormatModel to retrieve.

Returns:

the MediaModel of the given MediaContainerModel in the given MediaFormatModel.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters is null.

ModelNotFoundException - if the media could neither be retrieved nor converted.

Since:

4.6