The 5.7 branch of Magnolia reached End-of-Life on December 31, 2023, as specified in our End-of-life policy. This means the 5.7 branch is no longer maintained or supported. Please upgrade to the latest Magnolia release. By upgrading, you will get the latest release of Magnolia featuring significant improvements to the author and developer experience. For a successful upgrade, please consult our Magnolia 6.2 documentation. If you need help, please contact info@magnolia-cms.com.

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. 

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

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

Node name

Value

 
imageProvider


 
class

info.magnolia.ui.imageprovider.definition.ConfiguredImageProviderDefinition

 
imageProviderClass

info.magnolia.ui.imageprovider.DefaultImageProvider

 
originalImageNodeName

jcr:content

Properties:

class

required

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 

$webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources") ImageProviderDefinition
 interface. Set the value to a fully-qualified class name.

imageProviderClass

required

Actual implementation that generates thumbnail images. The class must implement the 

$webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources") ImageProvider
 interface. You can use 
$webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources") DefaultImageProvider
 which provides images for objects of MIME type image/* and delegates to the Imaging module to generate and store the images.

imageExtension

optional, default is png

Extension used to deliver the image.

imagingServletPath

optional, default is /.imaging

Path where the imaging servlet resides.

originalImageNodeName

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

$webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources") DefaultImageProvider
 uses. portrait is displayed at the bottom of the action bar and thumbnail in the thumbnail view.

Node name

Value

 
modules

 
imaging


 
config


 
generators


 
portrait


 
outputFormat


 
operations


 
parameterProviderFactory


 
class

info.magnolia.imaging.operations.ImageOperationChain

 
thumbnail


 
outputFormat


 
operations


 
parameterProviderFactory


 
class

info.magnolia.imaging.operations.ImageOperationChain