org.opencms.loader
Interface I_CmsResourceStringDumpLoader

All Known Implementing Classes:

CmsXmlContainerPageLoader, CmsXmlContentLoader, CmsXmlPageLoader

public interface I_CmsResourceStringDumpLoader

Resource loaders that implement this method can easily provide the contents of a selected targe element as a String.

Since:

6.2.0

Method Summary

String

dumpAsString(CmsObject cms, CmsResource resource, String element, Locale locale, 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.

Method Detail

dumpAsString

String dumpAsString(CmsObject cms,
                    CmsResource resource,
                    String element,
                    Locale locale,
                    javax.servlet.ServletRequest req,
                    javax.servlet.ServletResponse res)
                    throws javax.servlet.ServletException,
                           IOException,
                           CmsException

Dumps the processed content of the the requested file (and it's sub-elements) to a String.

This is a special form of I_CmsResourceLoader.dump(CmsObject, CmsResource, String, Locale, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) where the result is required in a String, for example for printing it to a writer.

Parameters:

cms - used to access the OpenCms VFS

resource - the requested resource in the VFS

element - the element in the file to display

locale - the locale to display

req - the servlet request

res - the servlet response

Returns:

the content of the processed file as a String

Throws:

javax.servlet.ServletException - might be thrown by the servlet environment

IOException - might be thrown by the servlet environment

CmsException - in case of errors acessing OpenCms functions

See Also:

I_CmsResourceLoader.dump(CmsObject, CmsResource, String, Locale, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)