org.opencms.file.wrapper

类 CmsResourceWrapperSystemFolder

java.lang.Object

org.opencms.file.wrapper.A_CmsResourceWrapper

org.opencms.file.wrapper.CmsResourceWrapperSystemFolder

所有已实现的接口:

I_CmsResourceWrapper

public class CmsResourceWrapperSystemFolder
extends A_CmsResourceWrapper

Adds the system folder to every root folder of target sites.

从以下版本开始:

6.5.6

字段概要

从类继承的字段 org.opencms.file.wrapper.A_CmsResourceWrapper

m_isWrappedResource

构造器概要

构造器

构造器和说明
CmsResourceWrapperSystemFolder()

方法概要

方法

限定符和类型	方法和说明
java.util.List<CmsResource>	addResourcesToFolder(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter) Here it is possible to add additional (virtual) child resources to those already existing in the VFS.
boolean	isWrappedResource(CmsObject cms, CmsResource res) Is called to check if the given resource is handled by this wrapper.
CmsResource	readResource(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter.

从类继承的方法 org.opencms.file.wrapper.A_CmsResourceWrapper

configure, copyResource, createResource, deleteResource, getLock, lockResource, moveResource, readFile, restoreLink, rewriteLink, unlockResource, wrapResource, writeFile

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

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

构造器详细资料

CmsResourceWrapperSystemFolder

public CmsResourceWrapperSystemFolder()

方法详细资料

addResourcesToFolder

public java.util.List<CmsResource> addResourcesToFolder(CmsObject cms,
                                               java.lang.String resourcename,
                                               CmsResourceFilter filter)
                                                 throws CmsException

从接口复制的说明: I_CmsResourceWrapper

Here it is possible to add additional (virtual) child resources to those already existing in the VFS.

指定者:

addResourcesToFolder 在接口中 I_CmsResourceWrapper

覆盖:

addResourcesToFolder 在类中 A_CmsResourceWrapper

参数:

cms - the current users OpenCms context

resourcename - the full path of the resource where to add the child resources for

filter - the resource filter to use

返回:

a list of all additionaly child CmsResources

抛出:

CmsException - if something goes wrong

另请参阅:

A_CmsResourceWrapper.addResourcesToFolder(CmsObject, String, CmsResourceFilter)

isWrappedResource

public boolean isWrappedResource(CmsObject cms,
                        CmsResource res)

从接口复制的说明: I_CmsResourceWrapper

Is called to check if the given resource is handled by this wrapper.

参数:

cms - the initialized CmsObject

res - the resource to check

返回:

true if the resource will be handled by the wrapper otherwise false

另请参阅:

I_CmsResourceWrapper.isWrappedResource(CmsObject, CmsResource)

readResource

public CmsResource readResource(CmsObject cms,
                       java.lang.String resourcename,
                       CmsResourceFilter filter)
                         throws CmsException

从接口复制的说明: I_CmsResourceWrapper

Reads a resource from the VFS, using the specified resource filter.

First should be a check if the resourcename is handled by this resource wrapper.

It is possible that the path in the resourcename is a virtual path and so has to be translated into a valid path existing in the VFS to read the resource.

指定者:

readResource 在接口中 I_CmsResourceWrapper

覆盖:

readResource 在类中 A_CmsResourceWrapper

参数:

cms - the current users OpenCms context

resourcename - The name of the resource to read (full path)

filter - the resource filter to use while reading

返回:

the resource that was read or null if it could not be handled by this resource wrapper

抛出:

CmsException - if the resource could not be read for any reason

另请参阅:

A_CmsResourceWrapper.readResource(org.opencms.file.CmsObject, java.lang.String, org.opencms.file.CmsResourceFilter)