de.hybris.platform.mediaconversion.imagemagick

Class BasicImageMagickStrategy

java.lang.Object

de.hybris.platform.mediaconversion.imagemagick.BasicImageMagickStrategy

Direct Known Subclasses:

DefaultImageMagickService, ImageMagickMediaConversionStrategy

public class BasicImageMagickStrategy
extends Object

Class to share common functionality to Services and Strategies using ImageMagick.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMBEDDED_CONFIG_DIR Deprecated.
static String	IMAGEMAGICK_CONFIGURATION_DIRECTORY Configuration key where the ImageMagick configuration directory is located.

Method Summary

Modifier and Type	Method and Description
File	getConfigurationDirectory() Accesses the ImageMagick configuration directory.
ConfigurationService	getConfigurationService()
File	getTmpDir() Accesses the temporary directory to use.
void	setConfigurationDirectory(File configurationDirectory) Sets the image magick configuration directory to use.
void	setConfigurationService(ConfigurationService configurationService)
void	setTmpDir(File tmpDir) Sets the temporary directory to use.

Methods inherited from class java.lang.Object

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

Field Detail

IMAGEMAGICK_CONFIGURATION_DIRECTORY

public static final String IMAGEMAGICK_CONFIGURATION_DIRECTORY

Configuration key where the ImageMagick configuration directory is located.

See Also:

Customize ImageMagick With Resources, Constant Field Values

EMBEDDED_CONFIG_DIR

@Deprecated
public static final String EMBEDDED_CONFIG_DIR

Deprecated.

The embedded imagemagick configuration directory as shipped with this extension. This value will be used as default.

See Also:

setConfigurationDirectory(File), Constant Field Values

Method Detail

getTmpDir

public File getTmpDir()

Accesses the temporary directory to use. The returned directory will be the ${HYBRIS_TEMP_DIR}/convert if not configured differently (through spring setup). The directory will be created if it does not exist.

Returns:

the temporary directory to use.

setTmpDir

public void setTmpDir(File tmpDir)

Sets the temporary directory to use.

Parameters:

tmpDir - the temporary directory.

See Also:

getTmpDir()

getConfigurationDirectory

public File getConfigurationDirectory()
                               throws IOException

Accesses the ImageMagick configuration directory. If not configured otherwise the embedded ImageMagick configuration directory will be used.

Returns:

the image magick configuration directory

Throws:

IOException

See Also:

EMBEDDED_CONFIG_DIR, Customize ImageMagick With Resources

setConfigurationDirectory

public void setConfigurationDirectory(File configurationDirectory)

Sets the image magick configuration directory to use.

Parameters:

configurationDirectory - the configuration directory to use.

getConfigurationService

public ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)