This documentation is still in progress. We are working hard to update all our screenshots to the new Magnolia 6 style. Please bear with us.
The Imaging module simplifies working with images. You don't need to resize and crop each image by hand as the imaging engine generate variations on-the-fly. Administrators create the rules that determine the sizes of derivatives. Editors save time as they can select an image from the DAM or upload one, and it will be automatically adapted to match the rule.
Please note that the artifact's IDs (Maven
artifactId) have changed since Magnolia 5.5.
If you have custom Java code relying on this module, you need to install a compatibility module too.
To be sure - please check the module on our Bitbucket server.
Maven is the easiest way to install the module. Add the following to your bundle:
Note the changes in
artifactId since the 3.4 release.
<dependency> <groupId>info.magnolia.imaging</groupId> <artifactId>magnolia-imaging</artifactId> <version>3.4.2</version> </dependency>
Pre-built jars are also available for download. See Installing a module for help.
With Magnolia 5.6 we've begun removing the old Content API from our modules. If you have custom code relying on classes from the old imaging module then you must do one of two things:
- Update your code for the new version of the imaging module.
- Or you can use the
magnolia-imaging-compatibilitymodule together with the
Add the following snippet to you pom file:
<dependency> <groupId>info.magnolia.imaging</groupId> <artifactId>magnolia-imaging-compatibility</artifactId> <version>3.4.2</version> </dependency>
Add these jar files to the
WEB-INF/lib folder of your webapp:
Image request processing
The diagram shows the elements of the Imaging module and how they interrelate (credit: Richard Unger).
- ImagingServlet is responsible for the actual generation of the images.
- ImageGenerator interface is the entry point for generating images .
- ImageOperationChain implements
ImageGeneratorand executes an operation chain .
- Various implementations of ParameterProviderFactory interface are responsible for instantiating parameter providers for a given environment.
- Implementations of ImageStreamer interface are responsible for pushing the generated image, with the given generator and parameters, to an output stream.
ImageGenerator is a component that generates variants from a source image based on configuration. Generators are used by image provider classes to render images in the UI and on pages.
Generators are configured in
Example: Generator configurations:
The name of the image generator.
The image generator class:
Output format configuration.
Parameter provider factory class.
required *for image operation chains
Image operations configuration.
The output format is the format or file type the generator produces, such as JPEG or PNG. Supported formats are
wbmp. The module also supports these formats and
tiff as input formats . You can verify the available formats on your system by installing the magnolia-module-imagingtools.jar The Image I/O plugins app displays a list of supported file extensions.
The output format is configured in
Examples: Output format configurations.
Output format configuration. Defines the format the generator produces, such as
Image quality as a percentage.
The file extension of the generated images.
ThemeAwareImageGenerator generates images in the same format as the source image. If you upload a
jpg, this generator will produce a
Parameter provider factory
Parameters are instructions passed to an operation, such as where to load a source image or what text to lay over it. Registering a ParameterProviderFactory allows you to pass parameters from different sources:
The parameter provider factory is configured in
Parameter provider classes:
|Theme -aware |
|Superclass for parameter provider factories based on workspace and path.|
|Extracts workspace and identifier from the path. Everything after the identifier is ignored. This allows you, for example, to pass a properly named file name, to the image.|
|Extracts workspace and UUID from the path. Everything after the UUID is ignored. This allows you, for example to pass a properly named file name to the image.|
Image operation chains
The Imaging module can resize and crop images, overlay text and apply image filters. These are called image operations and are configured in
/modules/imaging/config/generators/<generator name>/operations. Image operations can also be configured in a theme.
An image operation chain consists of one or more operations. A simple chain could add only fixed text, while a more complex chain could load an image from a remote source, apply filters, add multiple text fields and style them differently.
Example: Image operation chain configuration:
Name of the image generator.
One node for each operation in the chain, for example
Other properties supported by the operation class.
The first operation in an operation chain is typically a load operation. Use load class FromBinaryNode to load an image from the DAM.
ParameterProviderFactory and load operation class typing
Note that ParameterProviderFactory and ParameterProvider implementations are typed. Let's have a look at the interfaces: Return type of
ParameterProviderFactory#newParameterProviderFor and the method argument in the class used for a load operation must have the same type!
For instance BinaryNodePathParameterProviderFactory (as ParameterProviderFactory) and FromBinaryNode work nicely together.
Creating a custom generator
You can create a custom image generator If the defaults do not meet your requirements:
- Set the value of the
classnode in configuration to your class' name.
The imaging engine stores generated images in the
The path where generated images are stored depends on the CachingStrategy. The default path is:
For the MTE generator, the path is:
When the image is rendered on a page, the URL to the generated image is:
Viewing generated images
The syntax for the URL to request a generated image depends on the used ParameterProviderFactory. However, it usually has the following pattern:
Here is an example of a path when using BinaryNodePathParameterProviderFactory:
Magnolia caches image resources to improve performance. Any dynamic images generated by the Imaging module are cached at two levels: in the
imaging workspace and in the actual cache like any other page or document. This means that once the system generates an image, you keep getting the same cached image on subsequent requests.
During testing, you can disable caching of generated images completely. In
/modules/imaging/config , create a new property
storeGeneratedImages, and set the value to
There is still a small delay between configuration changes and a new image being available. Magnolia's observation mechanism intentionally waits couple of seconds before reading a changed configuration.
Imaging support is enabled by 3 Magnolia modules:
|The support interface for imaging.|
|Asset renderer that uses |
|ImagingSupport that delegates to a Theme.|
Image variations in a theme
A variation is an theme-specific configuration that defines the size of the target image and tells the imaging engine whether cropping is allowed. Variations are configured in a theme which allows you to configure image look and feel in the same place as CSS.
Configuring an image operation in a variation
- Unger, Richard (2012) "Enterprise extensions to Magnolia's Imaging module"