Class CmsXmlContainerPageLoader

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addConfigurationParameter​(java.lang.String paramName, java.lang.String paramValue)
      Adds a configuration parameter to this parameter configurable class instance.
      void destroy()
      Destroys this ResourceLoder.
      byte[] dump​(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale selectedLocale, 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.
      java.lang.String dumpAsString​(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale selectedLocale, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
      Dumps the processed content of the the requested file (and it's sub-elements) to a String.
      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()
      Returns null since XML document loaders does usually not need to be configured.
      int getLoaderId()
      Returns the id of the ResourceLoader.
      java.lang.String getResourceLoaderInfo()
      Returns a String describing this resource loader, which is (localized to the system default locale) "The OpenCms default resource loader for container page".
      protected CmsTemplateLoaderFacade getTemplateLoaderFacade​(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req)
      Returns the template loader facade for the given resource.
      protected java.lang.String getTemplatePropertyDefinition()
      Returns the property definition name used to selecte the template for this XML document resource loader.
      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.
      protected void setTemplateRequestAttributes​(CmsTemplateLoaderFacade loaderFacade, javax.servlet.http.HttpServletRequest req)
      Sets request attributes that provide access to the template configuration.
      protected CmsXmlContainerPage unmarshalXmlDocument​(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
      Returns the unmarshalled XML document.
      • Methods inherited from class java.lang.Object

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