de.hybris.platform.mediaconversion.imagemagick

Class DefaultImageMagickService

java.lang.Object

de.hybris.platform.mediaconversion.imagemagick.BasicImageMagickStrategy

de.hybris.platform.mediaconversion.imagemagick.DefaultImageMagickService

All Implemented Interfaces:

ImageMagickService

public class DefaultImageMagickService
extends BasicImageMagickStrategy
implements ImageMagickService

Default implementation of a ImageMagickService backed by ImageMagick .

Both ImageMagick executable (convert and identify in use will be executed by the auto injected ProcessExecutor.

The behavior of this service can be influenced by the following properties: *

Property	Meaning	Default
imagemagick.bindir	The binary directory of your local image magick installation.
imagemagick.executable.convert	The convert executable to call.	convert
imagemagick.executable.identify	The identify executable to call.	identify
imagemagick.configuration.directory	Path to the Configuration directory to use.	Lookup sequence is as follows: If the configuration directory was set through spring injection, it will be used (the property value is disobeyed) If the property is set, this path will be used. If the JVM MAGICK_CONFIGURE_PATH environment variable is set, it will be used. The embedded configuration directory (see BasicImageMagickStrategy.EMBEDDED_CONFIG_DIR) will be used. Changes to this property are not reflected on runtime.

Note: all environment variables relevant to ImageMagick will be forwarded to the executed process when set in the JVM environment.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONVERT_EXEC Executable name to be used with the IMAGEMAGICK_EXECUTABLE_KEY_PREFIX conf key prefix.
static String	EMBEDDED_BIN_DIR Deprecated.
static String	IDENTIFY_EXEC Executable name to be used with the IMAGEMAGICK_EXECUTABLE_KEY_PREFIX conf key prefix.
static String	IMAGEMAGICK_DIR Property key for the binary directory to use (overrides build in mechanism).
static String	IMAGEMAGICK_EXECUTABLE_KEY_PREFIX Configuration key prefix for the executable name to use.

Fields inherited from class de.hybris.platform.mediaconversion.imagemagick.BasicImageMagickStrategy

EMBEDDED_CONFIG_DIR, IMAGEMAGICK_CONFIGURATION_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
DefaultImageMagickService()

Method Summary

Modifier and Type	Method and Description
protected String[]	buildEnvironment(File executable) Assembling image magick environment.
void	convert(List<String> commandOpts) Executes a conversion with the specified list of options.
OsConfigurationService	getOsConfigurationService()
ProcessExecutor	getProcessExecutor()
String	identify(List<String> commandOptions) Executes image identification with the specified options.
void	setOsConfigurationService(OsConfigurationService osDirectoryService)
void	setProcessExecutor(ProcessExecutor processExecutor)

Methods inherited from class de.hybris.platform.mediaconversion.imagemagick.BasicImageMagickStrategy

getConfigurationDirectory, getConfigurationService, getTmpDir, setConfigurationDirectory, setConfigurationService, setTmpDir

Methods inherited from class java.lang.Object

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

Field Detail

EMBEDDED_BIN_DIR

@Deprecated
public static final String EMBEDDED_BIN_DIR

Deprecated.

Default root of the binary directory (embedded and shipped with this extension). Note that below this directory there is a os.name/os.arch structure for various platforms.

See Also:

Constant Field Values

IMAGEMAGICK_DIR

public static final String IMAGEMAGICK_DIR

Property key for the binary directory to use (overrides build in mechanism).

See Also:

Constant Field Values

IMAGEMAGICK_EXECUTABLE_KEY_PREFIX

public static final String IMAGEMAGICK_EXECUTABLE_KEY_PREFIX

Configuration key prefix for the executable name to use. Currently it is in use with two ImageMagick executable which are mapped/configuredf to the equal string:

• imagemagick.executable.convert -> convert
• imagemagick.executable.identify -> identify

See Also:

CONVERT_EXEC, IDENTIFY_EXEC, Constant Field Values

CONVERT_EXEC

public static final String CONVERT_EXEC

Executable name to be used with the IMAGEMAGICK_EXECUTABLE_KEY_PREFIX conf key prefix. This property key is used to have an indirection if a different executable should be used.

See Also:

Constant Field Values

IDENTIFY_EXEC

public static final String IDENTIFY_EXEC

Executable name to be used with the IMAGEMAGICK_EXECUTABLE_KEY_PREFIX conf key prefix. This property key is used to have an indirection if a different executable should be used.

See Also:

Constant Field Values

Constructor Detail

DefaultImageMagickService

public DefaultImageMagickService()

Method Detail

buildEnvironment

protected String[] buildEnvironment(File executable)
                             throws IOException

Assembling image magick environment.

Parameters:

executable - the executable to use

Returns:

environment setting as array of 'key=value' strings

Throws:

IOException

See Also:

Customize ImageMagick With Resources

convert

public void convert(List<String> commandOpts)
             throws IOException

Description copied from interface: ImageMagickService

Executes a conversion with the specified list of options. The options available are numerous and listed on the ImageMagick command line options page.

Specified by:

convert in interface ImageMagickService

Parameters:

commandOpts - the bold command line options (including input and output files if applicable).

Throws:

IOException - on any error

identify

public String identify(List<String> commandOptions)
                throws IOException

Description copied from interface: ImageMagickService

Executes image identification with the specified options. Please see ImageMagick Identify Command-line Tool for usage and option descriptions.

Specified by:

identify in interface ImageMagickService

Parameters:

commandOptions - bold command line options to the identify command (including the input file).

Returns:

the commands (std) output.

Throws:

IOException - on any error.

getProcessExecutor

public ProcessExecutor getProcessExecutor()

setProcessExecutor

public void setProcessExecutor(ProcessExecutor processExecutor)

getOsConfigurationService

public OsConfigurationService getOsConfigurationService()

setOsConfigurationService

public void setOsConfigurationService(OsConfigurationService osDirectoryService)