Image provider definition - 5 UI


Image provider definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.

For the updated implementation, see Preview definition for Magnolia 6 UI instead.

What is an image provider

Image provider is a component that renders images used in apps. It generates the portrait image at the bottom of the action bar and the thumbnails for the thumbnail view.

Image provider

Here is an example image provider definition that uses default classes.

  class: info.magnolia.ui.imageprovider.definition.ConfiguredImageProviderDefinition
  imageProviderClass: info.magnolia.ui.imageprovider.DefaultImageProvider
  originalImageNodeName: jcr:content
Property Description



Image provider definition class that reads the configuration properties and can supply additional parameters to the image provider class. The definition class must implement the ImageProviderDefinition interface. Set the value to a fully-qualified class name.



Actual implementation that generates thumbnail images. The class must implement the ImageProvider interface. You can use DefaultImageProvider, which provides images for objects of MIME type image/* and delegates to the Imaging module to generate and store the images.


optional, default is png

Extension used to deliver the image.


optional, default is /.imaging

Path where the imaging servlet resides.


optional, default is originalImage

Name of the JCR node where the original source image is stored. For example, if a file upload field on a form stores the image in a node named photo set the value to photo.

Here are the default image generator configurations that DefaultImageProvider uses. portrait is displayed at the bottom of the action bar and thumbnail in the thumbnail view.

originalImage node


DX Core



This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules
6.3 beta

Magnolia 6.3 beta

Magnolia 6.3 is in beta. We are updating docs based on development and feedback. Consider the 6.3 docs currently in a state of progress and not final.

We are working on some 6.3-beta known issues during this phase.