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.

Author:

tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_EP
static String	CONVERTER_EP

Constructor Summary

Constructors

Constructor and Description
ConversionServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	applicationStarted(ComponentContext context) Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.
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.
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()
static Converter	getConverter(String converterName)
static ConverterDescriptor	getConverterDescriptor(String converterName)
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.
static long	getGCIntervalInMinutes()
static int	getMaxCacheSizeInKB()
List<String>	getRegistredConverters() Returns the names of the registered converters.
static boolean	isCacheEnabled()
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)
static void	setGCIntervalInMinutes(long interval)
static void	setMaxCacheSizeInKB(int size)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

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

getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

ConversionServiceImpl

public ConversionServiceImpl()

Method Detail

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

getConverter

public static Converter getConverter(String converterName)

getConverterDescriptor

public static ConverterDescriptor getConverterDescriptor(String converterName)

getGCIntervalInMinutes

public static long getGCIntervalInMinutes()

setGCIntervalInMinutes

public static void setGCIntervalInMinutes(long interval)

registerConverter

public static void registerConverter(ConverterDescriptor desc)

getMaxCacheSizeInKB

public static int getMaxCacheSizeInKB()

setMaxCacheSizeInKB

public static void setMaxCacheSizeInKB(int size)

isCacheEnabled

public static boolean isCacheEnabled()

getCacheBasePath

public static String getCacheBasePath()

getRegistredConverters

public List<String> getRegistredConverters()

Description copied from interface: ConversionService

Returns the names of the registered converters.

Specified by:

getRegistredConverters in interface ConversionService

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

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)

Description copied from interface: ConversionService

Gets the available convertNames given a source and destination MimeType.

Specified by:

getConverterNames in interface ConversionService

getConverterName

public String getConverterName(String sourceMimeType,
                      String destinationMimeType)

Description copied from interface: ConversionService

Gets the convertName given a source and destination MimeType.

Specified by:

getConverterName in interface ConversionService

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

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

applicationStarted

public void applicationStarted(ComponentContext context)

Description copied from interface: Component

Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.

Specified by:

applicationStarted in interface Component

Overrides:

applicationStarted in class DefaultComponent

endGC

public void endGC()