org.opencms.loader

类 CmsPointerLoader

java.lang.Object

org.opencms.loader.CmsDumpLoader

org.opencms.loader.CmsPointerLoader

所有已实现的接口:

I_CmsConfigurationParameterHandler, I_CmsResourceLoader

public class CmsPointerLoader
extends CmsDumpLoader

Loader for "pointers" to resources in the VFS or to external resources.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CONFIGURATION_REQUEST_PARAM_SUPPORT_ENABLED The configuration parameter for the OpenCms XML configuration to enable that the parameters in requests to pointer resources are appended to the pointer target link.
protected static boolean	m_requestParamSupportEnabled Flag that controls if parameters in requests to pointer resources are appended to the target link when redirecting.
static int	RESOURCE_POINTER_LOADER_ID The id of this loader.

从类继承的字段 org.opencms.loader.CmsDumpLoader

RESOURCE_LOADER_ID

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

PARAMETER_ELEMENT

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

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
CmsPointerLoader() The constructor of the class is empty and does nothing.

方法概要

方法

限定符和类型	方法和说明
void	addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue) Adds a configuration parameter to this parameter configurable class instance.
void	destroy() Destroy this ResourceLoder, this is a NOOP so far.
byte[]	dump(CmsObject cms, CmsResource resource, java.lang.String element, java.util.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 cnofigured.
int	getLoaderId() Returns the id of the ResourceLoader.
java.lang.String	getResourceLoaderInfo() Return a String describing the ResourceLoader, which is (localized to the system default locale) "The OpenCms default resource loader for pointers".
void	initConfiguration() Initializes a configuration after all parameters have been added.
static boolean	isRequestParamSupportEnabled() Returns true if parameters in requests to pointer resources are appended to the target link when redirecting.
boolean	isStaticExportEnabled() Returns true if request parameter support is disabled.
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 file, 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.

从类继承的方法 org.opencms.loader.CmsDumpLoader

canSendLastModifiedHeader

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

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

字段详细资料

CONFIGURATION_REQUEST_PARAM_SUPPORT_ENABLED

public static final java.lang.String CONFIGURATION_REQUEST_PARAM_SUPPORT_ENABLED

The configuration parameter for the OpenCms XML configuration to enable that the parameters in requests to pointer resources are appended to the pointer target link.

另请参阅:

常量字段值

RESOURCE_POINTER_LOADER_ID

public static final int RESOURCE_POINTER_LOADER_ID

The id of this loader.

另请参阅:

常量字段值

m_requestParamSupportEnabled

protected static boolean m_requestParamSupportEnabled

Flag that controls if parameters in requests to pointer resources are appended to the target link when redirecting.

构造器详细资料

CmsPointerLoader

public CmsPointerLoader()

The constructor of the class is empty and does nothing.

方法详细资料

isRequestParamSupportEnabled

public static boolean isRequestParamSupportEnabled()

Returns true if parameters in requests to pointer resources are appended to the target link when redirecting.

This is controlled by the configuration of this loader in opencms-system.xml.

返回:

true if parameters in requests to pointer resources are appended to the target link when redirecting.

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

覆盖:

addConfigurationParameter 在类中 CmsDumpLoader

参数:

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()

Destroy this ResourceLoder, this is a NOOP so far.

指定者:

destroy 在接口中 I_CmsResourceLoader

覆盖:

destroy 在类中 CmsDumpLoader

dump

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

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

覆盖:

dump 在类中 CmsDumpLoader

参数:

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

返回:

the content of the processed file

抛出:

CmsException - in case of errors accessing OpenCms functions

另请参阅:

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)

export

public byte[] export(CmsObject cms,
            CmsResource resource,
            javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse res)
              throws 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

覆盖:

export 在类中 CmsDumpLoader

参数:

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

抛出:

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()

Will always return null since this loader does not need to be cnofigured.

指定者:

getConfiguration 在接口中 I_CmsConfigurationParameterHandler

覆盖:

getConfiguration 在类中 CmsDumpLoader

返回:

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

另请参阅:

I_CmsConfigurationParameterHandler.getConfiguration()

getLoaderId

public int getLoaderId()

从接口复制的说明: I_CmsResourceLoader

Returns the id of the ResourceLoader.

指定者:

getLoaderId 在接口中 I_CmsResourceLoader

覆盖:

getLoaderId 在类中 CmsDumpLoader

返回:

the id of the ResourceLoader

另请参阅:

I_CmsResourceLoader.getLoaderId()

getResourceLoaderInfo

public java.lang.String getResourceLoaderInfo()

Return a String describing the ResourceLoader, which is (localized to the system default locale) "The OpenCms default resource loader for pointers".

指定者:

getResourceLoaderInfo 在接口中 I_CmsResourceLoader

覆盖:

getResourceLoaderInfo 在类中 CmsDumpLoader

返回:

a describing String for the ResourceLoader

initConfiguration

public void initConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

指定者:

initConfiguration 在接口中 I_CmsConfigurationParameterHandler

覆盖:

initConfiguration 在类中 CmsDumpLoader

另请参阅:

I_CmsConfigurationParameterHandler.initConfiguration()

isStaticExportEnabled

public boolean isStaticExportEnabled()

Returns true if request parameter support is disabled.

指定者:

isStaticExportEnabled 在接口中 I_CmsResourceLoader

覆盖:

isStaticExportEnabled 在类中 CmsDumpLoader

返回:

true if request parameter support is disabled

另请参阅:

I_CmsResourceLoader.isStaticExportEnabled()

isStaticExportProcessable

public boolean isStaticExportProcessable()

从接口复制的说明: I_CmsResourceLoader

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

指定者:

isStaticExportProcessable 在接口中 I_CmsResourceLoader

覆盖:

isStaticExportProcessable 在类中 CmsDumpLoader

返回:

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

覆盖:

isUsableForTemplates 在类中 CmsDumpLoader

返回:

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

覆盖:

isUsingUriWhenLoadingTemplate 在类中 CmsDumpLoader

返回:

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 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

覆盖:

load 在类中 CmsDumpLoader

参数:

cms - the initialized CmsObject which provides user permissions

resource - the requested OpenCms VFS resource

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.load(org.opencms.file.CmsObject, org.opencms.file.CmsResource, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

service

public void service(CmsObject cms,
           CmsResource file,
           javax.servlet.ServletRequest req,
           javax.servlet.ServletResponse res)

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

覆盖:

service 在类中 CmsDumpLoader

参数:

cms - used to access the OpenCms VFS

file - the requested resource in the VFS

req - the servlet request

res - the servlet response

另请参阅:

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