Package org.alfresco.repo.content.transform.magick

Class AbstractImageMagickContentTransformerWorker

java.lang.Object

org.alfresco.repo.content.transform.ContentTransformerHelper

org.alfresco.repo.content.transform.magick.AbstractImageMagickContentTransformerWorker

All Implemented Interfaces:

ContentTransformerWorker, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

ImageMagickContentTransformerWorker

public abstract class AbstractImageMagickContentTransformerWorker
extends ContentTransformerHelper
implements ContentTransformerWorker, org.springframework.beans.factory.InitializingBean

Abstract helper for transformations based on ImageMagick

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field	Description
static String	MIMETYPE_IMAGE_PREFIX	the prefix for mimetypes supported by the transformer
protected RemoteTransformerClient	remoteTransformerClient

Fields inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

transformerConfig

Constructor Summary

Constructors

Constructor	Description
AbstractImageMagickContentTransformerWorker()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Checks for the JMagick and ImageMagick dependencies, using the common transformation method to check that the sample image can be converted.
String	getComments(boolean available)	Overridden to supply a comment or String of commented out transformation properties that specify any (hard coded or implied) supported transformations.
boolean	isAvailable()	Checks if this worker is available.
static boolean	isSupported(String mimetype)	Some image formats are not supported by ImageMagick, or at least appear not to work.
boolean	isTransformable(String sourceMimetype, String targetMimetype, TransformationOptions options)	Supports image to image conversion, but only if the JMagick library and required libraries are available.
protected boolean	remoteTransformerClientConfigured()
protected void	setAvailable(boolean available)	Make the transformer available
void	setRemoteTransformerClient(RemoteTransformerClient remoteTransformerClient)	Sets the optional remote transformer client which will be used in preference to a local command if available.
void	transform(ContentReader reader, ContentWriter writer, TransformationOptions options)
protected abstract void	transformInternal(File sourceFile, String sourceMimetype, File targetFile, String targetMimetype, TransformationOptions options)	Transform the image content from the source file to the target file
protected abstract void	transformRemote(ContentReader reader, ContentWriter writer, TransformationOptions options, String sourceMimetype, String targetMimetype, String sourceExtension, String targetExtension)

Methods inherited from class org.alfresco.repo.content.transform.ContentTransformerHelper

deprecatedSetter, equals, getBeanName, getCommentsOnlySupports, getExtensionOrAny, getMimetype, getMimetypeService, getName, getSimpleName, hashCode, isExplicitTransformation, isSupportedTransformation, onlySupports, register, setBeanName, setExplicitTransformations, setMimetypeService, setSupportedTransformations, setTransformerConfig, setUnsupportedTransformations, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.alfresco.repo.content.transform.ContentTransformerWorker

getVersionString

Field Detail

MIMETYPE_IMAGE_PREFIX

public static final String MIMETYPE_IMAGE_PREFIX

the prefix for mimetypes supported by the transformer

See Also:

Constant Field Values

remoteTransformerClient

protected RemoteTransformerClient remoteTransformerClient

Constructor Detail

AbstractImageMagickContentTransformerWorker

public AbstractImageMagickContentTransformerWorker()

Method Detail

isAvailable

public boolean isAvailable()

Description copied from interface: ContentTransformerWorker

Checks if this worker is available.

Specified by:

isAvailable in interface ContentTransformerWorker

Returns:

Returns true if the transformer is functioning otherwise false

setAvailable

protected void setAvailable(boolean available)

Make the transformer available

Parameters:

available - boolean

setRemoteTransformerClient

public void setRemoteTransformerClient(RemoteTransformerClient remoteTransformerClient)

Sets the optional remote transformer client which will be used in preference to a local command if available.

Parameters:

remoteTransformerClient - may be null;

remoteTransformerClientConfigured

protected boolean remoteTransformerClientConfigured()

afterPropertiesSet

public void afterPropertiesSet()

Checks for the JMagick and ImageMagick dependencies, using the common transformation method to check that the sample image can be converted.

If initialization is successful, then autoregistration takes place.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

isSupported

public static boolean isSupported(String mimetype)

Some image formats are not supported by ImageMagick, or at least appear not to work.

Parameters:

mimetype - the mimetype to check

Returns:

Returns true if ImageMagic can handle the given image format

isTransformable

public boolean isTransformable(String sourceMimetype,
                               String targetMimetype,
                               TransformationOptions options)

Supports image to image conversion, but only if the JMagick library and required libraries are available.

Specified by:

isTransformable in interface ContentTransformerWorker

getComments

public String getComments(boolean available)

Description copied from class: ContentTransformerHelper

Overridden to supply a comment or String of commented out transformation properties that specify any (hard coded or implied) supported transformations. Used when providing a list of properties to an administrators who may be setting other transformation properties, via JMX. Consider overriding if {link AbstractContentTransformerLimits.isTransformableMimetype(String, String, TransformationOptions) or ContentTransformerWorker.isTransformable(String, String, TransformationOptions) have been overridden. See ContentTransformerHelper.getCommentsOnlySupports(List, List, boolean) which may be used to help construct a comment.

Specified by:

getComments in interface ContentTransformerWorker

Overrides:

getComments in class ContentTransformerHelper

Parameters:

available - indicates if the transformer has been registered and is available to be selected. false indicates that the transformer is only available as a component of a complex transformer.

Returns:

one line per property. The simple transformer name is returned by default as a comment.

See Also:

ContentTransformer.getComments(boolean)

transform

public final void transform(ContentReader reader,
                            ContentWriter writer,
                            TransformationOptions options)
                     throws Exception

Specified by:

transform in interface ContentTransformerWorker

Throws:

Exception

See Also:

transformInternal(File, String, File, String, TransformationOptions)

transformRemote

protected abstract void transformRemote(ContentReader reader,
                                        ContentWriter writer,
                                        TransformationOptions options,
                                        String sourceMimetype,
                                        String targetMimetype,
                                        String sourceExtension,
                                        String targetExtension)
                                 throws IllegalAccessException

Throws:

IllegalAccessException

transformInternal

protected abstract void transformInternal(File sourceFile,
                                          String sourceMimetype,
                                          File targetFile,
                                          String targetMimetype,
                                          TransformationOptions options)
                                   throws Exception

Transform the image content from the source file to the target file

Parameters:

sourceFile - the source of the transformation

sourceMimetype - the mimetype of the source of the transformation

targetFile - the target of the transformation

targetMimetype - the mimetype of the target of the transformation

options - the transformation options supported by ImageMagick

Throws:

Exception