Package org.nuxeo.ecm.core.convert.service

Class ConversionServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.core.convert.service.ConversionServiceImpl

All Implemented Interfaces:

ConversionService, Adaptable, Component, Extensible, TimestampedService

public class ConversionServiceImpl
extends DefaultComponent
implements ConversionService

Runtime Component that also provides the POJO implementation of the ConversionService.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,ConverterCheckResult>	checkResultCache
static final String	CONFIG_EP
static final String	CONVERTER_EP
protected final Map<String,ConverterDescriptor>	converterDescriptors
static final String	ENFORCE_SOURCE_MIME_TYPE_CHECK
protected ScheduledExecutorService	gcExecutor
protected final MimeTypeTranslationHelper	translationHelper

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
ConversionServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(ComponentContext context)	Activates the component.
protected void	adjustBlobName(String filename, BlobHolder blobHolder, String mimeType)
protected void	adjustBlobName(String filename, Blob blob, String mimeType)
BlobHolder	convert(String converterName, BlobHolder blobHolder, Map<String,Serializable> parameters)	Converts a Blob given a converter name.
protected BlobHolder	convertBlobToMimeType(BlobHolder bh, String destinationMimeType)
protected BlobHolder	convertThroughHTML(BlobHolder blobHolder, String destMimeType)
BlobHolder	convertToMimeType(String destinationMimeType, BlobHolder blobHolder, Map<String,Serializable> parameters)	Converts a Blob given a target destination MimeType.
void	deactivate(ComponentContext context)	Deactivates the component.
void	endGC()
<T> T	getAdapter(Class<T> adapter)	Returns an object which is an instance of the given class associated with this object.
static String	getCacheBasePath()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, use getConvertCacheDirectory() instead
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.
protected ConvertCacheDescriptor	getConvertCacheDescriptor()
static Path	getConvertCacheDirectory()
static Converter	getConverter(String converterName)
static ConverterDescriptor	getConverterDescriptor(String converterName)
String	getConverterName(String sourceMimeType, String destinationMimeType, boolean allowWildcard)	Returns the converter name for the given sourceMimeType and destinationMimeType.
List<String>	getConverterNames(String sourceMimeType, String destinationMimeType, boolean allowWildcard)	Returns the list of converter names handling the given sourceMimeType and destinationMimeType.
static long	getGCIntervalInMinutes()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, not used anymore
static int	getMaxCacheSizeInKB()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, not used anymore
List<String>	getRegistredConverters()	Returns the names of the registered converters.
protected boolean	hasSourceMimeType(ConverterDescriptor converterDescriptor, String mimeType)	Returns true if the converter has the given mimeType as source mime type, false otherwise.
static boolean	isCacheEnabled()	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, not used anymore
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.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)	Component implementation.
static void	registerConverter(ConverterDescriptor desc)
protected static Blob	replaceURLsByAbsolutePaths(Blob blob, Path tempDirectory, Function<String,Blob> blobResolver)	Replace the image URLs of an HTML blob by absolute local paths.
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.
static void	setGCIntervalInMinutes(long interval)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, such setting should be done with contribution
static void	setMaxCacheSizeInKB(int size)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, such setting should be done with contribution
void	start(ComponentContext context)	Start the component.
protected void	startGC(ConvertCacheDescriptor cacheDescriptor)
void	stop(ComponentContext context)	Stop the component.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected void	updateResultBlobFileName(BlobHolder srcBh, BlobHolder resultBh)
protected void	updateResultBlobMimeType(BlobHolder resultBh, ConverterDescriptor desc)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

addRuntimeMessage, addRuntimeMessage, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, unregister, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Methods inherited from interface org.nuxeo.ecm.core.convert.api.ConversionService

getConverterName, getConverterNames

Field Details

CONVERTER_EP

public static final String CONVERTER_EP

See Also:

• Constant Field Values

CONFIG_EP

public static final String CONFIG_EP

See Also:

• Constant Field Values

ENFORCE_SOURCE_MIME_TYPE_CHECK

public static final String ENFORCE_SOURCE_MIME_TYPE_CHECK

Since:

10.3

See Also:

• Constant Field Values

converterDescriptors

protected final Map<String,ConverterDescriptor> converterDescriptors

translationHelper

protected final MimeTypeTranslationHelper translationHelper

gcExecutor

protected ScheduledExecutorService gcExecutor

Since:

2025.0

checkResultCache

protected final Map<String,ConverterCheckResult> checkResultCache

Constructor Details

ConversionServiceImpl

public ConversionServiceImpl()

Method Details

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

registerContribution

public void registerContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Component implementation.

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getConvertCacheDescriptor

protected ConvertCacheDescriptor getConvertCacheDescriptor()

getConverter

public static Converter getConverter(String converterName)

getConverterDescriptor

public static ConverterDescriptor getConverterDescriptor(String converterName)

getGCIntervalInMinutes

@Deprecated(since="2025.0",
            forRemoval=true)
public static long getGCIntervalInMinutes()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.0, not used anymore

setGCIntervalInMinutes

@Deprecated(since="2025.0",
            forRemoval=true)
public static void setGCIntervalInMinutes(long interval)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.0, such setting should be done with contribution

registerConverter

public static void registerConverter(ConverterDescriptor desc)

getMaxCacheSizeInKB

@Deprecated(since="2025.0",
            forRemoval=true)
public static int getMaxCacheSizeInKB()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.0, not used anymore

setMaxCacheSizeInKB

@Deprecated(since="2025.0",
            forRemoval=true)
public static void setMaxCacheSizeInKB(int size)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.0, such setting should be done with contribution

isCacheEnabled

@Deprecated(since="2025.0",
            forRemoval=true)
public static boolean isCacheEnabled()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.0, not used anymore

getCacheBasePath

@Deprecated(since="2025.0",
            forRemoval=true)
public static String getCacheBasePath()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.0, use getConvertCacheDirectory() instead

getConvertCacheDirectory

public static Path getConvertCacheDirectory()

Since:

2025.0

getRegistredConverters

public List<String> getRegistredConverters()

Description copied from interface: ConversionService

Returns the names of the registered converters.

Specified by:

getRegistredConverters in interface ConversionService

convertThroughHTML

protected BlobHolder convertThroughHTML(BlobHolder blobHolder,
 String destMimeType)

convertBlobToMimeType

protected BlobHolder convertBlobToMimeType(BlobHolder bh,
 String destinationMimeType)

adjustBlobName

protected void adjustBlobName(String filename,
 BlobHolder blobHolder,
 String mimeType)

adjustBlobName

protected void adjustBlobName(String filename,
 Blob blob,
 String mimeType)

replaceURLsByAbsolutePaths

protected static Blob replaceURLsByAbsolutePaths(Blob blob,
 Path tempDirectory,
 Function<String,Blob> blobResolver)
                                          throws IOException

Replace the image URLs of an HTML blob by absolute local paths.

Throws:

IOException

Since:

9.1

convert

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

Description copied from interface: ConversionService

Converts a Blob given a converter name.

Specified by:

convert in interface ConversionService

Throws:

ConversionException

hasSourceMimeType

protected boolean hasSourceMimeType(ConverterDescriptor converterDescriptor,
 String mimeType)

Returns true if the converter has the given mimeType as source mime type, false otherwise.

Since:

10.3

updateResultBlobMimeType

protected void updateResultBlobMimeType(BlobHolder resultBh,
 ConverterDescriptor desc)

updateResultBlobFileName

protected void updateResultBlobFileName(BlobHolder srcBh,
 BlobHolder resultBh)

convertToMimeType

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

Description copied from interface: ConversionService

Converts a Blob given a target destination MimeType.

Specified by:

convertToMimeType in interface ConversionService

Throws:

ConversionException

getConverterNames

public List<String> getConverterNames(String sourceMimeType,
 String destinationMimeType,
 boolean allowWildcard)

Description copied from interface: ConversionService

Returns the list of converter names handling the given sourceMimeType and destinationMimeType.

Finds the converter names based on the following algorithm:

• Find the converters exactly matching the given sourceMimeType
• If no converter found, find the converters matching a wildcard subtype based on the sourceMimeType, such has "image/*"
• If no converter found and allowWildcard is true, find the converters matching a wildcard source mime type "*"
• Then, filter only the converters matching the given destinationMimeType

Specified by:

getConverterNames in interface ConversionService

Parameters:

allowWildcard - true to allow returning converters with '*' as source mime type.

getConverterName

public String getConverterName(String sourceMimeType,
 String destinationMimeType,
 boolean allowWildcard)

Description copied from interface: ConversionService

Returns the converter name for the given sourceMimeType and destinationMimeType.

Follows the algorithm of ConversionService.getConverterNames(String, String, boolean).

Specified by:

getConverterName in interface ConversionService

See Also:

• ConversionService.getConverterNames(String, String, boolean)

isConverterAvailable

public ConverterCheckResult isConverterAvailable(String converterName)
                                          throws ConversionException

Description copied from interface: ConversionService

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.

Specified by:

isConverterAvailable in interface ConversionService

Throws:

ConversionException

isConverterAvailable

public ConverterCheckResult isConverterAvailable(String converterName,
 boolean refresh)
                                          throws ConverterNotRegistered

Description copied from interface: ConversionService

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.

Specified by:

isConverterAvailable in interface ConversionService

Throws:

ConverterNotRegistered

isSourceMimeTypeSupported

public boolean isSourceMimeTypeSupported(String converterName,
 String sourceMimeType)

Description copied from interface: ConversionService

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

Specified by:

isSourceMimeTypeSupported in interface ConversionService

scheduleConversion

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

Description copied from interface: ConversionService

Schedules a conversion given a converter name.

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

Specified by:

scheduleConversion in interface ConversionService

scheduleConversionToMimeType

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

Description copied from interface: ConversionService

Schedules a conversion given a target mime type.

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

Specified by:

scheduleConversionToMimeType in interface ConversionService

getConversionStatus

public ConversionStatus getConversionStatus(String id)

Description copied from interface: ConversionService

Returns the status of a scheduled conversion given its id, or null if no conversion scheduled.

Specified by:

getConversionStatus in interface ConversionService

getConversionResult

public BlobHolder getConversionResult(String id,
 boolean cleanTransientStoreEntry)

Description copied from interface: ConversionService

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

Specified by:

getConversionResult in interface ConversionService

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

startGC

protected void startGC(ConvertCacheDescriptor cacheDescriptor)

endGC

public void endGC()