Package org.alfresco.repo.rendition2

Interface SynchronousTransformClient<T>

All Known Implementing Classes:

LegacySynchronousTransformClient, LocalSynchronousTransformClient, SwitchingSynchronousTransformClient

@Deprecated
public interface SynchronousTransformClient<T>

Deprecated.

Request synchronous transforms. Used in refactoring deprecated code, which called Legacy transforms, so that it will first try a Local transform, falling back to Legacy if not available.

Author:

adavis

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	IS_SUPPORTED_NOT_CALLED	Deprecated.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	convertOptions(TransformationOptions options)	Deprecated.
T	getSupportedBy()	Deprecated.
boolean	isSupported(java.lang.String sourceMimetype, long sourceSizeInBytes, java.lang.String contentUrl, java.lang.String targetMimetype, java.util.Map<java.lang.String,java.lang.String> actualOptions, java.lang.String transformName, org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)	Deprecated.
default boolean	isSupported(org.alfresco.service.cmr.repository.ContentReader contentReader, org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, java.lang.String targetMimetype, java.util.Map<java.lang.String,java.lang.String> actualOptions, java.lang.String transformName)	Deprecated.
default boolean	isSupported(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, java.lang.String targetMimetype, java.util.Map<java.lang.String,java.lang.String> actualOptions, java.lang.String transformName)	Deprecated.
void	setSupportedBy(T t)	Deprecated.
void	transform(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, java.util.Map<java.lang.String,java.lang.String> actualOptions, java.lang.String transformName, org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)	Deprecated.

Field Detail

IS_SUPPORTED_NOT_CALLED

static final java.lang.String IS_SUPPORTED_NOT_CALLED

Deprecated.

See Also:

Constant Field Values

Method Detail

isSupported

@Deprecated
boolean isSupported(java.lang.String sourceMimetype,
                    long sourceSizeInBytes,
                    java.lang.String contentUrl,
                    java.lang.String targetMimetype,
                    java.util.Map<java.lang.String,java.lang.String> actualOptions,
                    java.lang.String transformName,
                    org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)

Deprecated.

Works out if it is possible to transform content of a given source mimetype and size into a target mimetype given a list of actual transform option names and values.

Parameters:

sourceMimetype - the mimetype of the source content

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

contentUrl - The url of the content. Optional as it is only used in debug messages.

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.

sourceNodeRef - the NodeRef of the source content. Optional as it is only used in debug messages.

Returns:

true if it is supported.

isSupported

@Deprecated
default boolean isSupported(org.alfresco.service.cmr.repository.ContentReader contentReader,
                            org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                            java.lang.String targetMimetype,
                            java.util.Map<java.lang.String,java.lang.String> actualOptions,
                            java.lang.String transformName)

Deprecated.

Overrides and calls isSupported(String, long, String, String, Map, String, NodeRef) to work out if a transform is supported. Uses the contentReader to work out the sourceMimetype, sourceSizeInBytes and contentUrl.

Parameters:

contentReader - to access the sourceNodeRef content property.

sourceNodeRef - the NodeRef 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:

true if it is supported.

isSupported

@Deprecated
default boolean isSupported(org.alfresco.service.cmr.repository.NodeService nodeService,
                            org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                            java.lang.String targetMimetype,
                            java.util.Map<java.lang.String,java.lang.String> actualOptions,
                            java.lang.String transformName)

Deprecated.

Overrides and calls isSupported(String, long, String, String, Map, String, NodeRef) to work out if a transform is supported. Uses the nodeService to read the content of the sourceNodeRef to work out the sourceMimetype, sourceSizeInBytes and contentUrl.

Parameters:

nodeService - to access the sourceNodeRef's content property.

sourceNodeRef - the NodeRef 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:

true if it is supported.

transform

@Deprecated
void transform(org.alfresco.service.cmr.repository.ContentReader reader,
               org.alfresco.service.cmr.repository.ContentWriter writer,
               java.util.Map<java.lang.String,java.lang.String> actualOptions,
               java.lang.String transformName,
               org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
        throws UnsupportedTransformationException,
               org.alfresco.service.cmr.repository.ContentIOException

Deprecated.

Requests a synchronous transform. Not used for renditions. The call to this method should be proceeded by a successful call to isSupported(String, long, String, String, Map, String, NodeRef) ideally in the SAME Thread. If this is not possible, the thread that has called isSupported, should then call getSupportedBy(). The returned value then needs to used as a parameter to setSupportedBy(Object) by the thread that is about to call transform.

Parameters:

reader - of the source content

writer - to the target node's content

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.

sourceNodeRef - the source node

Throws:

UnsupportedTransformationException - if there is an unexpected failure to transform, normally in a pipeline, where an intermediate transform may not be performed after all because an intermediate converion is too big.

org.alfresco.service.cmr.repository.ContentIOException - there is an unexpected communication or transformation failure.

getSupportedBy

@Deprecated
T getSupportedBy()

Deprecated.

Only needed if isSupported and transform are called in different Threads. See the description in transform(ContentReader, ContentWriter, Map, String, NodeRef).

setSupportedBy

@Deprecated
void setSupportedBy(T t)

Deprecated.

Only needed if isSupported and transform are called in different Threads. See the description in transform(ContentReader, ContentWriter, Map, String, NodeRef).

convertOptions

@Deprecated
java.util.Map<java.lang.String,java.lang.String> convertOptions(TransformationOptions options)

Deprecated.