org.opencms.loader

类 CmsXmlContentLoader

java.lang.Object

org.opencms.loader.CmsXmlContentLoader

所有已实现的接口:

I_CmsConfigurationParameterHandler, I_CmsResourceLoader, I_CmsResourceStringDumpLoader

直接已知子类:

CmsXmlContainerPageLoader

public class CmsXmlContentLoader
extends java.lang.Object

OpenCms loader for resources of type CmsResourceTypeXmlContent.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static int	RESOURCE_LOADER_ID The id of this loader.

从接口继承的字段 org.opencms.loader.I_CmsResourceLoader

PARAMETER_ELEMENT

从接口继承的字段 org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
CmsXmlContentLoader()

方法概要

方法

限定符和类型	方法和说明
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 xml content".
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 I_CmsXmlDocument	unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req) Returns the unmarshalled XML document.

从类继承的方法 java.lang.Object

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

字段详细资料

RESOURCE_LOADER_ID

public static final int RESOURCE_LOADER_ID

The id of this loader.

另请参阅:

常量字段值

构造器详细资料

CmsXmlContentLoader

public CmsXmlContentLoader()

方法详细资料

getLoaderId

public int getLoaderId()

从接口复制的说明: I_CmsResourceLoader

Returns the id of the ResourceLoader.

返回:

the id of the ResourceLoader

另请参阅:

I_CmsResourceLoader.getLoaderId()

getResourceLoaderInfo

public 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 xml content".

返回:

a describing String for the ResourceLoader

unmarshalXmlDocument

protected I_CmsXmlDocument unmarshalXmlDocument(CmsObject cms,
                                    CmsResource resource,
                                    javax.servlet.ServletRequest req)
                                         throws CmsException

Returns the unmarshalled XML document.

参数:

cms - the current users OpenCms context

resource - the requested resource

req - the current Servlet request

返回:

the unmarshalled XML document

抛出:

CmsException - in case the unmarshalling fails

另请参阅:

A_CmsXmlDocumentLoader.unmarshalXmlDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.ServletRequest)

getTemplatePropertyDefinition

protected java.lang.String getTemplatePropertyDefinition()

Returns the property definition name used to selecte the template for this XML document resource loader.

返回:

the property definition name used to selecte the template for this XML document resource loader

另请参阅:

A_CmsXmlDocumentLoader.getTemplatePropertyDefinition()

addConfigurationParameter

public void addConfigurationParameter(java.lang.String paramName,
                             java.lang.String paramValue)

从接口复制的说明: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

指定者:

addConfigurationParameter 在接口中 I_CmsConfigurationParameterHandler

参数:

paramName - the name of the parameter

paramValue - the value for the parameter

另请参阅:

I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

destroy

public void destroy()

从接口复制的说明: I_CmsResourceLoader

Destroys this ResourceLoder.

指定者:

destroy 在接口中 I_CmsResourceLoader

另请参阅:

I_CmsResourceLoader.destroy()

dump

public byte[] dump(CmsObject cms,
          CmsResource resource,
          java.lang.String element,
          java.util.Locale selectedLocale,
          javax.servlet.http.HttpServletRequest req,
          javax.servlet.http.HttpServletResponse res)
            throws CmsException,
                   java.io.IOException

从接口复制的说明: I_CmsResourceLoader

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

Dumping the content is like calling "load" where the result is not written to the response stream, but to the returned byte array. Dumping is different from an export because the export might actually require that the content is handled or modified in a special way, or set special http headers.

Moreover, if the page type is template based, calling "dump" will not trigger the template but directly deliver the contents from the selected element.

指定者:

dump 在接口中 I_CmsResourceLoader

参数:

cms - used to access the OpenCms VFS

resource - the requested resource in the VFS

element - the element in the file to display

selectedLocale - the locale to display

req - the servlet request

res - the servlet response

返回:

the content of the processed file

抛出:

CmsException - in case of errors accessing OpenCms functions

java.io.IOException - might be thrown by the servlet environment

另请参阅:

I_CmsResourceLoader.dump(org.opencms.file.CmsObject, org.opencms.file.CmsResource, java.lang.String, java.util.Locale, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

dumpAsString

public java.lang.String dumpAsString(CmsObject cms,
                            CmsResource resource,
                            java.lang.String element,
                            java.util.Locale selectedLocale,
                            javax.servlet.ServletRequest req,
                            javax.servlet.ServletResponse res)
                              throws CmsException

从接口复制的说明: I_CmsResourceStringDumpLoader

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.

指定者:

dumpAsString 在接口中 I_CmsResourceStringDumpLoader

参数:

cms - used to access the OpenCms VFS

resource - the requested resource in the VFS

element - the element in the file to display

selectedLocale - the locale to display

req - the servlet request

res - the servlet response

返回:

the content of the processed file as a String

抛出:

CmsException - in case of errors acessing OpenCms functions

另请参阅:

I_CmsResourceStringDumpLoader.dumpAsString(org.opencms.file.CmsObject, org.opencms.file.CmsResource, java.lang.String, java.util.Locale, javax.servlet.ServletRequest, javax.servlet.ServletResponse)

export

public byte[] export(CmsObject cms,
            CmsResource resource,
            javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse res)
              throws javax.servlet.ServletException,
                     java.io.IOException,
                     CmsException

从接口复制的说明: 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.

指定者:

export 在接口中 I_CmsResourceLoader

参数:

cms - the initialized CmsObject which provides user permissions

resource - the requested OpenCms VFS resource

req - the servlet request

res - the servlet response

返回:

the contents to export, or null if no export is required

抛出:

javax.servlet.ServletException - might be thrown in the process of including the sub element

java.io.IOException - might be thrown in the process of including the sub element

CmsException - in case something goes wrong

另请参阅:

I_CmsResourceLoader.export(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Returns null since XML document loaders does usually not need to be configured.

指定者:

getConfiguration 在接口中 I_CmsConfigurationParameterHandler

返回:

the parameters of this configurable class instance, or null if the class does not need any parameters

另请参阅:

I_CmsConfigurationParameterHandler.getConfiguration()

initConfiguration

public void initConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

指定者:

initConfiguration 在接口中 I_CmsConfigurationParameterHandler

另请参阅:

I_CmsConfigurationParameterHandler.initConfiguration()

isStaticExportEnabled

public boolean isStaticExportEnabled()

从接口复制的说明: I_CmsResourceLoader

Signals if the loader implementation supports static export of resources.

指定者:

isStaticExportEnabled 在接口中 I_CmsResourceLoader

返回:

true if static export is supported, false otherwise

另请参阅:

I_CmsResourceLoader.isStaticExportEnabled()

isStaticExportProcessable

public boolean isStaticExportProcessable()

从接口复制的说明: I_CmsResourceLoader

Signals if the loader implementation requires processing during static export of resources.

指定者:

isStaticExportProcessable 在接口中 I_CmsResourceLoader

返回:

true if static export processing is required, false otherwise

另请参阅:

I_CmsResourceLoader.isStaticExportProcessable()

isUsableForTemplates

public boolean isUsableForTemplates()

从接口复制的说明: I_CmsResourceLoader

Signals if the loader implementation is usable for creating templates.

指定者:

isUsableForTemplates 在接口中 I_CmsResourceLoader

返回:

true if the loader implementation is usable for creating templates, false otherwise

另请参阅:

I_CmsResourceLoader.isUsableForTemplates()

isUsingUriWhenLoadingTemplate

public boolean isUsingUriWhenLoadingTemplate()

从接口复制的说明: I_CmsResourceLoader

Signals if a loader that supports templates must be invoked on the template URI or the resource URI.

指定者:

isUsingUriWhenLoadingTemplate 在接口中 I_CmsResourceLoader

返回:

true if the resource URI is to be used, false if the template URI is to be used

另请参阅:

I_CmsResourceLoader.isUsingUriWhenLoadingTemplate()

load

public void load(CmsObject cms,
        CmsResource resource,
        javax.servlet.http.HttpServletRequest req,
        javax.servlet.http.HttpServletResponse res)
          throws javax.servlet.ServletException,
                 java.io.IOException,
                 CmsException

从接口复制的说明: 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.

指定者:

load 在接口中 I_CmsResourceLoader

参数:

cms - the initialized CmsObject which provides user permissions

resource - the requested OpenCms VFS resource

req - the servlet request

res - the servlet response

抛出:

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

java.io.IOException - might be thrown by the servlet environment

CmsException - in case of errors accessing OpenCms functions

另请参阅:

I_CmsResourceLoader.load(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

service

public void service(CmsObject cms,
           CmsResource resource,
           javax.servlet.ServletRequest req,
           javax.servlet.ServletResponse res)
             throws java.io.IOException,
                    CmsException

从接口复制的说明: I_CmsResourceLoader

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.

指定者:

service 在接口中 I_CmsResourceLoader

参数:

cms - used to access the OpenCms VFS

resource - the requested resource in the VFS

req - the servlet request

res - the servlet response

抛出:

java.io.IOException - might be thrown by the servlet environment

CmsException - in case of errors accessing OpenCms functions

另请参阅:

I_CmsResourceLoader.service(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.ServletRequest, javax.servlet.ServletResponse)