org.opencms.loader.CmsImageLoader

All Implemented Interfaces:: I_CmsConfigurationParameterHandler, I_CmsResourceLoader, I_CmsStaticExportDirectResponseLoader, I_CmsStaticExportStreamLoader, I_CmsStoredContentDirectDeliveryLoader, I_CmsEventListener

public class CmsImageLoader extends CmsDumpLoader implements I_CmsEventListener, I_CmsStaticExportDirectResponseLoader

Loader for images from the OpenCms VSF with integrated image scaling and processing capabilities.

To scale or process an image, the parameter CmsImageScaler.PARAM_SCALE has to be appended to the image URI. The value for the parameter needs to be composed from the SCALE_PARAM options provided by the constants in the CmsResourceTypeImage class.

For example, to scale an image to exact 800x600 pixel with center fitting and a background color of grey, the following parameter String can be used: w:800,h:600,t:0,c:c0c0c0.

Since:: 6.2.0

Field Summary

Fields

Modifier and Type

Field

Description

static final String

CONFIGURATION_CONCURRENCY

Controls max number of threads that are allowed to scale images concurrently.

static final String

CONFIGURATION_DOWNSCALE

The configuration parameter for the OpenCms XML configuration to set the image down scale operation.

static final String

CONFIGURATION_IMAGE_FOLDER

The configuration parameter for the OpenCms XML configuration to set the image cache repository.

static final String

CONFIGURATION_MAX_BLUR_SIZE

The configuration parameter for the OpenCms XML configuration to set the maximum image blur size.

static final String

CONFIGURATION_MAX_SCALE_SIZE

The configuration parameter for the OpenCms XML configuration to set the maximum image scale size.

static final String

CONFIGURATION_SCALING_ENABLED

The configuration parameter for the OpenCms XML configuration to enable the image scaling.

static final String

IMAGE_REPOSITORY_DEFAULT

Default name for the image cache repository.

protected static final org.apache.commons.logging.Log

LOG

The log object for this class.

protected static String

m_downScaleParams

The (optional) image down scale parameters for image write operations.

protected static boolean

m_enabled

Indicates if image scaling is active.

protected static I_CmsImageCache

m_imageCache

The optional external image cache.

protected static CmsImageCacheAccessRenewal

m_imageCacheAccessRenewal

Asynchronous access-triggered renewal for the configured external image cache.

protected String

m_imageRepositoryFolder

The name of the configured image cache repository.

protected static String

m_imageRepositoryPath

The image cache repository path, or null for image caches without file system access.

protected static int

m_maxBlurSize

The maximum image size (width * height) to apply image blurring when down scaling (setting this to high may cause "out of memory" errors).

protected int

m_maxScaleSize

The maximum image size (width or height) to allow when up scaling an image using request parameters.

protected static CmsVfsNameBasedDiskCache

m_vfsDiskCache

The disk cache to use for saving scaled image versions.

static final String

PARAM_CLEAR_IMAGES_CACHE

Clear event parameter.

static final int

RESOURCE_LOADER_ID_IMAGE_LOADER

The id of this loader.

Fields inherited from class org.opencms.loader.CmsDumpLoader
RESOURCE_LOADER_ID

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Fields inherited from interface org.opencms.main.I_CmsEventListener
EVENT_BEFORE_PUBLISH_PROJECT, EVENT_CLEAR_CACHES, EVENT_CLEAR_OFFLINE_CACHES, EVENT_CLEAR_ONLINE_CACHES, EVENT_CLEAR_PRINCIPAL_CACHES, EVENT_FLEX_CACHE_CLEAR, EVENT_FLEX_PURGE_JSP_REPOSITORY, EVENT_FULLSTATIC_EXPORT, EVENT_GROUP_MODIFIED, EVENT_LOGIN_USER, EVENT_OU_MODIFIED, EVENT_PROJECT_MODIFIED, EVENT_PROPERTY_DEFINITION_CREATED, EVENT_PROPERTY_DEFINITION_MODIFIED, EVENT_PROPERTY_MODIFIED, EVENT_PUBLISH_PROJECT, EVENT_REBUILD_SEARCHINDEXES, EVENT_REINDEX_OFFLINE, EVENT_REINDEX_ONLINE, EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, EVENT_RESOURCE_COPIED, EVENT_RESOURCE_CREATED, EVENT_RESOURCE_DELETED, EVENT_RESOURCE_MODIFIED, EVENT_RESOURCE_MOVED, EVENT_RESOURCES_AND_PROPERTIES_MODIFIED, EVENT_RESOURCES_MODIFIED, EVENT_SITEMAP_CHANGED, EVENT_UPDATE_EXPORTS, EVENT_USER_MODIFIED, KEY_CHANGE, KEY_DBCONTEXT, KEY_GROUP_ID, KEY_GROUP_NAME, KEY_INDEX_NAMES, KEY_INSTANT_PUBLISH, KEY_IS_ONLINE, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REINDEX_RELATED, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_SKIPINDEX, KEY_USER_ACTION, KEY_USER_CHANGES, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_CREATE_SIBLING, VALUE_GROUP_MODIFIED_ACTION_CREATE, VALUE_GROUP_MODIFIED_ACTION_DELETE, VALUE_GROUP_MODIFIED_ACTION_WRITE, VALUE_OU_MODIFIED_ACTION_CREATE, VALUE_OU_MODIFIED_ACTION_DELETE, VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP, VALUE_USER_MODIFIED_ACTION_CREATE_USER, VALUE_USER_MODIFIED_ACTION_DELETE_USER, VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP, VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD, VALUE_USER_MODIFIED_ACTION_SET_OU, VALUE_USER_MODIFIED_ACTION_WRITE_USER

Fields inherited from interface org.opencms.loader.I_CmsResourceLoader
PARAMETER_ELEMENT
Constructor Summary

Constructors

Constructor

Description

CmsImageLoader()

Creates a new image loader.
Method Summary

Modifier and Type

Method

Description

void

addConfigurationParameter(String paramName, String paramValue)

Adds a configuration parameter to this parameter configurable class instance.

void

cmsEvent(CmsEvent event)

Acknowledge the occurrence of the specified event, implement this method to check for CmsEvents in your class.

protected void

createImageCacheEntry(CmsObject cms, CmsResource resource, CmsImageScaler scaler, String key)

Creates an image cache entry without checking whether it already exists.

void

destroy()

Destroy this ResourceLoder, this is a NOOP so far.

protected String

ensureImageCacheEntry(CmsObject cms, CmsResource resource, CmsImageScaler scaler)

Ensures that an image cache entry exists in the configured image cache.

byte[]

export(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)

Static exports the contents of the requested file and it's sub-elements.

void

exportTo(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res, OutputStream exportOut)

Static exports the contents of the requested resource to an output stream, optionally also to the response.

CmsParameterConfiguration

getConfiguration()

Will always return null since this loader does not need to be configured.

static String

getDownScaleParams()

Returns the image down scale parameters, which is set with the CONFIGURATION_DOWNSCALE configuration option.

static I_CmsImageCache

getImageCache()

Returns the configured external image cache.

protected String

getImageCacheKey(CmsResource resource, CmsImageScaler scaler)

Returns the image cache key for an image/scaler pair.

static String

getImageRepositoryPath()

Returns the path of the image cache repository folder in the RFS.

int

getLoaderId()

Returns the id of the ResourceLoader.

static int

getMaxBlurSize()

The maximum blur size for image re-scale operations, which is set with the CONFIGURATION_MAX_BLUR_SIZE configuration option.

protected CmsFile

getScaledImage(CmsObject cms, CmsResource resource, CmsImageScaler scaler)

Returns a scaled version of the given OpenCms VFS image resource.

File

getScaledImageFile(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req)

Returns the RFS cache file for the image scaler parameters from the request.

protected File

getScaledImageFile(CmsObject cms, CmsResource resource, CmsImageScaler scaler)

Returns the RFS cache file for a scaled version of the given OpenCms VFS image resource.

void

initConfiguration()

Initializes a configuration after all parameters have been added.

protected void

initDefaultImageCache()

Initializes the classic RFS image cache used when no external image cache backend is selected.

void

initializeImageCache(CmsParameterConfiguration propertyConfiguration)

Initializes the image cache after the complete OpenCms runtime configuration is available.

protected void

initImageCache(CmsParameterConfiguration propertyConfiguration)

Initializes the optional image cache.

static boolean

isEnabled()

Returns true if the image scaling and processing capabilities for the OpenCms VFS images have been enabled, false if not.

boolean

isStoredContentDirectDeliveryEnabled(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)

Returns if direct delivery of externally stored original content is enabled for the given resource.

void

load(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)

Basic top-page processing method for a I_CmsResourceLoader, this method is called if the page is called as a sub-element on a page not already loaded with a I_CmsResourceLoader.

void

loadCacheFile(CmsResource resource, File file, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)

Loads an image cache file to the response.

protected void

loadImageCacheEntry(CmsResource resource, String key, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)

Loads an image cache entry from the configured storage to the response.

boolean

tryExportDirectResponse(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)

Tries to handle an on-demand static export directly.

Methods inherited from class org.opencms.loader.CmsDumpLoader
canSendLastModifiedHeader, deliverStoredContent, dump, exportStoredContentTo, getClientCacheMaxAge, getResourceLoaderInfo, isStaticExportEnabled, isStaticExportProcessable, isUsableForTemplates, isUsingUriWhenLoadingTemplate, prepareResponse, service

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- CONFIGURATION_CONCURRENCY
  
  public static final String CONFIGURATION_CONCURRENCY
  
  Controls max number of threads that are allowed to scale images concurrently.
  See Also:
  
  Constant Field Values
- CONFIGURATION_DOWNSCALE
  
  public static final String CONFIGURATION_DOWNSCALE
  
  The configuration parameter for the OpenCms XML configuration to set the image down scale operation.
  See Also:
  
  Constant Field Values
- CONFIGURATION_IMAGE_FOLDER
  
  public static final String CONFIGURATION_IMAGE_FOLDER
  
  The configuration parameter for the OpenCms XML configuration to set the image cache repository.
  See Also:
  
  Constant Field Values
- CONFIGURATION_MAX_BLUR_SIZE
  
  public static final String CONFIGURATION_MAX_BLUR_SIZE
  
  The configuration parameter for the OpenCms XML configuration to set the maximum image blur size.
  See Also:
  
  Constant Field Values
- CONFIGURATION_MAX_SCALE_SIZE
  
  public static final String CONFIGURATION_MAX_SCALE_SIZE
  
  The configuration parameter for the OpenCms XML configuration to set the maximum image scale size.
  See Also:
  
  Constant Field Values
- CONFIGURATION_SCALING_ENABLED
  
  public static final String CONFIGURATION_SCALING_ENABLED
  
  The configuration parameter for the OpenCms XML configuration to enable the image scaling.
  See Also:
  
  Constant Field Values
- IMAGE_REPOSITORY_DEFAULT
  
  public static final String IMAGE_REPOSITORY_DEFAULT
  
  Default name for the image cache repository.
  See Also:
  
  Constant Field Values
- PARAM_CLEAR_IMAGES_CACHE
  
  public static final String PARAM_CLEAR_IMAGES_CACHE
  
  Clear event parameter.
  See Also:
  
  Constant Field Values
- RESOURCE_LOADER_ID_IMAGE_LOADER
  
  public static final int RESOURCE_LOADER_ID_IMAGE_LOADER
  
  The id of this loader.
  See Also:
  
  Constant Field Values
- LOG
  
  protected static final org.apache.commons.logging.Log LOG
  
  The log object for this class.
- m_downScaleParams
  
  protected static String m_downScaleParams
  
  The (optional) image down scale parameters for image write operations.
- m_enabled
  
  protected static boolean m_enabled
  
  Indicates if image scaling is active.
- m_maxBlurSize
  
  protected static int m_maxBlurSize
  
  The maximum image size (width * height) to apply image blurring when down scaling (setting this to high may cause "out of memory" errors).
- m_vfsDiskCache
  
  protected static CmsVfsNameBasedDiskCache m_vfsDiskCache
  
  The disk cache to use for saving scaled image versions.
- m_imageRepositoryPath
  
  protected static String m_imageRepositoryPath
  
  The image cache repository path, or null for image caches without file system access.
- m_imageCache
  
  protected static I_CmsImageCache m_imageCache
  
  The optional external image cache.
- m_imageCacheAccessRenewal
  
  protected static CmsImageCacheAccessRenewal m_imageCacheAccessRenewal
  
  Asynchronous access-triggered renewal for the configured external image cache.
- m_imageRepositoryFolder
  
  protected String m_imageRepositoryFolder
  
  The name of the configured image cache repository.
- m_maxScaleSize
  
  protected int m_maxScaleSize
  
  The maximum image size (width or height) to allow when up scaling an image using request parameters.
Constructor Details
- CmsImageLoader
  
  public CmsImageLoader()
  
  Creates a new image loader.
Method Details
- getDownScaleParams
  
  public static String getDownScaleParams()
  
  Returns the image down scale parameters, which is set with the CONFIGURATION_DOWNSCALE configuration option.
  If no down scale parameters have been set in the configuration, this will return null.
  
  Returns:
  
  the image down scale parameters
- getImageCache
  
  public static I_CmsImageCache getImageCache()
  
  Returns the configured external image cache.
  The classic RFS image cache is not represented by an I_CmsImageCache instance, so this method returns null for it.
  
  Returns:
  
  the configured external image cache, or null for the classic RFS image cache
- getImageRepositoryPath
  
  public static String getImageRepositoryPath()
  
  Returns the path of the image cache repository folder in the RFS.
  For image cache backends without file system access, this returns null.
  
  Returns:
  
  the path of the image cache repository folder in the RFS, or null
- getMaxBlurSize
  
  public static int getMaxBlurSize()
  
  The maximum blur size for image re-scale operations, which is set with the CONFIGURATION_MAX_BLUR_SIZE configuration option.
  The default is 2500 * 2500 pixel.
  
  Returns:
  
  the maximum blur size for image re-scale operations
- isEnabled
  
  public static boolean isEnabled()
  
  Returns true if the image scaling and processing capabilities for the OpenCms VFS images have been enabled, false if not.
  Image scaling is enabled by setting the loader parameter image.scaling.enabled to the value true in the configuration file opencms-vfs.xml.
  Enabling image processing in OpenCms may require several additional configuration steps on the server running OpenCms, especially in UNIX systems. Here it is often required to have an X window server configured and accessible so that the required Java ImageIO operations work. Therefore the image scaling capabilities in OpenCms are disabled by default.
  
  Returns:
  
  true if the image scaling and processing capabilities for the OpenCms VFS images have been enabled
- addConfigurationParameter
  
  public void addConfigurationParameter(String paramName, String paramValue)
  
  Description copied from interface: I_CmsConfigurationParameterHandler
  
  Adds a configuration parameter to this parameter configurable class instance.
  Specified by:
  
  addConfigurationParameter in interface I_CmsConfigurationParameterHandler
  
  Overrides:
  
  addConfigurationParameter in class CmsDumpLoader
  
  Parameters:
  
  paramName - the name of the parameter
  
  paramValue - the value for the parameter
  
  See Also:
  
  I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)
- cmsEvent
  
  public void cmsEvent(CmsEvent event)
  
  Description copied from interface: I_CmsEventListener
  
  Acknowledge the occurrence of the specified event, implement this method to check for CmsEvents in your class.
  Specified by:
  
  cmsEvent in interface I_CmsEventListener
  
  Parameters:
  
  event - CmsEvent that has occurred
  
  See Also:
  
  I_CmsEventListener.cmsEvent(org.opencms.main.CmsEvent)
- destroy
  
  public void destroy()
  
  Description copied from class: CmsDumpLoader
  
  Destroy this ResourceLoder, this is a NOOP so far.
  Specified by:
  
  destroy in interface I_CmsResourceLoader
  
  Overrides:
  
  destroy in class CmsDumpLoader
  
  See Also:
  
  I_CmsResourceLoader.destroy()
- export
  
  public byte[] export(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, CmsException
  
  Description copied from interface: I_CmsResourceLoader
  
  Static exports the contents of the requested file and it's sub-elements.
  During static export, the resource content may be written to 2 streams: The export stream, and the http response output stream. Which stream is actually used depends whether the export is in "on demand" or "after publish" mode. In "on demand" mode, the resource needs to be written both to the response stream and to the file stream. In "after publish" mode, it's usually only written to the file stream, but sometimes it's required to write to the response stream as well.
  Specified by:
  
  export in interface I_CmsResourceLoader
  
  Overrides:
  
  export in class CmsDumpLoader
  
  Parameters:
  
  cms - the initialized CmsObject which provides user permissions
  
  resource - the requested OpenCms VFS resource
  
  req - the servlet request
  
  res - the servlet response
  
  Returns:
  
  the contents to export, or null if no export is required
  
  Throws:
  
  IOException - might be thrown in the process of including the sub element
  
  CmsException - in case something goes wrong
  
  See Also:
  
  I_CmsResourceLoader.export(org.opencms.file.CmsObject, org.opencms.file.CmsResource, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
- exportTo
  
  public void exportTo(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res, OutputStream exportOut) throws IOException, CmsException
  
  Description copied from interface: I_CmsStaticExportStreamLoader
  
  Static exports the contents of the requested resource to an output stream, optionally also to the response.
  Specified by:
  
  exportTo in interface I_CmsStaticExportStreamLoader
  
  Overrides:
  
  exportTo in class CmsDumpLoader
  
  Parameters:
  
  cms - the initialized CmsObject which provides user permissions
  
  resource - the requested OpenCms VFS resource
  
  req - the servlet request
  
  res - the servlet response
  
  exportOut - the export output stream
  
  Throws:
  
  IOException - might be thrown in the process of writing the streams
  
  CmsException - in case something goes wrong
  
  See Also:
  
  I_CmsStaticExportStreamLoader.exportTo(org.opencms.file.CmsObject, org.opencms.file.CmsResource, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, java.io.OutputStream)
- getConfiguration
  
  public CmsParameterConfiguration getConfiguration()
  
  Description copied from class: CmsDumpLoader
  
  Will always return null since this loader does not need to be configured.
  Specified by:
  
  getConfiguration in interface I_CmsConfigurationParameterHandler
  
  Overrides:
  
  getConfiguration in class CmsDumpLoader
  
  Returns:
  
  the parameters of this configurable class instance, or null if the class does not need any parameters
  
  See Also:
  
  I_CmsConfigurationParameterHandler.getConfiguration()
- getLoaderId
  
  public int getLoaderId()
  
  Description copied from interface: I_CmsResourceLoader
  
  Returns the id of the ResourceLoader.
  Specified by:
  
  getLoaderId in interface I_CmsResourceLoader
  
  Overrides:
  
  getLoaderId in class CmsDumpLoader
  
  Returns:
  
  the id of the ResourceLoader
  
  See Also:
  
  I_CmsResourceLoader.getLoaderId()
- getScaledImageFile
  
  public File getScaledImageFile(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req) throws IOException, CmsException
  
  Returns the RFS cache file for the image scaler parameters from the request.
  
  Parameters:
  
  cms - the current users OpenCms context
  
  resource - the base VFS resource for the image
  
  req - the current request
  
  Returns:
  
  the scaled image cache file, or null if the request contains no valid scaling parameters
  
  Throws:
  
  IOException - in case of errors accessing the disk based cache
  
  CmsException - in case of errors accessing the OpenCms VFS
- initConfiguration
  
  public void initConfiguration() throws CmsConfigurationException
  
  Description copied from interface: I_CmsConfigurationParameterHandler
  
  Initializes a configuration after all parameters have been added.
  Specified by:
  
  initConfiguration in interface I_CmsConfigurationParameterHandler
  
  Overrides:
  
  initConfiguration in class CmsDumpLoader
  
  Throws:
  
  CmsConfigurationException - if something goes wrong
  
  See Also:
  
  I_CmsConfigurationParameterHandler.initConfiguration()
- initializeImageCache
  
  public void initializeImageCache(CmsParameterConfiguration propertyConfiguration) throws CmsConfigurationException
  
  Initializes the image cache after the complete OpenCms runtime configuration is available.
  
  Parameters:
  
  propertyConfiguration - the OpenCms properties
  
  Throws:
  
  CmsConfigurationException - if the image cache can not be initialized
- isStoredContentDirectDeliveryEnabled
  
  public boolean isStoredContentDirectDeliveryEnabled(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws CmsException
  
  Description copied from interface: I_CmsStoredContentDirectDeliveryLoader
  
  Returns if direct delivery of externally stored original content is enabled for the given resource.
  Specified by:
  
  isStoredContentDirectDeliveryEnabled in interface I_CmsStoredContentDirectDeliveryLoader
  
  Overrides:
  
  isStoredContentDirectDeliveryEnabled in class CmsDumpLoader
  
  Parameters:
  
  cms - the CMS context
  
  resource - the resource
  
  req - the request
  
  res - the response
  
  Returns:
  
  true if direct stored content delivery may be used
  
  Throws:
  
  CmsException - in case the decision can not be made
  
  See Also:
  
  I_CmsStoredContentDirectDeliveryLoader.isStoredContentDirectDeliveryEnabled(org.opencms.file.CmsObject, org.opencms.file.CmsResource, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
- load
  
  public void load(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, CmsException
  
  Description copied from interface: I_CmsResourceLoader
  
  Basic top-page processing method for a I_CmsResourceLoader, this method is called if the page is called as a sub-element on a page not already loaded with a I_CmsResourceLoader.
  Specified by:
  
  load in interface I_CmsResourceLoader
  
  Overrides:
  
  load in class CmsDumpLoader
  
  Parameters:
  
  cms - the initialized CmsObject which provides user permissions
  
  resource - the requested OpenCms VFS resource
  
  req - the servlet request
  
  res - the servlet response
  
  Throws:
  
  IOException - might be thrown by the servlet environment
  
  CmsException - in case of errors accessing OpenCms functions
  
  See Also:
  
  I_CmsResourceLoader.load(org.opencms.file.CmsObject, org.opencms.file.CmsResource, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
- loadCacheFile
  
  public void loadCacheFile(CmsResource resource, File file, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException
  
  Loads an image cache file to the response.
  
  Parameters:
  
  resource - the original resource
  
  file - the image cache file
  
  req - the current request
  
  res - the current response
  
  Throws:
  
  IOException - in case writing fails
- tryExportDirectResponse
  
  public boolean tryExportDirectResponse(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, CmsException
  
  Description copied from interface: I_CmsStaticExportDirectResponseLoader
  
  Tries to handle an on-demand static export directly.
  Specified by:
  
  tryExportDirectResponse in interface I_CmsStaticExportDirectResponseLoader
  
  Parameters:
  
  cms - the CMS context
  
  resource - the resource to export
  
  req - the current request
  
  res - the current response
  
  Returns:
  
  true if the export response has been handled
  
  Throws:
  
  IOException - in case writing fails
  
  CmsException - in case export fails
  
  See Also:
  
  I_CmsStaticExportDirectResponseLoader.tryExportDirectResponse(org.opencms.file.CmsObject, org.opencms.file.CmsResource, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
- createImageCacheEntry
  
  protected void createImageCacheEntry(CmsObject cms, CmsResource resource, CmsImageScaler scaler, String key) throws IOException, CmsException
  
  Creates an image cache entry without checking whether it already exists.
  
  Parameters:
  
  cms - the CMS context
  
  resource - the image resource
  
  scaler - the image scaler
  
  key - the image cache key
  
  Throws:
  
  IOException - in case scaling fails
  
  CmsException - in case VFS or cache access fails
- ensureImageCacheEntry
  
  protected String ensureImageCacheEntry(CmsObject cms, CmsResource resource, CmsImageScaler scaler) throws IOException, CmsException
  
  Ensures that an image cache entry exists in the configured image cache.
  
  Parameters:
  
  cms - the CMS context
  
  resource - the image resource
  
  scaler - the image scaler
  
  Returns:
  
  the image cache key
  
  Throws:
  
  IOException - in case scaling fails
  
  CmsException - in case VFS access fails
- getImageCacheKey
  
  protected String getImageCacheKey(CmsResource resource, CmsImageScaler scaler)
  
  Returns the image cache key for an image/scaler pair.
  
  Parameters:
  
  resource - the image resource
  
  scaler - the image scaler
  
  Returns:
  
  the image cache key
- getScaledImage
  
  protected CmsFile getScaledImage(CmsObject cms, CmsResource resource, CmsImageScaler scaler) throws IOException, CmsException
  
  Returns a scaled version of the given OpenCms VFS image resource.
  All results are cached in disk. If the scaled version does not exist in the cache, it is created. Unscaled versions of the images are also stored in the cache.
  
  Parameters:
  
  cms - the current users OpenCms context
  
  resource - the base VFS resource for the image
  
  scaler - the configured image scaler
  
  Returns:
  
  a scaled version of the given OpenCms VFS image resource
  
  Throws:
  
  IOException - in case of errors accessing the disk based cache
  
  CmsException - in case of errors accessing the OpenCms VFS
- getScaledImageFile
  
  protected File getScaledImageFile(CmsObject cms, CmsResource resource, CmsImageScaler scaler) throws IOException, CmsException
  
  Returns the RFS cache file for a scaled version of the given OpenCms VFS image resource.
  
  Parameters:
  
  cms - the current users OpenCms context
  
  resource - the base VFS resource for the image
  
  scaler - the configured image scaler
  
  Returns:
  
  the scaled image cache file
  
  Throws:
  
  IOException - in case of errors accessing the disk based cache
  
  CmsException - in case of errors accessing the OpenCms VFS
- initDefaultImageCache
  
  protected void initDefaultImageCache()
  
  Initializes the classic RFS image cache used when no external image cache backend is selected.
- initImageCache
  
  protected void initImageCache(CmsParameterConfiguration propertyConfiguration) throws CmsConfigurationException
  
  Initializes the optional image cache.
  
  Throws:
  
  CmsConfigurationException
- loadImageCacheEntry
  
  protected void loadImageCacheEntry(CmsResource resource, String key, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, CmsException
  
  Loads an image cache entry from the configured storage to the response.
  
  Parameters:
  
  resource - the original resource
  
  key - the image cache key
  
  req - the request
  
  res - the response
  
  Throws:
  
  IOException - in case writing fails
  
  CmsException - in case store access fails

Class CmsImageLoader

Field Summary

Fields inherited from class org.opencms.loader.CmsDumpLoader

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

Fields inherited from interface org.opencms.main.I_CmsEventListener

Fields inherited from interface org.opencms.loader.I_CmsResourceLoader

Constructor Summary

Method Summary

Methods inherited from class org.opencms.loader.CmsDumpLoader

Methods inherited from class java.lang.Object

Field Details

CONFIGURATION_CONCURRENCY

CONFIGURATION_DOWNSCALE

CONFIGURATION_IMAGE_FOLDER

CONFIGURATION_MAX_BLUR_SIZE

CONFIGURATION_MAX_SCALE_SIZE

CONFIGURATION_SCALING_ENABLED

IMAGE_REPOSITORY_DEFAULT

PARAM_CLEAR_IMAGES_CACHE

RESOURCE_LOADER_ID_IMAGE_LOADER

LOG

m_downScaleParams

m_enabled

m_maxBlurSize

m_vfsDiskCache

m_imageRepositoryPath

m_imageCache

m_imageCacheAccessRenewal

m_imageRepositoryFolder

m_maxScaleSize

Constructor Details

CmsImageLoader

Method Details

getDownScaleParams

getImageCache

getImageRepositoryPath

getMaxBlurSize

isEnabled

addConfigurationParameter

cmsEvent

destroy

export

exportTo

getConfiguration

getLoaderId

getScaledImageFile

initConfiguration

initializeImageCache

isStoredContentDirectDeliveryEnabled

load

loadCacheFile

tryExportDirectResponse

createImageCacheEntry

ensureImageCacheEntry

getImageCacheKey

getScaledImage

getScaledImageFile

initDefaultImageCache

initImageCache

loadImageCacheEntry