org.alfresco.transform.client.model.config

Interface TransformServiceRegistry

All Known Implementing Classes:

AbstractTransformServiceRegistry, LegacyLocalTransformServiceRegistry, SwitchingTransformServiceRegistry, TransformServiceRegistryImpl

public interface TransformServiceRegistry

Used by clients work out if a transformation is supported by a Transform Service.

Method Summary

Modifier and Type	Method and Description
long	getMaxSize(String sourceMimetype, String targetMimetype, Map<String,String> actualOptions, String transformName) Returns the maximun size (in bytes) of the source content that can be transformed.
boolean	isSupported(String sourceMimetype, long sourceSizeInBytes, String targetMimetype, Map<String,String> actualOptions, String transformName) Works out if the Transform Server should be able to transform content of a given source mimetype and size into a target mimetype given a list of actual transform option names and values (Strings) plus the data contained in the objects registered with this class.

Method Detail

isSupported

boolean isSupported(String sourceMimetype,
                    long sourceSizeInBytes,
                    String targetMimetype,
                    Map<String,String> actualOptions,
                    String transformName)

Works out if the Transform Server should be able to transform content of a given source mimetype and size into a target mimetype given a list of actual transform option names and values (Strings) plus the data contained in the objects registered with this class.

Parameters:

sourceMimetype - the mimetype of the source content

sourceSizeInBytes - the size in bytes of the source content. Ignored if negative.

targetMimetype - the mimetype of the target

actualOptions - the actual name value pairs available that could be passed to the Transform Service.

transformName - (optional) name for the set of options and target mimetype. If supplied is used to cache results to avoid having to work out if a given transformation is supported a second time. The sourceMimetype and sourceSizeInBytes may still change. In the case of ACS this is the rendition name.

getMaxSize

long getMaxSize(String sourceMimetype,
                String targetMimetype,
                Map<String,String> actualOptions,
                String transformName)

Returns the maximun size (in bytes) of the source content that can be transformed.

Parameters:

sourceMimetype - the mimetype of the source content

targetMimetype - the mimetype of the target

actualOptions - the actual name value pairs available that could be passed to the Transform Service.

transformName - (optional) name for the set of options and target mimetype. If supplied is used to cache results to avoid having to work out if a given transformation is supported a second time. The sourceMimetype and sourceSizeInBytes may still change. In the case of ACS this is the rendition name.

Returns:

the maximum size (in bytes) of the source content that can be transformed. If -1 there is no limit, but if 0 the transform is not supported.