Package org.opencms.loader
Interface I_CmsResourceStringDumpLoader
-
- All Known Implementing Classes:
CmsSeoFileLoader
,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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
dumpAsString(CmsObject cms, CmsResource resource, java.lang.String element, java.util.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
java.lang.String dumpAsString(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale locale, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) throws javax.servlet.ServletException, java.io.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
where the result is required in a String, for example for printing it to a writer.I_CmsResourceLoader.dump(CmsObject, CmsResource, String, Locale, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
- Parameters:
cms
- used to access the OpenCms VFSresource
- the requested resource in the VFSelement
- the element in the file to displaylocale
- the locale to displayreq
- the servlet requestres
- the servlet response- Returns:
- the content of the processed file as a String
- Throws:
javax.servlet.ServletException
- might be thrown by the servlet environmentjava.io.IOException
- might be thrown by the servlet environmentCmsException
- in case of errors acessing OpenCms functions- See Also:
I_CmsResourceLoader.dump(CmsObject, CmsResource, String, Locale, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
-
-