org.nuxeo.ecm.core.convert.api
Interface ConversionService

All Known Subinterfaces:

ConversionServiceManager

All Known Implementing Classes:

ConversionServiceImpl

public interface ConversionService

Interface for the Conversion Service.

Author:

tiry

Method Summary

BlobHolder	convert(String converterName, BlobHolder blobHolder, Map<String,Serializable> parameters) Converts a Blob given a converter name.
BlobHolder	convertToMimeType(String destinationMimeType, BlobHolder blobHolder, Map<String,Serializable> parameters) Converts a Blob given a target destination MimeType.
String	getConverterName(String sourceMimeType, String destinationMimeType) Gets the convertName given a source and destination MimeType.
List<String>	getConverterNames(String sourceMimeType, String destinationMimeType) Gets the available convertNames given a source and destination MimeType.
List<String>	getRegistredConverters() Returns the names of the registered converters.
ConverterCheckResult	isConverterAvailable(String converterName) Checks for converter availability.
ConverterCheckResult	isConverterAvailable(String converterName, boolean refresh) Checks for converter availability.

Method Detail

getConverterName

String getConverterName(String sourceMimeType,
                        String destinationMimeType)

Gets the convertName given a source and destination MimeType.

getConverterNames

List<String> getConverterNames(String sourceMimeType,
                               String destinationMimeType)

Gets the available convertNames given a source and destination MimeType.

convert

BlobHolder convert(String converterName,
                   BlobHolder blobHolder,
                   Map<String,Serializable> parameters)
                   throws ConversionException

Converts a Blob given a converter name.

Throws:

ConversionException

convertToMimeType

BlobHolder convertToMimeType(String destinationMimeType,
                             BlobHolder blobHolder,
                             Map<String,Serializable> parameters)
                             throws ConversionException

Converts a Blob given a target destination MimeType.

Throws:

ConversionException

getRegistredConverters

List<String> getRegistredConverters()

Returns the names of the registered converters.

isConverterAvailable

ConverterCheckResult isConverterAvailable(String converterName,
                                          boolean refresh)
                                          throws ConversionException

Checks for converter availability.

Result can be:

• ConverterNotRegistered if converter is not registered.
• Error Message / Installation message if converter dependencies are not available an successful check.

Throws:

ConversionException

isConverterAvailable

ConverterCheckResult isConverterAvailable(String converterName)
                                          throws ConversionException

Checks for converter availability.

Result can be:

• ConverterNotRegistered if converter is not registered.
• Error Message / Installation message if converter dependencies are not available an successful check.

Result can be taken from an internal cache.

Throws:

ConversionException