ConversionService (Nuxeo ECM Projects 10.10 API)

All Known Subinterfaces:

ConversionServiceManager

All Known Implementing Classes:

ConversionServiceImpl
```
public interface ConversionService
```
Interface for the Conversion Service.

Author:

tiry

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`BlobHolder`	`convert(String converterName, BlobHolder blobHolder, Map<String,Serializable> parameters)` Converts a Blob given a converter name.
`Blob`	`convertBlobToPDF(Blob blob)` Deprecated. since 9.2, use `convertToMimeType(String, BlobHolder, Map)` with the PDF mimetype as destination instead
`BlobHolder`	`convertToMimeType(String destinationMimeType, BlobHolder blobHolder, Map<String,Serializable> parameters)` Converts a Blob given a target destination MimeType.
`BlobHolder`	`getConversionResult(String id, boolean cleanTransientStoreEntry)` Returns the conversion result for the given `id` if any, `null` otherwise.
`ConversionStatus`	`getConversionStatus(String id)` Returns the status of a scheduled conversion given its `id`, or `null` if no conversion scheduled.
`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.
`boolean`	`isSourceMimeTypeSupported(String converterName, String sourceMimeType)` Returns true if the converter supports the given `sourceMimeType`, false otherwise.
`String`	`scheduleConversion(String converterName, BlobHolder blobHolder, Map<String,Serializable> parameters)` Schedules a conversion given a converter name.
`String`	`scheduleConversionToMimeType(String destinationMimeType, BlobHolder blobHolder, Map<String,Serializable> parameters)` Schedules a conversion given a target mime type.

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

convertBlobToPDF
```
@Deprecated
Blob convertBlobToPDF(Blob blob)
                           throws IOException
```
Deprecated. since 9.2, use convertToMimeType(String, BlobHolder, Map) with the PDF mimetype as destination instead

Converts a Blob to PDF. If the blob has inner blobs such as images, they will be correctly rendered in the PDF.

Throws:

IOException

Since:

9.1

getRegistredConverters
```
List<String> getRegistredConverters()
```
Returns the names of the registered converters.

isConverterAvailable
```
ConverterCheckResult isConverterAvailable(String converterName,
                                          boolean refresh)
                                   throws ConverterNotRegistered
```
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:

ConverterNotRegistered

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

isSourceMimeTypeSupported

boolean isSourceMimeTypeSupported(String converterName,
                                  String sourceMimeType)

Returns true if the converter supports the given sourceMimeType, false otherwise.

Since:: 5.8

scheduleConversion

String scheduleConversion(String converterName,
                          BlobHolder blobHolder,
                          Map<String,Serializable> parameters)

Schedules a conversion given a converter name.

Returns a conversion id to be used by getConversionResult(String, boolean).

Since:: 7.4

scheduleConversionToMimeType

String scheduleConversionToMimeType(String destinationMimeType,
                                    BlobHolder blobHolder,
                                    Map<String,Serializable> parameters)

Schedules a conversion given a target mime type.

Returns a conversion id to be used by getConversionResult(String, boolean).

Since:: 7.10

getConversionStatus
```
ConversionStatus getConversionStatus(String id)
```
Returns the status of a scheduled conversion given its id, or null if no conversion scheduled.

Since:

7.4

getConversionResult

BlobHolder getConversionResult(String id,
                               boolean cleanTransientStoreEntry)

Returns the conversion result for the given id if any, null otherwise.

Since:: 7.4

Interface ConversionService