org.alfresco.repo.content.transform.magick

Class ImageMagickContentTransformerWorker

java.lang.Object

org.alfresco.repo.content.transform.ContentTransformerHelper

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

org.alfresco.repo.content.transform.magick.ImageMagickContentTransformerWorker

All Implemented Interfaces:

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

public class ImageMagickContentTransformerWorker
extends AbstractImageMagickContentTransformerWorker

Executes a statement to implement

Author:

Derek Hulley

Field Summary

Fields inherited from class org.alfresco.repo.content.transform.magick.AbstractImageMagickContentTransformerWorker

MIMETYPE_IMAGE_PREFIX, remoteTransformerClient

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

transformerConfig

Constructor Summary

Constructors

Constructor and Description
ImageMagickContentTransformerWorker() Default constructor

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Checks for the JMagick and ImageMagick dependencies, using the common transformation method to check that the sample image can be converted.
protected String	getImageMagickVersionNumber()
String	getVersionString() Gets the version string captured from the check command.
protected boolean	isAlphaOptionSupported()
void	setCheckCommand(org.alfresco.util.exec.RuntimeExec checkCommand) Sets the command that must be executed in order to retrieve version information from the converting executable and thus test that the executable itself is present.
void	setExecuter(org.alfresco.util.exec.RuntimeExec executer) Set the runtime command executer that must be executed in order to run ImageMagick.
protected 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 void	transformRemote(org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.ContentWriter writer, TransformationOptions options, String sourceMimetype, String targetMimetype, String sourceExtension, String targetExtension)

Methods inherited from class org.alfresco.repo.content.transform.magick.AbstractImageMagickContentTransformerWorker

getComments, isAvailable, isSupported, isTransformable, remoteTransformerClientConfigured, setAvailable, setRemoteTransformerClient, transform

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

Constructor Detail

ImageMagickContentTransformerWorker

public ImageMagickContentTransformerWorker()

Default constructor

Method Detail

setExecuter

public void setExecuter(org.alfresco.util.exec.RuntimeExec executer)

Set the runtime command executer that must be executed in order to run ImageMagick. Whether or not this is the full path to the convertCommand or just the convertCommand itself depends the environment setup.

The command must contain the variables ${source} and ${target}, which will be replaced by the names of the file to be transformed and the name of the output file respectively.

    convert ${source} ${target}
 

Parameters:

executer - the system command executer

setCheckCommand

public void setCheckCommand(org.alfresco.util.exec.RuntimeExec checkCommand)

Sets the command that must be executed in order to retrieve version information from the converting executable and thus test that the executable itself is present.

Parameters:

checkCommand - command executer to retrieve version information

getVersionString

public String getVersionString()

Gets the version string captured from the check command.

Returns:

the version string

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.

Specified by:

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

Overrides:

afterPropertiesSet in class AbstractImageMagickContentTransformerWorker

transformInternal

protected 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

Specified by:

transformInternal in class AbstractImageMagickContentTransformerWorker

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

transformRemote

protected void transformRemote(org.alfresco.service.cmr.repository.ContentReader reader,
                               org.alfresco.service.cmr.repository.ContentWriter writer,
                               TransformationOptions options,
                               String sourceMimetype,
                               String targetMimetype,
                               String sourceExtension,
                               String targetExtension)
                        throws IllegalAccessException

Specified by:

transformRemote in class AbstractImageMagickContentTransformerWorker

Throws:

IllegalAccessException

getImageMagickVersionNumber

protected String getImageMagickVersionNumber()

isAlphaOptionSupported

protected boolean isAlphaOptionSupported()