public interface ConversionService
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.
|
String getConverterName(String sourceMimeType, String destinationMimeType)
List<String> getConverterNames(String sourceMimeType, String destinationMimeType)
BlobHolder convert(String converterName, BlobHolder blobHolder, Map<String,Serializable> parameters) throws ConversionException
ConversionException
BlobHolder convertToMimeType(String destinationMimeType, BlobHolder blobHolder, Map<String,Serializable> parameters) throws ConversionException
ConversionException
@Deprecated Blob convertBlobToPDF(Blob blob) throws IOException
convertToMimeType(String, BlobHolder, Map)
with the PDF mimetype as
destination insteadIOException
List<String> getRegistredConverters()
ConverterCheckResult isConverterAvailable(String converterName, boolean refresh) throws ConverterNotRegistered
Result can be:
ConverterNotRegistered
if converter is not registered.
ConverterNotRegistered
ConverterCheckResult isConverterAvailable(String converterName) throws ConversionException
Result can be:
ConverterNotRegistered
if converter is not registered.
Result can be taken from an internal cache.
ConversionException
boolean isSourceMimeTypeSupported(String converterName, String sourceMimeType)
sourceMimeType
, false otherwise.String scheduleConversion(String converterName, BlobHolder blobHolder, Map<String,Serializable> parameters)
Returns a conversion id to be used by getConversionResult(String, boolean)
.
String scheduleConversionToMimeType(String destinationMimeType, BlobHolder blobHolder, Map<String,Serializable> parameters)
Returns a conversion id to be used by getConversionResult(String, boolean)
.
ConversionStatus getConversionStatus(String id)
id
, or null
if no conversion scheduled.BlobHolder getConversionResult(String id, boolean cleanTransientStoreEntry)
id
if any, null
otherwise.Copyright © 2017 Nuxeo. All rights reserved.