Package org.opencms.loader

Class CmsDumpLoader

java.lang.Object
org.opencms.loader.CmsDumpLoader
All Implemented Interfaces:
I_CmsConfigurationParameterHandler, I_CmsResourceLoader
Direct Known Subclasses:
CmsImageLoader, CmsPointerLoader
public class CmsDumpLoader extends Object implements I_CmsResourceLoader
Dump loader for binary or other unprocessed resource types.

This loader is also used to deliver static sub-elements of pages processed by other loaders.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    RESOURCE_LOADER_ID
    The id of this loader.

    Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

    ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

    Fields inherited from interface org.opencms.loader.I_CmsResourceLoader

    PARAMETER_ELEMENT

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsDumpLoader()
    The constructor of the class is empty and does nothing.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addConfigurationParameter(String paramName, String paramValue)
    Adds a configuration parameter to this parameter configurable class instance.
    protected boolean
    canSendLastModifiedHeader(CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Checks if the requested resource must be send to the client by checking the "If-Modified-Since" http header.
    void
    destroy()
    Destroy this ResourceLoder, this is a NOOP so far.
    byte[]
    dump(CmsObject cms, CmsResource resource, String element, Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Dumps the processed content of the the requested file (and it's sub-elements) to a byte array.
    byte[]
    export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Static exports the contents of the requested file and it's sub-elements.
    CmsParameterConfiguration
    getConfiguration()
    Will always return null since this loader does not need to be configured.
    int
    getLoaderId()
    Returns the id of the ResourceLoader.
    String
    getResourceLoaderInfo()
    Return a String describing the ResourceLoader, which is (localized to the system default locale) "The OpenCms default resource loader for unprocessed files".
    void
    initConfiguration()
    Initializes a configuration after all parameters have been added.
    boolean
    isStaticExportEnabled()
    Signals if the loader implementation supports static export of resources.
    boolean
    isStaticExportProcessable()
    Signals if the loader implementation requires processing during static export of resources.
    boolean
    isUsableForTemplates()
    Signals if the loader implementation is usable for creating templates.
    boolean
    isUsingUriWhenLoadingTemplate()
    Signals if a loader that supports templates must be invoked on the template URI or the resource URI.
    void
    load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.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
    service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
    Does the job of including the requested resource, this method is called directly if the element is called as a sub-element from another I_CmsResourceLoader.

    Methods inherited from class java.lang.Object

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